openapi: 3.2.0 info: title: Administration and Settings Administration - User and Group API description: "Includes API operations for the following:\n Global parameters for SD-WAN Manager\n User, group and tenant management\n Software maintenance\n Backup and restore\n Container management" contact: email: vmanage@cisco.com license: name: Commercial License url: https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html version: 26.1.0+2026-01-06 x-provenance: method: harvested authored_by: Cisco Catalyst SD-WAN harvested_by: API Evangelist harvested_on: '2026-08-19' first_party: true provider_published: true source_host: pubhub.devnetcloud.com note: 4,138 operations across 2,841 paths, published by Cisco as self-contained per-operation OpenAPI 3.1.0 fragments on the DevNet CDN and consolidated here into 13 documents. Ownership verified from info.contact vmanage@cisco.com and the Cisco license URL rather than from the fetch host. x-evidence: - type: source url: https://pubhub.devnetcloud.com/media/cisco-catalyst-sd-wan-26-1-api-guide/docs/ - type: source url: https://developer.cisco.com/docs/sdwan/ servers: - url: /dataservice tags: - name: Administration - User and Group paths: /admin/aaa: get: tags: - Administration - User and Group description: 'Get aaa configuration


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.' operationId: getAaaConfig responses: '200': description: Ok content: application/json: schema: type: object properties: accounting: type: boolean description: Enable accounting to track user sessions and command execution for auditing purposes adminAuthOrder: type: boolean description: Enable separate authentication order for administrative users auditDisable: type: boolean description: Disable audit logging for authentication and authorization events authFallback: type: boolean description: Enable authentication fallback to local user database when external authentication servers are unreachable authOrder: maxItems: 3 minItems: 1 type: array description: Ordered list of authentication methods to be used for user login (e.g., local, radius, tacacs). Minimum 1, maximum 3 authentication methods allowed. items: type: string description: Ordered list of authentication methods to be used for user login (e.g., local, radius, tacacs). Minimum 1, maximum 3 authentication methods allowed. enum: - local - radius - tacacs description: AAA configuration $$ref: '#/components/schemas/Aaa' examples: AAA Configuration Response: description: AAA Configuration Response value: authOrder: - local - radius authFallback: true adminAuthOrder: false auditDisable: false accounting: true '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error post: tags: - Administration - User and Group description: 'Create aaa configuration


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.' operationId: createAaaConfig requestBody: description: aaa content: application/json: schema: type: object properties: accounting: type: boolean description: Enable accounting to track user sessions and command execution for auditing purposes adminAuthOrder: type: boolean description: Enable separate authentication order for administrative users auditDisable: type: boolean description: Disable audit logging for authentication and authorization events authFallback: type: boolean description: Enable authentication fallback to local user database when external authentication servers are unreachable authOrder: maxItems: 3 minItems: 1 type: array description: Ordered list of authentication methods to be used for user login (e.g., local, radius, tacacs). Minimum 1, maximum 3 authentication methods allowed. items: type: string description: Ordered list of authentication methods to be used for user login (e.g., local, radius, tacacs). Minimum 1, maximum 3 authentication methods allowed. enum: - local - radius - tacacs description: AAA configuration $$ref: '#/components/schemas/Aaa' examples: AAA Configuration Create: description: AAA Configuration Create value: authOrder: - radius - tacacs - local authFallback: true adminAuthOrder: true auditDisable: false accounting: true required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error put: tags: - Administration - User and Group description: 'Update aaa configuration


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.' operationId: updateAaaConfig requestBody: description: aaa content: application/json: schema: type: object properties: accounting: type: boolean description: Enable accounting to track user sessions and command execution for auditing purposes adminAuthOrder: type: boolean description: Enable separate authentication order for administrative users auditDisable: type: boolean description: Disable audit logging for authentication and authorization events authFallback: type: boolean description: Enable authentication fallback to local user database when external authentication servers are unreachable authOrder: maxItems: 3 minItems: 1 type: array description: Ordered list of authentication methods to be used for user login (e.g., local, radius, tacacs). Minimum 1, maximum 3 authentication methods allowed. items: type: string description: Ordered list of authentication methods to be used for user login (e.g., local, radius, tacacs). Minimum 1, maximum 3 authentication methods allowed. enum: - local - radius - tacacs description: AAA configuration $$ref: '#/components/schemas/Aaa' examples: AAA Configuration Update: description: AAA Configuration Update value: authOrder: - radius - tacacs - local authFallback: true adminAuthOrder: true auditDisable: false accounting: true required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error delete: tags: - Administration - User and Group description: 'Delete aaa configuration


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.' operationId: deleteAaaConfig responses: '200': description: Ok content: application/json: schema: type: object examples: Delete Success Response: description: Delete Success Response value: authOrder: - local - radius authFallback: true adminAuthOrder: false auditDisable: false accounting: true '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /admin/events/{sseSessionId}: get: tags: - Administration - User and Group operationId: listenAuthEvents parameters: - name: sseSessionId in: path description: sse session Id required: true schema: type: string responses: default: description: default response content: text/event-stream: {} /admin/radius: delete: tags: - Administration - User and Group description: 'Delete radius configuration


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.' operationId: deleteRadiusConfig responses: '200': description: Ok content: application/json: schema: type: object properties: retransmit: maximum: 1000 minimum: 1 type: integer description: Configure how many times to contact each RADIUS server format: int32 example: 3 default: 3 server: maxItems: 8 minItems: 0 type: array description: RADIUS server configuration items: required: - address - secretKey type: object properties: acctPort: maximum: 65535 minimum: 0 type: integer description: Accounting Port format: int32 example: 1813 default: 1813 address: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set IP address of RADIUS server example: 1.2.2.2 authPort: maximum: 65535 minimum: 0 type: integer description: Authentication Port format: int32 example: 1812 default: 1812 priority: maximum: 7 minimum: 0 type: integer description: Priority format: int32 example: 1 default: 0 secretKey: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{1,128})$ type: string description: Secret key example: password tag: maxLength: 16 minLength: 4 pattern: ^[a-zA-Z0-9\-_]*$ type: string description: Reference tag/name for the server example: radius-server1 vpn: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: Configure the RADIUS server $$ref: '#/components/schemas/ControlComponentAaaRadiusServer' timeout: maximum: 1000 minimum: 1 type: integer description: Configure how long to wait for replies from the RADIUS server format: int32 example: 5 default: 5 description: Radius configuration $$ref: '#/components/schemas/Radius' examples: RADIUS Delete Success Response: description: RADIUS Delete Success Response value: timeout: 5 retransmit: 3 server: - address: 192.168.1.100 authPort: 1812 acctPort: 1813 sourceVpn: 0 vpn: 0 vpnIpSubnet: 192.168.1.0/24 key: radius-key secretKey: shared-secret priority: 1 '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error post: tags: - Administration - User and Group description: 'Create radius configuration


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.' operationId: createRadiusConfig requestBody: description: radius content: application/json: schema: type: object properties: retransmit: maximum: 1000 minimum: 1 type: integer description: Configure how many times to contact each RADIUS server format: int32 example: 3 default: 3 server: maxItems: 8 minItems: 0 type: array description: RADIUS server configuration items: required: - address - secretKey type: object properties: acctPort: maximum: 65535 minimum: 0 type: integer description: Accounting Port format: int32 example: 1813 default: 1813 address: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set IP address of RADIUS server example: 1.2.2.2 authPort: maximum: 65535 minimum: 0 type: integer description: Authentication Port format: int32 example: 1812 default: 1812 priority: maximum: 7 minimum: 0 type: integer description: Priority format: int32 example: 1 default: 0 secretKey: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{1,128})$ type: string description: Secret key example: password tag: maxLength: 16 minLength: 4 pattern: ^[a-zA-Z0-9\-_]*$ type: string description: Reference tag/name for the server example: radius-server1 vpn: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: Configure the RADIUS server $$ref: '#/components/schemas/ControlComponentAaaRadiusServer' timeout: maximum: 1000 minimum: 1 type: integer description: Configure how long to wait for replies from the RADIUS server format: int32 example: 5 default: 5 description: Radius configuration $$ref: '#/components/schemas/Radius' examples: RADIUS Configuration Create: description: RADIUS Configuration Create value: timeout: 10 retransmit: 5 server: - address: 192.168.1.100 authPort: 1812 acctPort: 1813 sourceVpn: 0 vpn: 0 vpnIpSubnet: 192.168.1.0/24 key: radius-key secretKey: updated-secret priority: 1 - address: 192.168.1.101 authPort: 1812 acctPort: 1813 sourceVpn: 0 vpn: 0 vpnIpSubnet: 192.168.2.0/24 key: radius-key-2 secretKey: backup-secret priority: 2 required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error put: tags: - Administration - User and Group description: 'Update radius configuration


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.' operationId: updateRadiusConfig requestBody: description: radius content: application/json: schema: type: object properties: retransmit: maximum: 1000 minimum: 1 type: integer description: Configure how many times to contact each RADIUS server format: int32 example: 3 default: 3 server: maxItems: 8 minItems: 0 type: array description: RADIUS server configuration items: required: - address - secretKey type: object properties: acctPort: maximum: 65535 minimum: 0 type: integer description: Accounting Port format: int32 example: 1813 default: 1813 address: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set IP address of RADIUS server example: 1.2.2.2 authPort: maximum: 65535 minimum: 0 type: integer description: Authentication Port format: int32 example: 1812 default: 1812 priority: maximum: 7 minimum: 0 type: integer description: Priority format: int32 example: 1 default: 0 secretKey: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{1,128})$ type: string description: Secret key example: password tag: maxLength: 16 minLength: 4 pattern: ^[a-zA-Z0-9\-_]*$ type: string description: Reference tag/name for the server example: radius-server1 vpn: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: Configure the RADIUS server $$ref: '#/components/schemas/ControlComponentAaaRadiusServer' timeout: maximum: 1000 minimum: 1 type: integer description: Configure how long to wait for replies from the RADIUS server format: int32 example: 5 default: 5 description: Radius configuration $$ref: '#/components/schemas/Radius' examples: RADIUS Configuration Update: description: RADIUS Configuration Update value: timeout: 10 retransmit: 5 server: - address: 192.168.1.100 authPort: 1812 acctPort: 1813 sourceVpn: 0 vpn: 0 vpnIpSubnet: 192.168.1.0/24 key: radius-key secretKey: updated-secret priority: 1 - address: 192.168.1.101 authPort: 1812 acctPort: 1813 sourceVpn: 0 vpn: 0 vpnIpSubnet: 192.168.2.0/24 key: radius-key-2 secretKey: backup-secret priority: 2 required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error get: tags: - Administration - User and Group description: 'Get radius configuration


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.' operationId: getRadiusConfig responses: '200': description: Ok content: application/json: schema: type: object properties: retransmit: maximum: 1000 minimum: 1 type: integer description: Configure how many times to contact each RADIUS server format: int32 example: 3 default: 3 server: maxItems: 8 minItems: 0 type: array description: RADIUS server configuration items: required: - address - secretKey type: object properties: acctPort: maximum: 65535 minimum: 0 type: integer description: Accounting Port format: int32 example: 1813 default: 1813 address: pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))) type: string description: Set IP address of RADIUS server example: 1.2.2.2 authPort: maximum: 65535 minimum: 0 type: integer description: Authentication Port format: int32 example: 1812 default: 1812 priority: maximum: 7 minimum: 0 type: integer description: Priority format: int32 example: 1 default: 0 secretKey: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{1,128})$ type: string description: Secret key example: password tag: maxLength: 16 minLength: 4 pattern: ^[a-zA-Z0-9\-_]*$ type: string description: Reference tag/name for the server example: radius-server1 vpn: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: Configure the RADIUS server $$ref: '#/components/schemas/ControlComponentAaaRadiusServer' timeout: maximum: 1000 minimum: 1 type: integer description: Configure how long to wait for replies from the RADIUS server format: int32 example: 5 default: 5 description: Radius configuration $$ref: '#/components/schemas/Radius' examples: RADIUS Configuration Response: description: RADIUS Configuration Response value: timeout: 5 retransmit: 3 server: - address: 192.168.1.100 authPort: 1812 acctPort: 1813 sourceVpn: 0 vpn: 0 vpnIpSubnet: 192.168.1.0/24 key: radius-key secretKey: shared-secret priority: 1 '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /admin/tacacs: delete: tags: - Administration - User and Group description: 'Delete tacacs configuration


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.' operationId: deleteTacacsConfig responses: '200': description: Ok content: application/json: schema: type: object properties: authentication: type: string description: TACACS authentication type enum: - pap - ascii default: pap servers: maxItems: 8 minItems: 0 type: array description: List of TACACS servers items: required: - address - secretKey type: object properties: acctPort: maximum: 65535 minimum: 0 type: integer description: Accounting Port format: int32 default: 49 address: type: string description: Set IP address of TACACS server example: 1.2.2.2 authPort: maximum: 65535 minimum: 0 type: integer description: Authentication Port format: int32 default: 49 priority: maximum: 7 minimum: 0 type: integer description: TACACS server priority <0..7> format: int32 example: 1 default: 0 secretKey: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{1,128})$ type: string description: TACACS server password example: Password123 vpn: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: Configure the TACACS server $$ref: '#/components/schemas/TacacsServer' timeout: maximum: 1000 minimum: 1 type: integer description: Configure how long to wait for replies from the TACACS server format: int32 default: 5 description: TACACS configuration $$ref: '#/components/schemas/Tacacs' examples: TACACS+ Delete Success Response: description: TACACS+ Delete Success Response value: timeout: 5 authentication: ascii server: - address: 192.168.1.200 authPort: 49 sourceVpn: 0 vpn: 0 vpnIpSubnet: 192.168.1.0/24 key: tacacs-key secretKey: tacacs-shared-secret priority: 1 '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error get: tags: - Administration - User and Group description: 'Get tacacs configuration


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.' operationId: getTacacsConfig responses: '200': description: Ok content: application/json: schema: type: object properties: authentication: type: string description: TACACS authentication type enum: - pap - ascii default: pap servers: maxItems: 8 minItems: 0 type: array description: List of TACACS servers items: required: - address - secretKey type: object properties: acctPort: maximum: 65535 minimum: 0 type: integer description: Accounting Port format: int32 default: 49 address: type: string description: Set IP address of TACACS server example: 1.2.2.2 authPort: maximum: 65535 minimum: 0 type: integer description: Authentication Port format: int32 default: 49 priority: maximum: 7 minimum: 0 type: integer description: TACACS server priority <0..7> format: int32 example: 1 default: 0 secretKey: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{1,128})$ type: string description: TACACS server password example: Password123 vpn: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: Configure the TACACS server $$ref: '#/components/schemas/TacacsServer' timeout: maximum: 1000 minimum: 1 type: integer description: Configure how long to wait for replies from the TACACS server format: int32 default: 5 description: TACACS configuration $$ref: '#/components/schemas/Tacacs' examples: TACACS Configuration Response: description: TACACS Configuration Response value: timeout: 5 authentication: ascii server: - address: 192.168.1.200 authPort: 49 sourceVpn: 0 vpn: 0 vpnIpSubnet: 192.168.1.0/24 key: tacacs-key secretKey: tacacs-shared-secret priority: 1 '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error put: tags: - Administration - User and Group description: 'Update tacacs configuration


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.' operationId: updateTacacsConfig requestBody: description: tacacs content: application/json: schema: type: object properties: authentication: type: string description: TACACS authentication type enum: - pap - ascii default: pap servers: maxItems: 8 minItems: 0 type: array description: List of TACACS servers items: required: - address - secretKey type: object properties: acctPort: maximum: 65535 minimum: 0 type: integer description: Accounting Port format: int32 default: 49 address: type: string description: Set IP address of TACACS server example: 1.2.2.2 authPort: maximum: 65535 minimum: 0 type: integer description: Authentication Port format: int32 default: 49 priority: maximum: 7 minimum: 0 type: integer description: TACACS server priority <0..7> format: int32 example: 1 default: 0 secretKey: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{1,128})$ type: string description: TACACS server password example: Password123 vpn: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: Configure the TACACS server $$ref: '#/components/schemas/TacacsServer' timeout: maximum: 1000 minimum: 1 type: integer description: Configure how long to wait for replies from the TACACS server format: int32 default: 5 description: TACACS configuration $$ref: '#/components/schemas/Tacacs' examples: TACACS+ Configuration: description: TACACS+ Configuration value: timeout: 5 authentication: ascii server: - address: 192.168.1.200 authPort: 49 sourceVpn: 0 vpn: 0 vpnIpSubnet: 192.168.1.0/24 key: tacacs-key secretKey: tacacs-shared-secret priority: 1 required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error post: tags: - Administration - User and Group description: 'Create tacacs configuration


Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.' operationId: createTacacsConfig requestBody: description: tacacs content: application/json: schema: type: object properties: authentication: type: string description: TACACS authentication type enum: - pap - ascii default: pap servers: maxItems: 8 minItems: 0 type: array description: List of TACACS servers items: required: - address - secretKey type: object properties: acctPort: maximum: 65535 minimum: 0 type: integer description: Accounting Port format: int32 default: 49 address: type: string description: Set IP address of TACACS server example: 1.2.2.2 authPort: maximum: 65535 minimum: 0 type: integer description: Authentication Port format: int32 default: 49 priority: maximum: 7 minimum: 0 type: integer description: TACACS server priority <0..7> format: int32 example: 1 default: 0 secretKey: pattern: ^(?:\$CRYPT\$.{17}|(?!(?:\$CRYPT\$)).{1,128})$ type: string description: TACACS server password example: Password123 vpn: type: integer description: VPN ID format: int32 example: 0 enum: - 0 - 512 default: 0 description: Configure the TACACS server $$ref: '#/components/schemas/TacacsServer' timeout: maximum: 1000 minimum: 1 type: integer description: Configure how long to wait for replies from the TACACS server format: int32 default: 5 description: TACACS configuration $$ref: '#/components/schemas/Tacacs' examples: TACACS+ Configuration: description: TACACS+ Configuration value: timeout: 5 authentication: ascii server: - address: 192.168.1.200 authPort: 49 sourceVpn: 0 vpn: 0 vpnIpSubnet: 192.168.1.0/24 key: tacacs-key secretKey: tacacs-shared-secret priority: 1 required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /admin/user: get: tags: - Administration - User and Group description: Get all users operationId: findUsers_AdministrationUserGroup_1103 responses: '200': description: Success content: application/json: schema: type: array items: type: object examples: User: description: User value: [] '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Manage Users-read,Manage Users-write post: tags: - Administration - User and Group description: Create a user operationId: createUser_AdministrationUserGroup_1104 requestBody: description: User content: application/json: schema: type: object examples: User: description: User value: group: - demogrp description: Demo User userName: demouser password: password locale: en_US resGroupName: global required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Manage Users-write /admin/user/activeSessions: get: tags: - Administration - User and Group description: Get active sessions operationId: getActiveSessions_AdministrationUserGroup_2603 responses: '200': description: Success content: application/json: schema: type: object examples: All active sessions for this tenant (except for the requesting session): description: All active sessions for this tenant (except for the requesting session) value: {} '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Manage Users-read /admin/user/admin/password: post: tags: - Administration - User and Group description: Update admin default password operationId: updateAdminPassword_AdministrationUserGroup_2604 requestBody: description: User content: application/json: schema: type: object examples: User: description: User value: {} required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /admin/user/lockUser/{userName}: put: tags: - Administration - User and Group description: Lock a user account operationId: lockUser parameters: - name: userName in: path description: User name to lock required: true schema: type: string requestBody: description: User content: application/json: schema: type: object examples: Lock user account: description: Lock user account value: {} required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error deprecated: true x-roles-required: Manage Users-write /admin/user/password/validate: post: tags: - Administration - User and Group description: Validate user password operationId: validatePassword_AdministrationUserGroup_2904 requestBody: description: User password content: application/json: schema: type: object examples: User password: description: User password value: {} required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error deprecated: true x-roles-required: Manage Users-read /admin/user/password/{userName}: put: tags: - Administration - User and Group description: Update user password operationId: updatePassword_AdministrationUserGroup_3103 parameters: - name: userName in: path description: User name required: true schema: type: string requestBody: description: User content: application/json: schema: type: object examples: User: description: User value: {} required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Manage Users-write /admin/user/profile/locale: put: tags: - Administration - User and Group description: Update profile locale operationId: updateProfileLocale_AdministrationUserGroup_2603 requestBody: description: User content: application/json: schema: type: object examples: User: description: User value: {} required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: default /admin/user/profile/password: put: tags: - Administration - User and Group description: Update profile password operationId: updateProfilePassword_AdministrationUserGroup_2803 requestBody: description: User content: application/json: schema: type: object examples: User: description: User value: {} required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: default /admin/user/removeSessions: delete: tags: - Administration - User and Group description: Remove sessions operationId: removeSessions_AdministrationUserGroup_2606 requestBody: description: User content: application/json: schema: type: array items: type: object examples: List of sessions: description: List of sessions value: [] responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Manage Users-write /admin/user/reset: post: tags: - Administration - User and Group description: Unlock a user operationId: resetUser_AdministrationUserGroup_1704 requestBody: description: User content: application/json: schema: type: object examples: User: description: User value: {} required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Manage Users-write /admin/user/role: get: tags: - Administration - User and Group description: Check whether a user has admin role operationId: findUserRole_AdministrationUserGroup_1603 responses: '200': description: Success content: application/json: schema: type: object examples: User has admin role: description: User has admin role value: isAdmin: true '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Manage Users-read,Manage Users-write,Device Monitoring-read,Device Monitoring-write,System-read,System-write /admin/user/userAuthType: get: tags: - Administration - User and Group description: Find user authentication type, whether it is SAML enabled operationId: findUserAuthType_AdministrationUserGroup_2403 responses: '200': description: Success content: application/json: schema: type: object examples: User authentication type: description: User authentication type value: userAuthType: SAML '403': description: Forbidden '500': description: Internal Server Error x-roles-required: default /admin/user/{userName}: put: tags: - Administration - User and Group description: Update user operationId: updateUser_AdministrationUserGroup_2203 parameters: - name: userName in: path description: User name required: true schema: type: string requestBody: description: User content: application/json: schema: type: object examples: User: description: User value: userName: demouser password: newpasswd required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Manage Users-write delete: tags: - Administration - User and Group description: Delete user operationId: deleteUser_AdministrationUserGroup_2206 parameters: - name: userName in: path description: User name required: true schema: type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Manage Users-write /admin/usergroup: get: tags: - Administration - User and Group description: Get all user groups operationId: findUserGroups responses: '200': description: Success content: application/json: schema: type: array items: type: object examples: User groups: description: User groups value: [] '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Manage Users-read,Manage Users-write post: tags: - Administration - User and Group description: Create user group operationId: createUserGroup requestBody: description: User group content: application/json: schema: type: object examples: User group: description: User group value: groupName: demogrp groupDesc: user group description tasks: - feature: Interface read: true enabled: true write: true - feature: Routing read: true enabled: true write: true - feature: Security read: true enabled: true write: true - feature: System read: true enabled: true write: true - feature: Policy read: true enabled: true write: true - feature: Alarms read: true enabled: true write: true - feature: Audit Log read: true enabled: true write: true - feature: Device Monitoring read: true enabled: true write: true - feature: RBAC VPN read: true enabled: true write: true - feature: Certificates read: true enabled: true write: true - feature: Device Inventory read: true enabled: true write: true - feature: Template Configuration read: true enabled: true write: true - feature: Template Deploy read: true enabled: true write: true - feature: Policy Configuration read: true enabled: true write: true - feature: Security Policy Configuration read: true enabled: true write: true - feature: Policy Deploy read: true enabled: true write: true - feature: Cloud OnRamp read: true enabled: true write: true - feature: Software Upgrade read: true enabled: true write: true - feature: Device Reboot read: true enabled: true write: true - feature: Manage Users read: true enabled: true write: true - feature: Tools read: true enabled: true write: true - feature: Settings read: true enabled: true write: true - feature: Cluster read: true enabled: true write: true - feature: Colocation read: true enabled: true write: true - feature: vAnalytics read: true enabled: true write: true - feature: Events read: true enabled: true write: true required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Manage Users-write /admin/usergroup/definition: get: tags: - Administration - User and Group description: Get user groups in a grid table operationId: createGroupGridColumns responses: '200': description: Success content: application/json: schema: type: object examples: User group in grid table: description: User group in grid table value: {} '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Manage Users-read,Manage Users-write /admin/usergroup/keyvalue: get: tags: - Administration - User and Group description: Get user groups as key value map operationId: findUserGroupsAsKeyValue responses: '200': description: Success content: application/json: schema: type: array items: type: object examples: Map of user groups: description: Map of user groups value: [] '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Manage Users-read,Manage Users-write /admin/usergroup/{userGroupId}: delete: tags: - Administration - User and Group description: Delete user group operationId: deleteUserGroup parameters: - name: userGroupId in: path description: User group Id required: true schema: type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Manage Users-write put: tags: - Administration - User and Group description: Update user group operationId: updateUserGroup parameters: - name: userGroupId in: path description: User group Id required: true schema: type: string requestBody: description: User group content: application/json: schema: type: object examples: User group: description: User group value: groupName: demogrp groupDesc: user group description tasks: - feature: Policy enabled: true read: true write: false - feature: Routing enabled: true read: true write: false - feature: Security enabled: true read: true write: false - feature: Interface enabled: true read: true write: false - feature: System enabled: true read: true write: false - feature: Alarms enabled: true read: true write: false - feature: Audit Log enabled: true read: true write: false - feature: Certificates enabled: true read: true write: false - feature: Cloud OnRamp enabled: true read: true write: false - feature: Cluster enabled: true read: true write: false - feature: Colocation enabled: true read: true write: false - feature: Device Inventory enabled: true read: true write: false - feature: Device Monitoring enabled: true read: true write: false - feature: Device Reboot enabled: true read: true write: false - feature: Events enabled: true read: true write: false - feature: Manage Users enabled: true read: true write: false - feature: Policy Configuration enabled: true read: true write: false - feature: Policy Deploy enabled: true read: true write: false - feature: RBAC VPN enabled: true read: true write: false - feature: Security Policy Configuration enabled: true read: true write: false - feature: Settings enabled: true read: true write: false - feature: Software Upgrade enabled: true read: true write: false - feature: Template Configuration enabled: true read: true write: false - feature: Template Deploy enabled: true read: true write: false - feature: Tools enabled: true read: true write: false - feature: vAnalytics enabled: true read: true write: false required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Manage Users-write /admin/vpngroup: post: tags: - Administration - User and Group description: Add VPN group operationId: createVpnGroup requestBody: description: VPN group content: application/json: schema: type: object examples: VPN group: description: VPN group value: rbacRequired: true userGroupName: demo name: VPNGroup description: Sample segments: - c952c18b-30b3-4f0b-b985-494693d7adfb required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: RBAC VPN-write get: tags: - Administration - User and Group description: Get VPN groups operationId: getVpnGroups responses: '200': description: Success content: application/json: schema: type: array items: type: object examples: VPN groups: description: VPN groups value: - name: VPNGroup vpnGroupId: 34bb9532-60bd-464b-bb35-393f7bac5e56 description: Sample owner: admin lastUpdated: 1590190679126 segments: - c952c18b-30b3-4f0b-b985-494693d7adfb hasRbacGroup: true userGroupName: demo '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: RBAC VPN-read,RBAC VPN-write /admin/vpngroup/{id}: put: tags: - Administration - User and Group description: Update VPN group operationId: editVpnGroup parameters: - name: id in: path description: VPN group Id required: true schema: type: string requestBody: description: VPN group content: application/json: schema: type: object examples: VPN group: description: VPN group value: rbacRequired: true userGroupName: demo name: VPNGroup description: Sample vpnGroupId: 34bb9532-60bd-464b-bb35-393f7bac5e56 segments: - c952c18b-30b3-4f0b-b985-494693d7adfb - 64b30b74-08e2-4b4b-81ca-d019c7e452d5 required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: RBAC VPN-write delete: tags: - Administration - User and Group description: Delete VPN group operationId: deleteVpnGroup parameters: - name: id in: path description: VPN group Id required: true schema: type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: RBAC VPN-write