Patch a specified Role
PATCH/roles/:id
This API updates an existing role using JSON Patch syntax. The following fields are patchable:
- name
- description
- enabled
- owner
- accessProfiles
- entitlements
- membership
- requestable
- accessRequestConfig
- revokeRequestConfig
- segments
- accessModelMetadata
A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time.
Request
Responses
- 200
- 400
- 401
- 403
- 429
- 500
Responds with the Role as updated.
Client Error - Returned if the request body is invalid.
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
Internal Server Error - Returned if there is an unexpected error.