External Role Assignments
Authorizations
AuthorizationstringRequired
API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.
Path parameters
workspace_idstring · uuidRequired
Query parameters
sort_bystring[]OptionalDefault:
[]limitinteger · max: 200OptionalDefault:
50continuation_tokenanyOptional
Responses
200
Successful Response
application/json
has_morebooleanRequired
continuation_tokenanyOptional
422
Validation Error
application/json
get/v1/{workspace_id}/external-role-assignments
Authorizations
AuthorizationstringRequired
API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.
Path parameters
workspace_idstring · uuidRequired
Body
sourcestring · min: 1 · max: 128Required
external_subject_keystring · min: 1 · max: 512Required
external_subject_idstring · max: 512 · nullableOptional
entity_idstring · uuidRequired
display_namestring · max: 512 · nullableOptional
rolesstring[] · max: 64Optional
roles_verifiedbooleanOptionalDefault:
falseprovisioned_viastring · enumRequiredPossible values:
Responses
200
Successful Response
application/json
idstring · uuidRequired
sourcestringRequired
external_subject_keystringRequired
external_subject_idstring · nullableOptional
entity_idstring · uuidRequired
display_namestring · nullableOptional
rolesstring[]Required
roles_verifiedbooleanRequired
statusstring · enumRequiredPossible values:
provisioned_viastring · enumRequiredPossible values:
last_verified_atstring · date-time · nullableOptional
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
422
Validation Error
application/json
put/v1/{workspace_id}/external-role-assignments
Authorizations
AuthorizationstringRequired
API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.
Path parameters
workspace_idstring · uuidRequired
assignment_idstring · uuidRequired
Responses
200
Successful Response
application/json
idstring · uuidRequired
sourcestringRequired
external_subject_keystringRequired
external_subject_idstring · nullableOptional
entity_idstring · uuidRequired
display_namestring · nullableOptional
rolesstring[]Required
roles_verifiedbooleanRequired
statusstring · enumRequiredPossible values:
provisioned_viastring · enumRequiredPossible values:
last_verified_atstring · date-time · nullableOptional
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
404
Assignment not found
422
Validation Error
application/json
get/v1/{workspace_id}/external-role-assignments/{assignment_id}
Authorizations
AuthorizationstringRequired
API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.
Path parameters
workspace_idstring · uuidRequired
assignment_idstring · uuidRequired
Responses
204
Successful Response
No content
404
Assignment not found
422
Validation Error
application/json
delete/v1/{workspace_id}/external-role-assignments/{assignment_id}
No content
Last updated
Was this helpful?

