Grist Octri Preview
GET/scim/v2/Roles/{roleId}

Get a role by ID

Retrieves a SCIM role by its identifier. Use roleId to specify the role whose details you need, including its display name and memberships.

1 parameter
roleIdintegerrequired
The integer identifier of the role to retrieve.

5 status codes
200Returns the SCIM role object, including its identifier, display name, memberships, metadata, and schemas.
displayNamestringrequired
The name of the role.
idstringrequired
The unique identifier of the role.
membersarray<object>required
metaobjectrequired
schemasarray<string>required
401Returned when the request is unauthenticated.
403Returned when the request is unauthorized.
404Returned when the role is not found.
500Returned when an internal server error occurs.

Error handling

A 401 is returned when the request is unauthenticated, and a 403 when it is unauthorized. A 404 is returned when the role is not found, and a 500 when an internal server error occurs. The roleId path parameter must identify the role to retrieve.