Get project role assignment

Returns a single explicit project role assignment by assignment id.

get/user-management/1/project-role-assignments/{assignmentId}

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

assignmentIdstringrequired

Opaque id of the explicit project role assignment to fetch, update, or delete.

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· Project role assignment found
idstringrequired
Constraints:min length: 1
principalTypestringrequired

Whether the assignment targets an individual user (user) or a group (group)

Allowed values:usergroup
Example:user
principalIdstringrequired
Constraints:min length: 1
projectIdintegerrequired
Constraints:min: 0
roleIdstringrequired
Constraints:format: uuid
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 assignment id 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?