---
title: "Create a new Administrative Role."
slug: "create-a-new-administrative-role-1"
updated: 2026-03-02T22:30:52Z
published: 2026-03-02T22:35:52Z
canonical: "support.appgate.com/create-a-new-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.

# Create a new Administrative Role.

Post/administrative-roles

Create a new Administrative Role.

SecurityHTTPType bearer

Body parameters

Administrative Role object.

<select class='api-response-data' aria-label='Media type'><option value='38cec448-0cc8-4d7d-a162-3040f940771d'>application/json</option>
</select>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

Created Administrative Role.

<select class='api-response-data' aria-label='Media type'><option value='d40f0f65-e820-45ea-bf1e-83cfa7feed85'>application/json</option>
</select>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.

<select class='api-response-data' aria-label='Media type'><option value='53f31d31-7ed2-4522-9f40-de4e7a1ab459'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

401

Token error. Login again.

<select class='api-response-data' aria-label='Media type'><option value='2d77373e-be68-4af1-b15b-bd4a5d3ffea0'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

403

Insufficient permissions to access this resource.

<select class='api-response-data' aria-label='Media type'><option value='f8de7b6d-d798-40e6-b162-650cbcbe195e'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

406

Invalid 'Accept' header.

<select class='api-response-data' aria-label='Media type'><option value='fec664c9-7624-4dc2-913b-bf005c40c472'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

409

The submitted resource conflicts with another.

<select class='api-response-data' aria-label='Media type'><option value='bded4000-a486-4171-89c3-d66708937819'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

422

Request validation error. Check "errors" array for details.

<select class='api-response-data' aria-label='Media type'><option value='eef2dcca-79b5-4036-a73d-b9158bf89898'>application/json</option>
</select>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.

<select class='api-response-data' aria-label='Media type'><option value='154373d9-344d-4430-a71b-86c022a2a686'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.