Patch a specified Access Profile

PATCH 
/access-profiles/:id

This API updates an existing Access Profile. The following fields are patchable: name, description, enabled, owner, requestable, accessRequestConfig, revokeRequestConfig, segments, entitlements, provisioningCriteria A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer.

The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.

You can only add or replace entitlements that exist on the source that the access profile is attached to. You can use the list entitlements endpoint with the filters query parameter to get a list of available entitlements on the access profile's source.

Request

Responses

200

Responds with the Access Profile as updated.

400

Client Error - Returned if the request body is invalid.

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

429

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.

500

Internal Server Error - Returned if there is an unexpected error.