---
title: "Update an existing Administrative Role."
slug: "update-an-existing-administrative-role-1"
updated: 2026-03-02T22:30:52Z
published: 2026-03-02T22:35:52Z
canonical: "support.appgate.com/update-an-existing-administrative-role-1"
---
> ## Documentation Index
> Fetch the complete documentation index at: https://support.appgate.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Update an existing Administrative Role.
Put/administrative-roles/{id}
Update an existing Administrative Role.
SecurityHTTPType bearer
Path parametersidstring (uuid) Required
ID of the object.
Example12699e27-b584-464a-81ee-5b4784b6d425
Body parameters
Administrative Role object.
Expand Allobject idstring (uuid)
ID of the object.
Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
namestring Required
Name of the object.
Exampleobject
notesstring
Notes for the object. Used for documentation purposes.
ExampleThis object has been created for test purposes.
tags Array of string
Array of tags.
Example[
"developer",
"api-created"
]string
privileges Array of object (AdministrativePrivilege) Required
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.
typestring Required
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"
]
targetstring Required
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"
]
scopeobject
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.
allboolean
'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
tags Array of string
Object tags this privilege would have access to.
string Exampletag
defaultTags Array of string
The items in this list would be added automatically to the newly created objects' tags. Only applicable on "Create" type and targets with tagging capability. This field must be omitted if not applicable.
string Exampleapi-created
functions Array of string (ApplianceFunction)
Privilege for changing Appliance Functions. Only applicable on "AssignFunction" type with Appliance or All target. This field must be omitted if not applicable.
string Valid values[
"Controller",
"Gateway",
"LogServer",
"LogForwarder",
"Connector",
"Portal",
"Metrics Aggregator",
"Connection Broker"
]
Responses200
Updated Administrative Role.
Expand Allobject idstring (uuid)
ID of the object.
Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
namestring
Name of the object.
Exampleobject
notesstring
Notes for the object. Used for documentation purposes.
ExampleThis object has been created for test purposes.
createdstring (date-time)
Create date.
updatedstring (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.
typestring
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"
]
targetstring
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"
]
scopeobject
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.
allboolean
'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
tags Array of string
Object tags this privilege would have access to.
string Exampletag
defaultTags Array of string
The items in this list would be added automatically to the newly created objects' tags. Only applicable on "Create" type and targets with tagging capability. This field must be omitted if not applicable.
string Exampleapi-created
functions Array of string (ApplianceFunction)
Privilege for changing Appliance Functions. Only applicable on "AssignFunction" type with Appliance or All target. This field must be omitted if not applicable.
string Valid values[
"Controller",
"Gateway",
"LogServer",
"LogForwarder",
"Connector",
"Portal",
"Metrics Aggregator",
"Connection Broker"
]
400
JSON error. Check the JSON format.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
401
Token error. Login again.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
403
Insufficient permissions to access this resource.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
404
The requested resource can not be found.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
406
Invalid 'Accept' header.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
422
Request validation error. Check "errors" array for details.
Expand Allobject
Http 422 error for object validation.
idstring
Machine readable error code.
messagestring
Human readable error details.
errors Array of object
List of fields with validation errors.
object fieldstring
Name of the field that failed validation.
Examplename
messagestring
Failure reason.
Examplemay not be null
500
Unexpected server side error.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.