Get project effective access

Returns the resolved access list for a project: which users and groups have access, which role applies, and how that access was granted.

get/user-management/1/projects/{projectId}/access

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

projectIdintegerrequired

Amplitude project id to resolve effective access for.

Constraints:min: 1

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
cursorstring

Opaque pagination cursor from a previous response pagination.nextCursor. Omit to start at the first page.

limitinteger

Maximum number of items per page. Defaults to 50 when omitted and is capped at 200.

Constraints:min: 1max: 200

Response

application/json
200· Project effective access found
dataobject[]required
Show child attributes
principalIdstringrequired
principalTypestringrequired
Allowed values:usergroup
appIdintegerrequired
Constraints:min: 0
roleobjectrequired

A role as returned by the User Management API. Omits internal permission actions.

Example:{"uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Experiment Manager","orgId":36958,"tags":{"product":["experiment"],"type":"custom"}}
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"}
sourcestringrequired
Allowed values:directgrouporg-directorg-group
paginationobjectrequired

Cursor pagination metadata. nextCursor is the cursor to pass to fetch the next page, or null when there are no more results. hasMore indicates whether another page is available.

Example:{"nextCursor":0,"hasMore":true}
Show child attributes
nextCursorstringrequired
Constraints:nullable
hasMorebooleanrequired
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 project 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?