HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Update an admin entitlement.

patch
https://{tenanturl}/v1.0/admin/entitlements/

Entitlements required: tenantadmin [Tenant Administrator], manageEntitlements [Manage Entitlements].

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

Path Params
string
required

Code of the admin entitlement to update.

Body Params

The body of the admin entitlement to update.

Rest representation for an admin entitlement to be updated.

string
required

Name of the entitlement. Unique accross the application

string

Description of the entitlement

boolean

Indicates whether the entitlement supports scoping. The false value means the entitlement does not support scope, while true indicates that it does. Scoped entitlements restrict access to specific subset of resources based on configured scope rules. For example, the readUsers entitlement supports scoping. If its scope is configured for Group 1, a user assigned this entitlement can only view users who belong to Group 1.

conditionSet
array of objects

[Deprecated] Condition set to determine the users that belong to this role. And, Example value:[{"erDepartment":[{"op":"eq","vl":"Security"},{"op":"ne","vl":"Sales"}],"erPersonType":[{"op":"sw","vl":"Employee"},{"op":"ne","vl":"Contractor"}]},{"erDepartment":[{"op":"eq","vl":"Marketing"}]}]

conditionSet
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
204

The request was successful.

500

Your request can't be processed because an internal server error occurred.

Updated 9 months ago

Language
URL
LoadingLoading

Response
Choose an example:
application/json
text/plain

Updated 9 months ago