Get role

Returns a single role definition by role uuid. The response omits permission actions.

get/user-management/1/roles/{roleId}

Authorizations

Authorizationstringrequired

Contact Amplitude Support to obtain your organization's org API key and org secret key.Send them as HTTP Basic credentials on every request: org API key in the username field, org secret key in the password field. Also include orgId as a query parameter for your organization.401: invalid credentials. 403 (org_not_enrolled): your organization is not enabled for this API.

Path parameters

roleIdstringrequired

Role uuid in the caller organization.

Constraints:format: uuid

Query parameters

orgIdintegerrequired

Organization id for the authenticated API caller. Must match the organization tied to the org key pair in the Authorization header.

Constraints:min: 1

Response

application/json
200· Role found
uuidstringrequired
Constraints:format: uuid
namestringrequired
orgIdinteger
Constraints:min: 0
tagsobjectrequired

Tags associated with a role. Use the "description" key for a human readable summary.

Example:{"product":["experiment"],"type":"custom"}
400· Invalid request parameters or body
typestringrequired

RFC 7807 problem type URI

Constraints:format: uri
titlestringrequired
statusintegerrequired
detailstring
Constraints:nullable
instancestring
Constraints:nullable
error_codestringrequired
Allowed values:invalid_requestauthentication_requiredinsufficient_permissionsorg_id_mismatchorg_not_enrollednot_foundconflictrate_limitedinternal_error
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullable
401· Missing or invalid credentials
typestringrequired

RFC 7807 problem type URI

Constraints:format: uri
titlestringrequired
statusintegerrequired
detailstring
Constraints:nullable
instancestring
Constraints:nullable
error_codestringrequired
Allowed values:invalid_requestauthentication_requiredinsufficient_permissionsorg_id_mismatchorg_not_enrollednot_foundconflictrate_limitedinternal_error
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullable
403· Not allowed (org not enrolled, orgId mismatch, or insufficient permissions)
typestringrequired

RFC 7807 problem type URI

Constraints:format: uri
titlestringrequired
statusintegerrequired
detailstring
Constraints:nullable
instancestring
Constraints:nullable
error_codestringrequired
Allowed values:invalid_requestauthentication_requiredinsufficient_permissionsorg_id_mismatchorg_not_enrollednot_foundconflictrate_limitedinternal_error
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullable
404· This role does not exist or belongs to another org
typestringrequired

RFC 7807 problem type URI

Constraints:format: uri
titlestringrequired
statusintegerrequired
detailstring
Constraints:nullable
instancestring
Constraints:nullable
error_codestringrequired
Allowed values:invalid_requestauthentication_requiredinsufficient_permissionsorg_id_mismatchorg_not_enrollednot_foundconflictrate_limitedinternal_error
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullable
429· Rate limit exceeded
typestringrequired

RFC 7807 problem type URI

Constraints:format: uri
titlestringrequired
statusintegerrequired
detailstring
Constraints:nullable
instancestring
Constraints:nullable
error_codestringrequired
Allowed values:invalid_requestauthentication_requiredinsufficient_permissionsorg_id_mismatchorg_not_enrollednot_foundconflictrate_limitedinternal_error
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullable
500· Unexpected server error
typestringrequired

RFC 7807 problem type URI

Constraints:format: uri
titlestringrequired
statusintegerrequired
detailstring
Constraints:nullable
instancestring
Constraints:nullable
error_codestringrequired
Allowed values:invalid_requestauthentication_requiredinsufficient_permissionsorg_id_mismatchorg_not_enrollednot_foundconflictrate_limitedinternal_error
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullable

Was this helpful?