Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Add Organization Role Assignments

POST/api/v2/admin/organizations/{organizationRid}/roleAssignments/add
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.

Assign roles to principals for the given Organization. At most 100 role assignments can be added in a single request.

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

Path parameters

organizationRid
string

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Request body

AddOrganizationRoleAssignmentsRequest
object
Hide child attributes

Hide child attributes

roleAssignments
list<RoleAssignmentUpdate>
optional
Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 4 5 curl -X POST \ -H "Content-type: application/json" \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/admin/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa/roleAssignments/add?preview=true" \ -d '{"roleAssignments":[{"roleId":"8bf49052-dc37-4528-8bf0-b551cfb71268","principalId":"f05f8da4-b84c-4fca-9c77-8af0b13d11de"}]}'

Error responses

Error Name
PrincipalNotFoundError CodeNOT_FOUND
Status Code404
DescriptionA principal (User or Group) with the given PrincipalId could not be found
ParametersprincipalId
AddOrganizationRoleAssignmentsPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not add the OrganizationRoleAssignment.
ParametersorganizationRid
OrganizationNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given Organization could not be found.
ParametersorganizationRid