Get a specific Administrative Role.

Published on Oct 27, 2025

2 minute read

Prev Next

Get

/administrative-roles/{id}

Get a specific Administrative Role.

Security

HTTP

Type bearer

Path parameters

string (uuid) Required

ID of the object.

Example12699e27-b584-464a-81ee-5b4784b6d425

Responses

200

Single Administrative Role.

Expand All

object

string (uuid)

ID of the object.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc

name

string

Name of the object.

Exampleobject

notes

string

Notes for the object. Used for documentation purposes.

ExampleThis object has been created for test purposes.

created

string (date-time)

Create date.

updated

string (date-time)

Last update date.

tags

Array of string

Array of tags.

Example[ "developer", "api-created" ]

string

privileges

Array of object (AdministrativePrivilege)

Administrative privilege list.

object

Administrative Privilege item. Use type-target-map API to get the details on which types are valid for which targets and their scopes.

type

string

The type of the Privilege defines the possible administrator actions.

Valid values[ "All", "View", "Create", "Edit", "Tag", "Delete", "Revoke", "Export", "Upgrade", "RenewCertificate", "DownloadLogs", "Test", "GetUserAttributes", "Backup", "CheckStatus", "Reevaluate", "Reboot", "AssignFunction" ]

target

string

The target of the Privilege defines the possible target objects for that type.

Valid values[ "All", "Appliance", "Condition", "CriteriaScript", "Entitlement", "AdministrativeRole", "IdentityProvider", "MfaProvider", "IpPool", "LocalUser", "ServiceUser", "Policy", "Site", "DeviceClaimScript", "EntitlementScript", "RingfenceRule", "ApplianceCustomization", "TrustedCertificate", "UserClaimScript", "OtpSeed", "Fido2Device", "Blacklist", "License", "UserLicense", "RegisteredDevice", "AllocatedIp", "SessionInfo", "AuditLog", "AdminMessage", "GlobalSetting", "CaCertificate", "File", "AutoUpdate", "RiskModel", "Ztp", "ClientProfile", "Secret", "DiscoveredApp" ]

scope

object

The scope of the Privilege. Only applicable to certain type-target combinations. Some types depend on the IdP/MFA type, such as GetUserAttributes. This field must be omitted if not applicable.

all

boolean

'If "true", all objects are accessible. For example, "type: Edit - target: Condition - scope.all: true" means the administrator can edit all Conditions in the system.'

ids

Array of string

Specific object IDs this Privilege would have access to.

string (uuid)

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc