Workspace Permissions
Control and manage your users detailed permissions upon Workspaces and Engines.
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 |
|---|
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| Authorization | string Optional |
Unitary management
Read a service account workspace permission
GET /security/workspaces/{workspaceId}/service-accounts/{serviceAccountId}/permissionsRead a permission of a service account on a workspace.
Security
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| workspaceId | The workspace where rights will be applied. Example Value: 6089228181ef4423736e47a9 | string Required | |
| serviceAccountId | The user for which rights will be applied. Example Value: b9e10a3f-9d68-44bb-862f-b2aa56dc7191 | string Required |
Response
Create a service account workspace permission
POST /security/workspaces/{workspaceId}/service-accounts/{serviceAccountId}/permissionsCreate a permission of a service account on a workspace.
Security
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| workspaceId | The workspace where rights will be applied. Example Value: 6089228181ef4423736e47a9 | string Required | |
| serviceAccountId | The user for which rights will be applied. Example Value: b9e10a3f-9d68-44bb-862f-b2aa56dc7191 | string Required |
Body
*/*
Rights to add on the permission.
Example: [“AUTHOR”,“EXECUTE”]
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of string |
|
|||||||||||
Response
201Status 201
Permission successfully created
Update a service account workspace permission
PUT /security/workspaces/{workspaceId}/service-accounts/{serviceAccountId}/permissionsUpdate a permission of a service account on a workspace.
Security
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| workspaceId | The workspace where rights will be applied. Example Value: 6089228181ef4423736e47a9 | string Required | |
| serviceAccountId | The user for which rights will be applied. Example Value: b9e10a3f-9d68-44bb-862f-b2aa56dc7191 | string Required |
Body
*/*
Rights to update on the permission.
Example: [“AUTHOR”,“EXECUTE”]
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of string |
|
|||||||||||
Response
204Status 204
No Content
Delete a service account workspace permission
DELETE /security/workspaces/{workspaceId}/service-accounts/{serviceAccountId}/permissionsDelete a permission of a service account on a workspace.
Security
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| workspaceId | The workspace where rights will be applied. Example Value: 6089228181ef4423736e47a9 | string Required | |
| serviceAccountId | The user for which rights will be applied. Example Value: b9e10a3f-9d68-44bb-862f-b2aa56dc7191 | string Required |
Response
204Status 204
No Content
Read a workspace permission
GET /security/workspaces/{workspaceId}/users/{userId}/permissionsRead a permission of a user on a workspace.
Security
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| workspaceId | The workspace where rights will be applied. Example Value: 6089228181ef4423736e47a9 | string Required | |
| userId | The user for which rights will be applied. Example Value: b9e10a3f-9d68-44bb-862f-b2aa56dc7191 | string Required |
Response
Update a workspace permission
PUT /security/workspaces/{workspaceId}/users/{userId}/permissionsUpdate a permission of a user on a workspace.
Security
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| workspaceId | The workspace where rights will be applied. Example Value: 6089228181ef4423736e47a9 | string Required | |
| userId | The user for which rights will be applied. Example Value: b9e10a3f-9d68-44bb-862f-b2aa56dc7191 | string Required |
Body
*/*
Rights to update on the permission.
Example: [“AUTHOR”,“EXECUTE”]
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of string |
|
|||||||||||
Response
204Status 204
No Content
Create a workspace permission
POST /security/workspaces/{workspaceId}/users/{userId}/permissionsCreate a permission of a user on a workspace.
Security
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| workspaceId | The workspace where rights will be applied. Example Value: 6089228181ef4423736e47a9 | string Required | |
| userId | The user for which rights will be applied. Example Value: b9e10a3f-9d68-44bb-862f-b2aa56dc7191 | string Required |
Body
*/*
Rights to add on the permission.
Example: [“AUTHOR”,“EXECUTE”]
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of string |
|
|||||||||||
Response
201Status 201
Permission successfully created
Delete a workspace permission
DELETE /security/workspaces/{workspaceId}/users/{userId}/permissionsDelete a permission of a user on a workspace.
Security
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| workspaceId | The workspace where rights will be applied. Example Value: 6089228181ef4423736e47a9 | string Required | |
| userId | The user for which rights will be applied. Example Value: b9e10a3f-9d68-44bb-862f-b2aa56dc7191 | string Required |
Response
204Status 204
No Content
Provisioning and Mass management
Create sets of workspace permissions for a service account
POST /security/service-accounts/permissions/batchCreate sets of workspace permissions on the current system. Allows to upload list of workspace permissions to be created.Creation actions will be applied in the same order as defined in the list
Security
Request
Body
application/json
The collection of permissions to create.
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of Permission |
|
|||||||||||
Response
204Status 204
All changes on Permissions were successful
207Status 207
Execution result detailed status on elementary changes rejected.
Body
application/json
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of PermissionResult |
|
|||||||||||
Update sets of workspace permissions for a service account
PUT /security/service-accounts/permissions/batchUpdate sets of workspace permissions on the current system. Allows to upload list of workspace permissions to be updated.Update actions will be applied in the same order as defined in the list
Security
Request
Body
application/json
The collection of permissions to update.
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of Permission |
|
|||||||||||
Response
204Status 204
All changes on Permissions were successful
207Status 207
Execution result detailed status on elementary changes rejected.
Body
application/json
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of PermissionResult |
|
|||||||||||
Delete workspace permissions for a service account
DELETE /security/service-accounts/permissions/batchRemove all permissions where service account id is one from specified ones with request AND workspace is one from specified ones with request.
Special case: empty collection for users means that permissions for all service accounts and specified workspaces will be deleted (and vise versa).
Security
Request
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| serviceAccountIds | array of string Optional |
|
||||||||||
| workspaceIds | array of string Optional |
|
Response
204Status 204
All changes on Permissions were successful
207Status 207
Execution result detailed status on elementary changes rejected.
Body
application/json
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of PermissionDeleteResult |
|
|||||||||||
Retrieve all workspace permissions for a service account according to search criteria
GET /security/service-accounts/permissionsIt retrieves all workspace permissions according to several criteria:
environment : One environment of the account workspace : One workspace of one environment of the account serviceAccount : One service account of the account
Security
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| serviceAccountId | The service account id (Optional) Example Value: b9e10a3f-9d68-44bb-862f-b2aa56dc7191 | string Optional | |
| workspaceId | The workspace id (Optional) Example Value: 6089228181ef4423736e47a9 | string Optional | |
| environmentId | The environment id (Optional) Example Value: 6089228181ef4423736e47a8 | string Optional |
Response
200Status 200
OK
Body
application/json
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of Permission |
|
|||||||||||
404Status 404
The environment id or the workspace id or the user id does not exist
Body
application/json
Update sets of workspace permissions
PUT /security/permissions/batchUpdate sets of workspace permissions on the current system. Allows to upload list of workspace permissions to be updated.Update actions will be applied in the same order as defined in the list
Security
Request
Body
application/json
The collection of permissions to update.
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of Permission |
|
|||||||||||
Response
204Status 204
All changes on Permissions were successful
207Status 207
Execution result detailed status on elementary changes rejected.
Body
application/json
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of PermissionResult |
|
|||||||||||
Create sets of workspace permissions
POST /security/permissions/batchCreate sets of workspace permissions on the current system. Allows to upload list of workspace permissions to be created.Creation actions will be applied in the same order as defined in the list
Security
Request
Body
application/json
The collection of permissions to create.
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of Permission |
|
|||||||||||
Response
204Status 204
All changes on Permissions were successful
207Status 207
Execution result detailed status on elementary changes rejected.
Body
application/json
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of PermissionResult |
|
|||||||||||
Delete workspace permissions
DELETE /security/permissions/batchRemove all permissions where user id is one from specified ones with request AND workspace is one from specified ones with request.
Special case: empty collection for users means that permissions for all users and specified workspaces will be deleted (and vise versa).
Security
Request
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| userIds | array of string Optional |
|
||||||||||
| workspaceIds | array of string Optional |
|
Response
204Status 204
All changes on Permissions were successful
207Status 207
Execution result detailed status on elementary changes rejected.
Body
application/json
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of PermissionDeleteResult |
|
|||||||||||
Retrieve all workspace permissions according to search criteria
GET /security/permissionsIt retrieves all workspace permissions according to several criteria:
environment : One environment of the account workspace : One workspace of one environment of the account user : One user of the account
Security
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| workspaceId | The workspace id (Optional) Example Value: 6089228181ef4423736e47a9 | string Optional | |
| userId | The user id (Optional) Example Value: b9e10a3f-9d68-44bb-862f-b2aa56dc7191 | string Optional | |
| environmentId | The environment id (Optional) Example Value: 6089228181ef4423736e47a8 | string Optional |
Response
200Status 200
OK
Body
application/json
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of Permission |
|
|||||||||||
404Status 404
The environment id or the workspace id or the user id does not exist
Body
application/json
Commons
Environmentinfo
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | Environment identifier | string Required |
57f64991e4b0b689a64feed3 |
| name | Environment name | string Required |
Development |
| description | Environment description (not returned when querying a list of objects) | string Optional |
environment detail description |
| default | Default environment flag | boolean Optional |
ErrorResponse
Error response object
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| status | Status code | integer Required |
INT32 |
| message | Error message (multilanguage). Info about error for user. | string Required |
something went wrong |
| details | Developer message (not translated). Info about error for developer. | string Optional |
more descriptive info about something went wrong |
| code | Internal error code | string Optional |
TIPASS-SCHED-123 |
| url | URL provided detailed info about error | string Optional |
https://error.talend.com/details/tic?code=SCHED-123 |
| requestId | The unique identification of the request involved with this error | string Optional |
16fefb53-035a-4249-af9d-f80a3b47b132 |
Permission
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| workspaceId | The workspace id | string Required |
57f64991e4b0b689a64feed2 |
|||||||||
| userId | The user id | string Required |
b9e10a3f-9d68-44bb-862f-b2aa56dc7191 |
|||||||||
| permissions | array of string Required |
|
PermissionDeleteResult
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| status | integer Optional |
INT32 |
|
| message | string Optional | ||
| permissionId | PermissionId Optional |
PermissionId
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| workspaceId | The workspace id | string Required |
57f64991e4b0b689a64feed2 |
| userId | The user id | string Required |
9f1634e7-d791-4be4-9aed-2970f8d804dd |
PermissionResult
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| status | integer Optional |
INT32 |
|
| message | string Optional | ||
| permission | Permission Optional |
Workspaceinfo
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | Workspace identifier | string Required |
57f64991e4b0b689a64feed2 |
| name | Workspace name | string Required |
Personal |
| description | Workspace description | string Optional |
workspace detail description |
| owner | Workspace owner | string Optional |
admin |
| type | Workspace type | string Required |
custom |
| environment | Environmentinfo Optional |