Search documentation
karat

+

K

User Documentation ↗
Version 2.0

List Enrollment Role Assignments

GET/api/v2/admin/enrollments/{enrollmentRid}/roleAssignments
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

List all principals who are assigned a role for the given Enrollment.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-read.

Path parameters

enrollmentRid
string

Query parameters

preview
booleanoptional

Enables the use of preview functionality.

Response body

ListEnrollmentRoleAssignmentsResponse
object
Hide child attributes

Hide child attributes

data
list<EnrollmentRoleAssignment>optional
Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/admin/enrollments/ri.control-panel.main.customer.466f812b-f974-4478-9d4f-90402cd3def6/roleAssignments?preview=true"

Response

Copied!
1 2 3 4 5 6 7 8 9 { "data": [ { "roleId": "8bf49052-dc37-4528-8bf0-b551cfb71268", "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de", "principalType": "USER" } ] }

Error responses

Error Name
ListEnrollmentRoleAssignmentsPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionThe provided token does not have permission to list assigned roles for this enrollment.
ParametersenrollmentRid
EnrollmentNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given Enrollment could not be found.
ParametersenrollmentRid