Get role

Get a SCIM role by ID

GET /api/v1/scim/v2/Roles/{roleId}

Error

A valid request URL is required to generate request examples

200

{
  "schemas": [
    "urn:ietf:params:scim:schemas:extension:2.0:Role"
  ],
  "id": "member",
  "value": "member",
  "display": "Member",
  "type": "Organization",
  "supported": true,
  "meta": {
    "resourceType": "Role",
    "location": "https://<tenant>.lightdash.cloud/api/v1/scim/v2/Roles/member"
  }
}

{
  "status": "<string>",
  "detail": "<string>",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ]
}

Path Parameters

roleId · string · required

Role ID - this is used as a unique identifier for SCIM

Response

200

application/json

Ok

schemas · enum<string>[] · required

Available options: urn:ietf:params:scim:schemas:extension:2.0:Role

id · string · required

meta · object · required

Show child attributes

value · string · required

supported · boolean · required

display · string

type · string