Sharing
Manage how your users and groups can access your Talend Cloud entities.
- Contact
- Talend
Endpoints
-
https://api.eu.cloud.talend.com
URL for the AWS Europe region
-
https://api.ap.cloud.talend.com
URL for the AWS Asia Pacific region
-
https://api.us.cloud.talend.com
URL for the AWS United States East region
-
https://api.au.cloud.talend.com
URL for the AWS Australia region
-
https://api.us-west.cloud.talend.com
URL for the Azure United States West region
Security scheme
This scheme can be referenced across the API
Public
This Bearer authentication can be set in the Authorization header of your requests.
Authentication tokens and Personal Access Tokens are supported.
Personal Access Tokens can be generated in the Profile Preferences page of the Talend Cloud Portal.
| Name | Description |
|---|---|
| Format | Bearer <token> |
Get a sharingset for an entity
GET /sharing/sharingset/{entityType}/{entityId}Use this method to retrieve a sharingset.
A sharingset represents the full list of users and groups who have access to the specified entity.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| entityType | string Required |
preparation |
|
| entityId | UUID | string Required |
15de7eb2-6447-49a8-a404-a53ecd1f3473 |
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| foreignEntityType | string Optional |
api_test |
|
| limit | Limits the number of elements displayed in the sharingset. | integer Optional |
INT32 100 |
| offset | integer Optional |
INT32 1000 |
|
| includeDeletedSharings | True or false | boolean Optional | |
| foreignEntityId | string Optional |
15de7eb2-6447-49a8-a404-a53ecd1f3473 |
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| X-CLIENT-VERSION | string Optional |
Response
Patch a sharingset for an entity
PATCH /sharing/sharingset/{entityType}/{entityId}A sharingset represents the full list of users and groups who have access to the specified entity. Use this method to patch the sharingset and define who can access a given entity, and with which access level (viewer, editor, owner).
Unlike the PUT operation that replaces the whole sharingset, the PATCH operation allows you to apply specific changes to the sharingset. A missing level stands for a removal command of a user or group sharing.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| entityType | string Required |
preparation |
|
| entityId | UUID | string Required |
15de7eb2-6447-49a8-a404-a53ecd1f3473 |
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| X-CLIENT-VERSION | string Optional |
Body
application/json
Response
Update a sharingset for an entity
PUT /sharing/sharingset/{entityType}/{entityId}A sharingset represents the full list of users and groups who have access to the specified entity.
Use this method to update the sharingset by defining who can access a given entity, and with which access level (viewer, editor, owner). This PUT operation allows you to replace the whole sharingset with the new information.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| entityType | string Required |
preparation |
|
| entityId | UUID | string Required |
15de7eb2-6447-49a8-a404-a53ecd1f3473 |
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| X-CLIENT-VERSION | string Optional |
Body
application/json
Response
Get the access levels of an entity
GET /sharing/sharings/levels/{entityType}An access level defines to what extent the user or the group will be able to interact with the entity. In Talend Cloud, the available levels are Viewer, Editor, and Owner. Depending on the level, a user will have read-only or write permissions for example.
Use this method to retrieve the available access levels of the specified entity type.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| entityType | string Required |
preparation |
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| X-CLIENT-VERSION | string Optional |
Response
200Status 200
Status 200
Body
application/json
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of LevelResponse |
|
|||||||||||
Get eligible users/groups for sharing
GET /sharing/sharings/eligibles/{entityType}Use this method to retrieve the list of users and groups with whom a specific entity type can be shared.
The list of available users and groups changes depending on which permissions they are assigned in Talend Management Console.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| entityType | string Required |
preparation |
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| X-CLIENT-VERSION | string Optional |
Response
Get the entities that the current user has access to
GET /sharing/sharings/{entityType}Use this method to retrieve the list of all entities of a given type that the current user has access to.
This list of access also includes the access level and the UUID of the entity.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| entityType | string Required |
preparation |
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| includeMetadata | boolean Optional |
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| X-CLIENT-VERSION | string Optional |
Response
200Status 200
Status 200
Body
application/json
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of SharingResponse |
|
|||||||||||
Get users/groups' access information to an entity
GET /sharing/sharings/{entityType}/{entityId}Use this method to get the list of computed accesses by users or groups to a given entity.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| entityType | string Required |
preparation |
|
| entityId | string Required |
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| includeMetadata | boolean Optional |
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| X-CLIENT-VERSION | string Optional |
Response
Patch a sharingset
PATCH /sharing/sharingsetA sharingset represents a list of users and groups.
Use this method to patch a list of sharingsets. The PATCH operation allows you to apply specific changes to the sharingset without replacing it entirely.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| X-CLIENT-VERSION | string Optional |
Body
application/json
Response
Get the list of permissions for an entity
GET /sharing/sharings/{entityType}/{entityId}/entitlementsUse this method to rerieve a list of available permissions for a given entity.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| entityType | string Required |
preparation |
|
| entityId | string Required |
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| X-CLIENT-VERSION | string Optional |
Response
ErrorMessageBody
This object is returned in case of an error during an API call.
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| timestamp | integer Required |
INT64 1622618273418 |
|
| status | integer Required |
INT32 400 |
|
| error | string Required |
Bad Request |
|
| exception | string Optional | ||
| message | string Optional |
The request is invalid |
|
| path | string Required |
/sharing/sharings/levels/dataset |
LevelResponse
Description of a level access for an entity.
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| code | string Required |
WRITER |
|
| label | string Required |
Editor |
|
| order | integer Required |
INT32 2 |
Eligibles
Description of a list of users and groups of users who are eligibles for the sharing of an entit.
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| users | array of User Optional |
|
||||||||||
| groups | array of Group Optional |
|
User
Basic description of an user, with its id, first name and last name.
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| userId | UUID | string Required |
15de7eb2-6447-49a8-a404-a53ecd1f3473 |
| firstName | string Required |
John |
|
| lastName | string Required |
Frusciante |
Group
Desription of group of users, with the group id and its name.
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| groupId | UUID | string Required |
15de7eb2-6447-49a8-a404-a53ecd1f3473 |
| groupName | string Required |
IT department |
SharingResponse
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| entityType | string Required |
dataset |
||||||||||
| entityId | UUID | string Required |
15de7eb2-6447-49a8-a404-a53ecd1f3473 |
|||||||||
| userId | UUID | string Required |
15de7eb2-6447-49a8-a404-a53ecd1f3473 |
|||||||||
| levelCode | string Required |
1 |
||||||||||
| entitlements | array of string Optional |
|
||||||||||
| userOwners | array of UserSharingResponse Optional |
|
||||||||||
| groupOwners | array of GroupSharingResponse Optional |
|
||||||||||
| sharingSetCount | integer Optional |
INT32 123 |
||||||||||
| isSharedWithOthers | boolean Optional |
UserSharingResponse
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| userId | UUID | string Required |
15de7eb2-6447-49a8-a404-a53ecd1f3473 |
| level | LevelResponse Required | ||
| firstName | string Optional |
John |
|
| lastName | string Optional |
Frusciante |
|
| foreignEntity | ForeignEntity Required | ||
| deletedAt | datetime Optional |
RFC3339 |
ForeignEntity
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| entityId | UUID | string Required |
15de7eb2-6447-49a8-a404-a53ecd1f3473 |
| entityType | string Required |
dataset |
GroupSharingResponse
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| groupId | UUID | string Required |
15de7eb2-6447-49a8-a404-a53ecd1f3473 |
| level | LevelResponse Required | ||
| groupName | string Optional |
IT department |
|
| foreignEntity | ForeignEntity Required | ||
| deletedAt | datetime Optional |
RFC3339 |
EntitlementsResponse
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| entityId | UUID | string Required |
15de7eb2-6447-49a8-a404-a53ecd1f3473 |
|||||||||
| entitlements | array of string Optional |
|
SharingSetResponse
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| users | array of UserSharingResponse Optional |
|
||||||||||
| groups | array of GroupSharingResponse Optional |
|
LevelRequest
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| code | string Required |
WRITER |
SharingSetKey
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| entityType | string Required |
dataset |
|
| entityId | UUID | string Required |
15de7eb2-6447-49a8-a404-a53ecd1f3473 |
PutSharingSetRequest
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| users | array of PutUserSharingRequest Optional |
|
||||||||||
| groups | array of PutGroupSharingRequest Optional |
|
PutUserSharingRequest
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| userId | UUID | string Required |
15de7eb2-6447-49a8-a404-a53ecd1f3473 |
| level | LevelRequest Required | ||
| firstName | string Optional |
John |
|
| lastName | string Optional |
Frusciante |
|
| foreignEntity | ForeignEntity Optional |
PutGroupSharingRequest
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| groupId | UUID | string Required |
15de7eb2-6447-49a8-a404-a53ecd1f3473 |
| level | LevelRequest Required | ||
| groupName | string Optional |
IT department |
|
| foreignEntity | ForeignEntity Optional |
PatchSharingSetRequest
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| users | array of PatchUserSharingRequest Optional |
|
||||||||||
| groups | array of PatchGroupSharingRequest Optional |
|
PatchUserSharingRequest
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| userId | UUID | string Required |
15de7eb2-6447-49a8-a404-a53ecd1f3473 |
| level | LevelRequest Optional | ||
| firstName | string Optional |
John |
|
| lastName | string Optional |
Frusciante |
|
| foreignEntity | ForeignEntity Optional |
PatchGroupSharingRequest
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| groupId | UUID | string Required |
15de7eb2-6447-49a8-a404-a53ecd1f3473 |
| level | LevelRequest Optional | ||
| groupName | string Optional |
IT department |
|
| foreignEntity | ForeignEntity Optional |
BulkSharingSetRequest
Object
| Name | Description | Type | Attributes and examples | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| bulk | array of Object Required |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||