SSO Role Mapping

Create and alter the role mappings, to assign automatically Talend roles to your SSO users.

Media type

application/json

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

Global security

These security schemes apply to the entire API

Public

Security scheme

This scheme can be referenced across the API

Public

Bearer authentication
Name	Description
Format	Bearer <TOKEN>

Headers
Name	Description	Type	Attributes and examples
Authorization	JWT Token or PAT	string Required

Get all role mappings

GET /security/role-mappings

Return the list of all role mappings for your tenant.

Response

200Status 200

Body

array of RoleMapping

Datatype details
Type	Description	Attributes and examples
array
RoleMapping

Status 200 application/json

[
   {
      "name":"role_1",
      "roles":[
         "talend_role_1",
         "talend_role_2",
         "talend_role_3"
      ]
   },
   {
      "name":"role_2",
      "roles":[
         "talend_role_4",
         "talend_role_5"
      ]
   }
]

401Status 401

The system failed to authenticate the user. Either the Authorization header was missing or the provided token was incorrect.

403Status 403

The system failed to authorize the user. The provided token was recognized but did not have the rights to perform the action. Contact your security administrator to get the appropriate rights.

429Status 429

Too many requests were sent. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.

500Status 500

The server encountered an unexpected condition that prevented it from fulfilling the request.

Create or replace all the role mappings

POST /security/role-mappings

Create or replace all the role mappings for your tenant.

Use cases

Mapping roles between SSO and Talend Cloud

Response

200Status 200

Body

RoleMapping

Status 200 application/json

[
   {
      "name":"role_1",
      "roles":[
         "talend_role_1",
         "talend_role_2",
         "talend_role_3"
      ]
   },
   {
      "name":"role_2",
      "roles":[
         "talend_role_4",
         "talend_role_5"
      ]
   }
]

400Status 400

Invalid request body. The message varies depending on the cause of the bad request. For example, the cause could be a malformed body or parameter.

401Status 401

The system failed to authenticate the user. Either the Authorization header was missing or the provided token was incorrect.

403Status 403

The system failed to authorize the user. The provided token was recognized but did not have the rights to perform the action. Contact your security administrator to get the appropriate rights.

429Status 429

Too many requests were sent. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.

500Status 500

The server encountered an unexpected condition that prevented it from fulfilling the request.

Delete all the role mappings

DELETE /security/role-mappings

Delete all the role mappings for your tenant.

This action will disable the role mapping feature for your tenant.

Response

204Status 204

401Status 401

The system failed to authenticate the user. Either the Authorization header was missing or the provided token was incorrect.

403Status 403

The system failed to authorize the user. The provided token was recognized but did not have the rights to perform the action. Contact your security administrator to get the appropriate rights.

429Status 429

Too many requests were sent. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.

500Status 500

The server encountered an unexpected condition that prevented it from fulfilling the request.

Get a specific role mapping

GET /security/role-mappings/{customerRoleName}

Get a specific role mapping for your tenant.

Request

Path variables
Name	Description	Type	Attributes and examples
customerRoleName	Customer role name	string Required	Examples role_1 role_2

Response

200Status 200

Body

RoleMapping

Status 200 application/json

{
  "name":"role_1",
  "roles":[
    "talend_role_1",
    "talend_role_2",
    "talend_role_3"
  ]
}

401Status 401

The system failed to authenticate the user. Either the Authorization header was missing or the provided token was incorrect.

403Status 403

The system failed to authorize the user. The provided token was recognized but did not have the rights to perform the action. Contact your security administrator to get the appropriate rights.

404Status 404

Resource not found.

429Status 429

Too many requests were sent. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.

500Status 500

The server encountered an unexpected condition that prevented it from fulfilling the request.

Delete a specific role mapping

DELETE /security/role-mappings/{customerRoleName}

Delete a specific role mappings for your tenant.

Request

Path variables
Name	Description	Type	Attributes and examples
customerRoleName	Customer role name	string Required	Examples role_1 role_2

Response

204Status 204

401Status 401

The system failed to authenticate the user. Either the Authorization header was missing or the provided token was incorrect.

403Status 403

The system failed to authorize the user. The provided token was recognized but did not have the rights to perform the action. Contact your security administrator to get the appropriate rights.

404Status 404

Resource not found.

429Status 429

Too many requests were sent. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.

500Status 500

The server encountered an unexpected condition that prevented it from fulfilling the request.

Object

name

Customer role name

string Required

roles

array of string Required

Datatype details
Type	Description	Attributes and examples
array	Talend roles name
string

RoleMapping

{
  "name":"role_1",
  "roles":[
    "talend_role_1",
    "talend_role_2",
    "talend_role_3"
  ]
}

↑