Skip to main content
PATCH
Update an Admin Role

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

ruleset
string
required

Policy Ruleset ID

user
string
required

Directory User ID of the admin

Body

application/json

UpdatePolicyRulesetAdminData

role
enum<string>
required

The administrative role for managing this ruleset. Rule and conditions are not in effect until a user with activate or admin role activates the rule.

  • admin - Can view, create, activate, deprecate, and delete rules and conditions in the ruleset
  • audit - Can view rules and conditions (read-only)
  • create - Can view rules and conditions and create new rules and conditions in a draft state.
  • activate - Can view rules and conditions and activate draft rules
Available options:
admin,
audit,
create,
activate

Response

PolicyRulesetAdminDetailedResponseData

id
string
required
Example:

"posaa_01hq8xyzabc123def456ghi789"

state
enum<string>
required
Available options:
staged,
active,
expiring,
expired,
deactivated
role
enum<string>
required
Available options:
admin,
audit,
create,
activate
count
object
required

Count of related resources

included
object
required

Included related resources

timestamp
TimestampStateData · object
required

API hyperlinks related to the Policy Ruleset Admin record

Example: