openapi: 3.2.0 info: title: Cisco Ise Activedirectory API x-evidence: - type: source url: https://pubhub.devnetcloud.com/media/identity-services-engine-api-v1/docs/ - type: source url: https://developer.cisco.com/docs/identity-services-engine/ x-provenance: method: harvested authored_by: Cisco harvested_by: API Evangelist harvested_on: '2026-08-19' first_party: true provider_published: true source_host: pubhub.devnetcloud.com note: 103 ISE API descriptions (1,490 operations; 32 OpenAPI 3.0.x + 71 Swagger 2.0) enumerated from Cisco's own DevNet project manifest and fetched anonymously. Byte-identity reconfirmed 2026-08-19 by SHA-256 against the live source. version: '1.0' description: 'Operations tagged activedirectory across 2 of this provider''s published API definitions: cisco-ise-ers-open-api-ers-apis.yaml, cisco-ise-legacy-ers-active-directory.yaml. Each path carries the servers of the definition it was published in.' servers: - url: https://{server}:{port}/ers/config description: Append /ctsapi/v2 or /ctsapi/v3 to above URL while accessing CTS APIs variables: server: description: The host where the API is rooted default: localhost port: description: The port no for CTS APIs is 9063 and for other APIs it is 443 default: '443' tags: - name: Active Directory paths: /activedirectory/: get: tags: - Active Directory summary: Get all join points parameters: - name: filter in: query description: Filter Supported Fields:[name] required: false allowReserved: true schema: type: string example: toDate.CONTAINS.SEP - $ref: '#/components/parameters/ppage' - $ref: '#/components/parameters/psize' - name: sortdsc in: query description: Sorting Supported Fields:[name] required: false allowReserved: true schema: example: null enum: - name - name: sortasc in: query description: Sorting Supported Fields:[name] required: false allowReserved: true schema: example: null enum: - name responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/activedirectoryListResponse' application/xml: schema: $ref: '#/components/schemas/activedirectoryListResponse' text/html: schema: type: string example: null '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '406': description: Not Acceptable '415': description: UnSupported Media Type content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null security: - HTTPBasicAuthentication: [] operationId: getActivedirectory x-operation-id-source: derived post: tags: - Active Directory summary: Create join point parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/identitystores.activedirectory' example: ERSActiveDirectory: adScopesNames: Default_Scope enableDomainAllowedList: true advancedSettings: authProtectionType: WIRELESS schema: ACTIVE_DIRECTORY lastName: sn country: co enableFailedAuthProtection: false jobTitle: title agingTime: 5 identityNotInAdBehaviour: SEARCH_JOINED_FOREST department: department unreachableDomainsBehaviour: PROCEED email: mail organizationalUnit: company enableDialinPermissionCheck: false enablePassChange: false plaintextAuth: false locality: l enableMachineAccess: true enableRewrites: false telephone: telephoneNumber enableCallbackForDialinClient: false enableAuthorizationFlow: false sshKeysAttributeName: sshPublicKey firstName: givenName stateOrProvince: st failedAuthThreshold: 5 streetAddress: streetAddress enableMachineAuth: true enableSessionStitching: false rewriteRules: - rewriteMatch: exampleMatch0 rewriteResult: exampleResult0 rowId: 0 - rewriteMatch: exampleMatch1 rewriteResult: exampleResult1 rowId: 1 - rewriteMatch: exampleMatch2 rewriteResult: exampleResult2 rowId: 2 - rewriteMatch: exampleMatch3 rewriteResult: exampleResult3 rowId: 3 domain: cisco.com name: Company_users description: Group of Active company users adgroups: groups: - name: cisco.com/operators type: GLOBAL sid: S-1-5-32-548 - name: cisco.com/office users type: DOMAIN LOCAL sid: S-1-5-33-326 id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b adAttributes: attributes: - internalName: internalName1 defaultValue: defaultString name: name1 type: STRING - internalName: internalName2 defaultValue: 1.1.1.1 name: name2 type: IP - internalName: internalName3 defaultValue: 'true' name: name3 type: BOOLEAN - internalName: internalName4 defaultValue: '5' name: name4 type: INT - internalName: internalName5 defaultValue: defaultOctetString name: name5 type: OCTET_STRING required: true responses: '201': description: Created '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '406': description: Not Acceptable '415': description: UnSupported Media Type content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '500': description: Internal Server Error security: - HTTPBasicAuthentication: [] operationId: postActivedirectory x-operation-id-source: derived servers: - url: https://{server}:{port}/ers/config description: Append /ctsapi/v2 or /ctsapi/v3 to above URL while accessing CTS APIs variables: server: description: The host where the API is rooted default: localhost port: description: The port no for CTS APIs is 9063 and for other APIs it is 443 default: '443' /activedirectory/{id}/passiveIdSettings: put: tags: - Active Directory summary: Updates passive ID settings parameters: - name: id in: path required: true schema: title: id type: string example: null requestBody: content: application/json: schema: $ref: '#/components/schemas/identitystores.activedirectory' example: ERSActiveDirectory: adScopesNames: Default_Scope enableDomainAllowedList: true advancedSettings: authProtectionType: WIRELESS schema: ACTIVE_DIRECTORY lastName: sn country: co enableFailedAuthProtection: false jobTitle: title agingTime: 5 identityNotInAdBehaviour: SEARCH_JOINED_FOREST department: department unreachableDomainsBehaviour: PROCEED email: mail organizationalUnit: company enableDialinPermissionCheck: false enablePassChange: false plaintextAuth: false locality: l enableMachineAccess: true enableRewrites: false telephone: telephoneNumber enableCallbackForDialinClient: false enableAuthorizationFlow: false sshKeysAttributeName: sshPublicKey firstName: givenName stateOrProvince: st failedAuthThreshold: 5 streetAddress: streetAddress enableMachineAuth: true enableSessionStitching: false rewriteRules: - rewriteMatch: exampleMatch0 rewriteResult: exampleResult0 rowId: 0 - rewriteMatch: exampleMatch1 rewriteResult: exampleResult1 rowId: 1 - rewriteMatch: exampleMatch2 rewriteResult: exampleResult2 rowId: 2 - rewriteMatch: exampleMatch3 rewriteResult: exampleResult3 rowId: 3 domain: cisco.com name: Company_users description: Group of Active company users adgroups: groups: - name: cisco.com/operators type: GLOBAL sid: S-1-5-32-548 - name: cisco.com/office users type: DOMAIN LOCAL sid: S-1-5-33-326 id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b adAttributes: attributes: - internalName: internalName1 defaultValue: defaultString name: name1 type: STRING - internalName: internalName2 defaultValue: 1.1.1.1 name: name2 type: IP - internalName: internalName3 defaultValue: 'true' name: name3 type: BOOLEAN - internalName: internalName4 defaultValue: '5' name: name4 type: INT - internalName: internalName5 defaultValue: defaultOctetString name: name5 type: OCTET_STRING required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/UpdatedFieldsResponse' application/xml: schema: $ref: '#/components/schemas/UpdatedFieldsResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '406': description: Not Acceptable '415': description: UnSupported Media Type content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '500': description: Internal Server Error response content: application/json: schema: $ref: '#/components/schemas/ERSResponse' security: - HTTPBasicAuthentication: [] operationId: putActivedirectoryByIdPassiveIdSettings x-operation-id-source: derived servers: - url: https://{server}:{port}/ers/config description: Append /ctsapi/v2 or /ctsapi/v3 to above URL while accessing CTS APIs variables: server: description: The host where the API is rooted default: localhost port: description: The port no for CTS APIs is 9063 and for other APIs it is 443 default: '443' /activedirectory/{id}/addGroups: put: tags: - Active Directory summary: Load groups from domain parameters: - name: id in: path required: true schema: title: id type: string example: null requestBody: content: application/json: schema: $ref: '#/components/schemas/identitystores.activedirectory' example: ERSActiveDirectory: adScopesNames: Default_Scope enableDomainAllowedList: true advancedSettings: authProtectionType: WIRELESS schema: ACTIVE_DIRECTORY lastName: sn country: co enableFailedAuthProtection: false jobTitle: title agingTime: 5 identityNotInAdBehaviour: SEARCH_JOINED_FOREST department: department unreachableDomainsBehaviour: PROCEED email: mail organizationalUnit: company enableDialinPermissionCheck: false enablePassChange: false plaintextAuth: false locality: l enableMachineAccess: true enableRewrites: false telephone: telephoneNumber enableCallbackForDialinClient: false enableAuthorizationFlow: false sshKeysAttributeName: sshPublicKey firstName: givenName stateOrProvince: st failedAuthThreshold: 5 streetAddress: streetAddress enableMachineAuth: true enableSessionStitching: false rewriteRules: - rewriteMatch: exampleMatch0 rewriteResult: exampleResult0 rowId: 0 - rewriteMatch: exampleMatch1 rewriteResult: exampleResult1 rowId: 1 - rewriteMatch: exampleMatch2 rewriteResult: exampleResult2 rowId: 2 - rewriteMatch: exampleMatch3 rewriteResult: exampleResult3 rowId: 3 domain: cisco.com name: Company_users description: Group of Active company users adgroups: groups: - name: cisco.com/operators type: GLOBAL sid: S-1-5-32-548 - name: cisco.com/office users type: DOMAIN LOCAL sid: S-1-5-33-326 id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b adAttributes: attributes: - internalName: internalName1 defaultValue: defaultString name: name1 type: STRING - internalName: internalName2 defaultValue: 1.1.1.1 name: name2 type: IP - internalName: internalName3 defaultValue: 'true' name: name3 type: BOOLEAN - internalName: internalName4 defaultValue: '5' name: name4 type: INT - internalName: internalName5 defaultValue: defaultOctetString name: name5 type: OCTET_STRING required: true responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '406': description: Not Acceptable '415': description: UnSupported Media Type content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '500': description: Internal Server Error response content: application/json: schema: $ref: '#/components/schemas/ERSResponse' security: - HTTPBasicAuthentication: [] operationId: putActivedirectoryByIdAddGroups x-operation-id-source: derived servers: - url: https://{server}:{port}/ers/config description: Append /ctsapi/v2 or /ctsapi/v3 to above URL while accessing CTS APIs variables: server: description: The host where the API is rooted default: localhost port: description: The port no for CTS APIs is 9063 and for other APIs it is 443 default: '443' /activedirectory/{id}/getUserGroups: put: tags: - Active Directory summary: Get user groups parameters: - name: id in: path required: true schema: title: id type: string example: null requestBody: content: application/json: schema: $ref: '#/components/schemas/OperationAdditionalDataEntity' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ersActiveDirectoryGroupsResponse' application/xml: schema: $ref: '#/components/schemas/ersActiveDirectoryGroupsResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '406': description: Not Acceptable '415': description: UnSupported Media Type content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '500': description: Internal Server Error response content: application/json: schema: $ref: '#/components/schemas/ERSResponse' security: - HTTPBasicAuthentication: [] operationId: putActivedirectoryByIdGetUserGroups x-operation-id-source: derived servers: - url: https://{server}:{port}/ers/config description: Append /ctsapi/v2 or /ctsapi/v3 to above URL while accessing CTS APIs variables: server: description: The host where the API is rooted default: localhost port: description: The port no for CTS APIs is 9063 and for other APIs it is 443 default: '443' /activedirectory/name/{name}: get: tags: - Active Directory summary: Get-By-Name parameters: - name: name in: path required: true schema: title: name type: string example: null responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/activedirectoryResponse' application/xml: schema: $ref: '#/components/schemas/activedirectoryResponse' text/html: schema: type: string example: null '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '406': description: Not Acceptable '415': description: UnSupported Media Type content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null security: - HTTPBasicAuthentication: [] operationId: getActivedirectoryNameByName x-operation-id-source: derived servers: - url: https://{server}:{port}/ers/config description: Append /ctsapi/v2 or /ctsapi/v3 to above URL while accessing CTS APIs variables: server: description: The host where the API is rooted default: localhost port: description: The port no for CTS APIs is 9063 and for other APIs it is 443 default: '443' /activedirectory/{id}/getTrustedDomains: put: tags: - Active Directory summary: Get trusted domains parameters: - name: id in: path required: true schema: title: id type: string example: null responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ersActiveDirectoryDomainsResponse' application/xml: schema: $ref: '#/components/schemas/ersActiveDirectoryDomainsResponse' text/html: schema: type: string example: null '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '406': description: Not Acceptable '415': description: UnSupported Media Type content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '500': description: Internal Server Error response content: application/json: schema: $ref: '#/components/schemas/ERSResponse' security: - HTTPBasicAuthentication: [] operationId: putActivedirectoryByIdGetTrustedDomains x-operation-id-source: derived servers: - url: https://{server}:{port}/ers/config description: Append /ctsapi/v2 or /ctsapi/v3 to above URL while accessing CTS APIs variables: server: description: The host where the API is rooted default: localhost port: description: The port no for CTS APIs is 9063 and for other APIs it is 443 default: '443' /activedirectory/{id}/leaveAllNodes: put: tags: - Active Directory summary: Leave a domain with all nodes parameters: - name: id in: path required: true schema: title: id type: string example: null requestBody: content: application/json: schema: $ref: '#/components/schemas/identitystores.activedirectory' example: ERSActiveDirectory: adScopesNames: Default_Scope enableDomainAllowedList: true advancedSettings: authProtectionType: WIRELESS schema: ACTIVE_DIRECTORY lastName: sn country: co enableFailedAuthProtection: false jobTitle: title agingTime: 5 identityNotInAdBehaviour: SEARCH_JOINED_FOREST department: department unreachableDomainsBehaviour: PROCEED email: mail organizationalUnit: company enableDialinPermissionCheck: false enablePassChange: false plaintextAuth: false locality: l enableMachineAccess: true enableRewrites: false telephone: telephoneNumber enableCallbackForDialinClient: false enableAuthorizationFlow: false sshKeysAttributeName: sshPublicKey firstName: givenName stateOrProvince: st failedAuthThreshold: 5 streetAddress: streetAddress enableMachineAuth: true enableSessionStitching: false rewriteRules: - rewriteMatch: exampleMatch0 rewriteResult: exampleResult0 rowId: 0 - rewriteMatch: exampleMatch1 rewriteResult: exampleResult1 rowId: 1 - rewriteMatch: exampleMatch2 rewriteResult: exampleResult2 rowId: 2 - rewriteMatch: exampleMatch3 rewriteResult: exampleResult3 rowId: 3 domain: cisco.com name: Company_users description: Group of Active company users adgroups: groups: - name: cisco.com/operators type: GLOBAL sid: S-1-5-32-548 - name: cisco.com/office users type: DOMAIN LOCAL sid: S-1-5-33-326 id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b adAttributes: attributes: - internalName: internalName1 defaultValue: defaultString name: name1 type: STRING - internalName: internalName2 defaultValue: 1.1.1.1 name: name2 type: IP - internalName: internalName3 defaultValue: 'true' name: name3 type: BOOLEAN - internalName: internalName4 defaultValue: '5' name: name4 type: INT - internalName: internalName5 defaultValue: defaultOctetString name: name5 type: OCTET_STRING required: true responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '406': description: Not Acceptable '415': description: UnSupported Media Type content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '500': description: Internal Server Error response content: application/json: schema: $ref: '#/components/schemas/ERSResponse' security: - HTTPBasicAuthentication: [] operationId: putActivedirectoryByIdLeaveAllNodes x-operation-id-source: derived servers: - url: https://{server}:{port}/ers/config description: Append /ctsapi/v2 or /ctsapi/v3 to above URL while accessing CTS APIs variables: server: description: The host where the API is rooted default: localhost port: description: The port no for CTS APIs is 9063 and for other APIs it is 443 default: '443' /activedirectory/{id}/join: put: tags: - Active Directory summary: Join a domain parameters: - name: id in: path required: true schema: title: id type: string example: null requestBody: content: application/json: schema: $ref: '#/components/schemas/identitystores.activedirectory' example: ERSActiveDirectory: adScopesNames: Default_Scope enableDomainAllowedList: true advancedSettings: authProtectionType: WIRELESS schema: ACTIVE_DIRECTORY lastName: sn country: co enableFailedAuthProtection: false jobTitle: title agingTime: 5 identityNotInAdBehaviour: SEARCH_JOINED_FOREST department: department unreachableDomainsBehaviour: PROCEED email: mail organizationalUnit: company enableDialinPermissionCheck: false enablePassChange: false plaintextAuth: false locality: l enableMachineAccess: true enableRewrites: false telephone: telephoneNumber enableCallbackForDialinClient: false enableAuthorizationFlow: false sshKeysAttributeName: sshPublicKey firstName: givenName stateOrProvince: st failedAuthThreshold: 5 streetAddress: streetAddress enableMachineAuth: true enableSessionStitching: false rewriteRules: - rewriteMatch: exampleMatch0 rewriteResult: exampleResult0 rowId: 0 - rewriteMatch: exampleMatch1 rewriteResult: exampleResult1 rowId: 1 - rewriteMatch: exampleMatch2 rewriteResult: exampleResult2 rowId: 2 - rewriteMatch: exampleMatch3 rewriteResult: exampleResult3 rowId: 3 domain: cisco.com name: Company_users description: Group of Active company users adgroups: groups: - name: cisco.com/operators type: GLOBAL sid: S-1-5-32-548 - name: cisco.com/office users type: DOMAIN LOCAL sid: S-1-5-33-326 id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b adAttributes: attributes: - internalName: internalName1 defaultValue: defaultString name: name1 type: STRING - internalName: internalName2 defaultValue: 1.1.1.1 name: name2 type: IP - internalName: internalName3 defaultValue: 'true' name: name3 type: BOOLEAN - internalName: internalName4 defaultValue: '5' name: name4 type: INT - internalName: internalName5 defaultValue: defaultOctetString name: name5 type: OCTET_STRING required: true responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '406': description: Not Acceptable '415': description: UnSupported Media Type content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '500': description: Internal Server Error response content: application/json: schema: $ref: '#/components/schemas/ERSResponse' security: - HTTPBasicAuthentication: [] operationId: putActivedirectoryByIdJoin x-operation-id-source: derived servers: - url: https://{server}:{port}/ers/config description: Append /ctsapi/v2 or /ctsapi/v3 to above URL while accessing CTS APIs variables: server: description: The host where the API is rooted default: localhost port: description: The port no for CTS APIs is 9063 and for other APIs it is 443 default: '443' /activedirectory/{id}/joinAllNodes: put: tags: - Active Directory summary: Join a domain with all nodes parameters: - name: id in: path required: true schema: title: id type: string example: null requestBody: content: application/json: schema: $ref: '#/components/schemas/identitystores.activedirectory' example: ERSActiveDirectory: adScopesNames: Default_Scope enableDomainAllowedList: true advancedSettings: authProtectionType: WIRELESS schema: ACTIVE_DIRECTORY lastName: sn country: co enableFailedAuthProtection: false jobTitle: title agingTime: 5 identityNotInAdBehaviour: SEARCH_JOINED_FOREST department: department unreachableDomainsBehaviour: PROCEED email: mail organizationalUnit: company enableDialinPermissionCheck: false enablePassChange: false plaintextAuth: false locality: l enableMachineAccess: true enableRewrites: false telephone: telephoneNumber enableCallbackForDialinClient: false enableAuthorizationFlow: false sshKeysAttributeName: sshPublicKey firstName: givenName stateOrProvince: st failedAuthThreshold: 5 streetAddress: streetAddress enableMachineAuth: true enableSessionStitching: false rewriteRules: - rewriteMatch: exampleMatch0 rewriteResult: exampleResult0 rowId: 0 - rewriteMatch: exampleMatch1 rewriteResult: exampleResult1 rowId: 1 - rewriteMatch: exampleMatch2 rewriteResult: exampleResult2 rowId: 2 - rewriteMatch: exampleMatch3 rewriteResult: exampleResult3 rowId: 3 domain: cisco.com name: Company_users description: Group of Active company users adgroups: groups: - name: cisco.com/operators type: GLOBAL sid: S-1-5-32-548 - name: cisco.com/office users type: DOMAIN LOCAL sid: S-1-5-33-326 id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b adAttributes: attributes: - internalName: internalName1 defaultValue: defaultString name: name1 type: STRING - internalName: internalName2 defaultValue: 1.1.1.1 name: name2 type: IP - internalName: internalName3 defaultValue: 'true' name: name3 type: BOOLEAN - internalName: internalName4 defaultValue: '5' name: name4 type: INT - internalName: internalName5 defaultValue: defaultOctetString name: name5 type: OCTET_STRING required: true responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '406': description: Not Acceptable '415': description: UnSupported Media Type content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '500': description: Internal Server Error response content: application/json: schema: $ref: '#/components/schemas/ERSResponse' security: - HTTPBasicAuthentication: [] operationId: putActivedirectoryByIdJoinAllNodes x-operation-id-source: derived servers: - url: https://{server}:{port}/ers/config description: Append /ctsapi/v2 or /ctsapi/v3 to above URL while accessing CTS APIs variables: server: description: The host where the API is rooted default: localhost port: description: The port no for CTS APIs is 9063 and for other APIs it is 443 default: '443' /activedirectory/{id}/getDomainUsers: put: tags: - Active Directory summary: Get domain users parameters: - name: id in: path required: true schema: title: id type: string example: null requestBody: content: application/json: schema: $ref: '#/components/schemas/identitystores.activedirectory' example: ERSActiveDirectory: adScopesNames: Default_Scope enableDomainAllowedList: true advancedSettings: authProtectionType: WIRELESS schema: ACTIVE_DIRECTORY lastName: sn country: co enableFailedAuthProtection: false jobTitle: title agingTime: 5 identityNotInAdBehaviour: SEARCH_JOINED_FOREST department: department unreachableDomainsBehaviour: PROCEED email: mail organizationalUnit: company enableDialinPermissionCheck: false enablePassChange: false plaintextAuth: false locality: l enableMachineAccess: true enableRewrites: false telephone: telephoneNumber enableCallbackForDialinClient: false enableAuthorizationFlow: false sshKeysAttributeName: sshPublicKey firstName: givenName stateOrProvince: st failedAuthThreshold: 5 streetAddress: streetAddress enableMachineAuth: true enableSessionStitching: false rewriteRules: - rewriteMatch: exampleMatch0 rewriteResult: exampleResult0 rowId: 0 - rewriteMatch: exampleMatch1 rewriteResult: exampleResult1 rowId: 1 - rewriteMatch: exampleMatch2 rewriteResult: exampleResult2 rowId: 2 - rewriteMatch: exampleMatch3 rewriteResult: exampleResult3 rowId: 3 domain: cisco.com name: Company_users description: Group of Active company users adgroups: groups: - name: cisco.com/operators type: GLOBAL sid: S-1-5-32-548 - name: cisco.com/office users type: DOMAIN LOCAL sid: S-1-5-33-326 id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b adAttributes: attributes: - internalName: internalName1 defaultValue: defaultString name: name1 type: STRING - internalName: internalName2 defaultValue: 1.1.1.1 name: name2 type: IP - internalName: internalName3 defaultValue: 'true' name: name3 type: BOOLEAN - internalName: internalName4 defaultValue: '5' name: name4 type: INT - internalName: internalName5 defaultValue: defaultOctetString name: name5 type: OCTET_STRING required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/UpdatedFieldsResponse' application/xml: schema: $ref: '#/components/schemas/UpdatedFieldsResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '406': description: Not Acceptable '415': description: UnSupported Media Type content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '500': description: Internal Server Error response content: application/json: schema: $ref: '#/components/schemas/ERSResponse' security: - HTTPBasicAuthentication: [] operationId: putActivedirectoryByIdGetDomainUsers x-operation-id-source: derived servers: - url: https://{server}:{port}/ers/config description: Append /ctsapi/v2 or /ctsapi/v3 to above URL while accessing CTS APIs variables: server: description: The host where the API is rooted default: localhost port: description: The port no for CTS APIs is 9063 and for other APIs it is 443 default: '443' /activedirectory/{id}/isUserMemberOf: put: tags: - Active Directory summary: Is user a member of groups parameters: - name: id in: path required: true schema: title: id type: string example: null requestBody: content: application/json: schema: $ref: '#/components/schemas/OperationAdditionalDataEntity' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ersActiveDirectoryGroupsResponse' application/xml: schema: $ref: '#/components/schemas/ersActiveDirectoryGroupsResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '406': description: Not Acceptable '415': description: UnSupported Media Type content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '500': description: Internal Server Error response content: application/json: schema: $ref: '#/components/schemas/ERSResponse' security: - HTTPBasicAuthentication: [] operationId: putActivedirectoryByIdIsUserMemberOf x-operation-id-source: derived servers: - url: https://{server}:{port}/ers/config description: Append /ctsapi/v2 or /ctsapi/v3 to above URL while accessing CTS APIs variables: server: description: The host where the API is rooted default: localhost port: description: The port no for CTS APIs is 9063 and for other APIs it is 443 default: '443' /activedirectory/{id}/getGroupsByDomain: put: tags: - Active Directory summary: Get groups by domain parameters: - name: id in: path required: true schema: title: id type: string example: null requestBody: content: application/json: schema: $ref: '#/components/schemas/OperationAdditionalDataEntity' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ersActiveDirectoryGroupsResponse' application/xml: schema: $ref: '#/components/schemas/ersActiveDirectoryGroupsResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '406': description: Not Acceptable '415': description: UnSupported Media Type content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '500': description: Internal Server Error response content: application/json: schema: $ref: '#/components/schemas/ERSResponse' security: - HTTPBasicAuthentication: [] operationId: putActivedirectoryByIdGetGroupsByDomain x-operation-id-source: derived servers: - url: https://{server}:{port}/ers/config description: Append /ctsapi/v2 or /ctsapi/v3 to above URL while accessing CTS APIs variables: server: description: The host where the API is rooted default: localhost port: description: The port no for CTS APIs is 9063 and for other APIs it is 443 default: '443' /activedirectory/{id}: get: tags: - Active Directory summary: Get join point details parameters: - name: id in: path required: true schema: title: id type: string example: null responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/activedirectoryResponse' application/xml: schema: $ref: '#/components/schemas/activedirectoryResponse' text/html: schema: type: string example: null '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '406': description: Not Acceptable '415': description: UnSupported Media Type content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null security: - HTTPBasicAuthentication: [] operationId: getActivedirectoryById x-operation-id-source: derived delete: tags: - Active Directory summary: Delete join point parameters: - name: id in: path required: true schema: title: id type: string example: null responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '406': description: Not Acceptable '415': description: UnSupported Media Type content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null security: - HTTPBasicAuthentication: [] operationId: deleteActivedirectoryById x-operation-id-source: derived servers: - url: https://{server}:{port}/ers/config description: Append /ctsapi/v2 or /ctsapi/v3 to above URL while accessing CTS APIs variables: server: description: The host where the API is rooted default: localhost port: description: The port no for CTS APIs is 9063 and for other APIs it is 443 default: '443' /activedirectory/{id}/leave: put: tags: - Active Directory summary: Leave a domain parameters: - name: id in: path required: true schema: title: id type: string example: null requestBody: content: application/json: schema: $ref: '#/components/schemas/identitystores.activedirectory' example: ERSActiveDirectory: adScopesNames: Default_Scope enableDomainAllowedList: true advancedSettings: authProtectionType: WIRELESS schema: ACTIVE_DIRECTORY lastName: sn country: co enableFailedAuthProtection: false jobTitle: title agingTime: 5 identityNotInAdBehaviour: SEARCH_JOINED_FOREST department: department unreachableDomainsBehaviour: PROCEED email: mail organizationalUnit: company enableDialinPermissionCheck: false enablePassChange: false plaintextAuth: false locality: l enableMachineAccess: true enableRewrites: false telephone: telephoneNumber enableCallbackForDialinClient: false enableAuthorizationFlow: false sshKeysAttributeName: sshPublicKey firstName: givenName stateOrProvince: st failedAuthThreshold: 5 streetAddress: streetAddress enableMachineAuth: true enableSessionStitching: false rewriteRules: - rewriteMatch: exampleMatch0 rewriteResult: exampleResult0 rowId: 0 - rewriteMatch: exampleMatch1 rewriteResult: exampleResult1 rowId: 1 - rewriteMatch: exampleMatch2 rewriteResult: exampleResult2 rowId: 2 - rewriteMatch: exampleMatch3 rewriteResult: exampleResult3 rowId: 3 domain: cisco.com name: Company_users description: Group of Active company users adgroups: groups: - name: cisco.com/operators type: GLOBAL sid: S-1-5-32-548 - name: cisco.com/office users type: DOMAIN LOCAL sid: S-1-5-33-326 id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b adAttributes: attributes: - internalName: internalName1 defaultValue: defaultString name: name1 type: STRING - internalName: internalName2 defaultValue: 1.1.1.1 name: name2 type: IP - internalName: internalName3 defaultValue: 'true' name: name3 type: BOOLEAN - internalName: internalName4 defaultValue: '5' name: name4 type: INT - internalName: internalName5 defaultValue: defaultOctetString name: name5 type: OCTET_STRING required: true responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '406': description: Not Acceptable '415': description: UnSupported Media Type content: application/json: schema: $ref: '#/components/schemas/ERSResponse' application/xml: schema: $ref: '#/components/schemas/ERSResponse' text/html: schema: type: string example: null '500': description: Internal Server Error response content: application/json: schema: $ref: '#/components/schemas/ERSResponse' security: - HTTPBasicAuthentication: [] operationId: putActivedirectoryByIdLeave x-operation-id-source: derived servers: - url: https://{server}:{port}/ers/config description: Append /ctsapi/v2 or /ctsapi/v3 to above URL while accessing CTS APIs variables: server: description: The host where the API is rooted default: localhost port: description: The port no for CTS APIs is 9063 and for other APIs it is 443 default: '443' /ers/config/activedirectory/{id}/getDomainUsers: put: tags: - Active Directory summary: Get all domain users description: This API retrieves all domain users. parameters: - name: id in: path required: true schema: type: string - in: header name: HTTP ERS-Media-Type Header description: Example:- identitystores.activedirectory.1.1 required: false schema: type: string - in: header name: Additional Attributes description: domain,filter,pageNumber,pageSize schema: type: string - in: header name: Additional Information description:

List the users of the given domain

domain(Required)The domain whose users we want to fetch
filter(Optional)Filter the returned users using '*' wild card
pageNumber(Optional)Page Number
pageSize(Optional)Items per page
schema: type: string responses: 200: description: OK content: application/json: schema: $ref: '#/components/schemas/domain-response' application/xml: schema: $ref: '#/components/schemas/domain-response' requestBody: content: application/json: schema: $ref: '#/components/schemas/additional' application/xml: schema: $ref: '#/components/schemas/additional' operationId: putErsConfigActivedirectoryByIdGetDomainUsers x-operation-id-source: derived /ers/config/activedirectory/{id}/passiveIdSettings: put: tags: - Active Directory summary: Update passive ID settings description: This API updates passive ID settings. parameters: - name: id in: path required: true schema: type: string - in: header name: HTTP ERS-Media-Type Header description: Example:- identitystores.activedirectory.1.1 required: false schema: type: string - in: header name: Additional Attributes description: enableAuthorizationFlow, enableSessionStitching schema: type: string - in: header name: Additional Information description:

Updates passive ID settings

enableAuthorizationFlow(Optional)Either boolean or string of true/false
enableSessionStitching(Optional)Either boolean or string of true/false
schema: type: string responses: 204: description: OK requestBody: content: application/json: schema: $ref: '#/components/schemas/additional' application/xml: schema: $ref: '#/components/schemas/additional' operationId: putErsConfigActivedirectoryByIdPassiveIdSettings x-operation-id-source: derived /ers/config/activedirectory/name/{name}: get: tags: - Active Directory summary: Get Active Directory by name description: This API allows the client to get Active Directory by name. This API also allows the client to fetch join point details by Name. The Name can be retrieved with the Get All operation.The Groups field contains an array of groups that are retrieved from AD-allowed domains for authentication. The Groups field contains an empty array if no such groups exist. parameters: - name: name in: path required: true schema: type: string - in: header name: HTTP ERS-Media-Type Header description: Example:- identitystores.activedirectory.1.1 required: false schema: type: string - in: header name: HTTP X-CSRF-TOKEN Header description: Required Only if Enabled from GUI Example:- fetch schema: type: string responses: 200: description: OK content: application/json: schema: $ref: '#/components/schemas/getbyname' application/xml: schema: $ref: '#/components/schemas/getbyname' operationId: getErsConfigActivedirectoryNameByName x-operation-id-source: derived /ers/config/activedirectory/{id}/getUserGroups: put: tags: - Active Directory summary: List groups of which given user is member description: This API allows the client to get groups of which a given user is a member. parameters: - name: id in: path required: true schema: type: string - in: header name: HTTP ERS-Media-Type Header description: Example:- identitystores.activedirectory.1.1 required: false schema: type: string - in: header name: HTTP X-CSRF-TOKEN Header description: The Token value from the GET X-CSRF-TOKEN fetch request schema: type: string - in: header name: Additional Attributes description: username schema: type: string - in: header name: Additional Information description:

List the groups a given user is member of.

Username (Required) The user to get its groups
schema: type: string responses: 200: description: OK content: application/json: schema: $ref: '#/components/schemas/ERSGroups' application/xml: schema: $ref: '#/components/schemas/ERSGroups' requestBody: content: application/json: schema: $ref: '#/components/schemas/additional' application/xml: schema: $ref: '#/components/schemas/additional' operationId: putErsConfigActivedirectoryByIdGetUserGroups x-operation-id-source: derived /ers/config/activedirectory/{id}/addGroups: put: tags: - Active Directory summary: Reload domain groups configuration from Active Directory into Cisco ISE description: This API loads domain groups configuration from Active Directory into Cisco ISE. Name is a required field - this is the name of the join point for domain access. Domain is a required field - this is the AD domain from where the updated groups are retrieved from. parameters: - name: id in: path required: true schema: type: string - in: header name: HTTP ERS-Media-Type Header description: Example:- identitystores.activedirectory.1.1 required: false schema: type: string - in: header name: HTTP X-CSRF-TOKEN Header description: The Token value from the GET X-CSRF-TOKEN fetch request schema: type: string - in: header name: Additional Information description:

Reload domain groups configuration from Active Directory into Cisco ISE.

name (Required) Name for the join point for domain access
domain (Required) AD domain to retrieve the updated groups from
schema: type: string responses: 200: description: OK requestBody: content: application/json: schema: $ref: '#/components/schemas/activedirectory' application/xml: schema: $ref: '#/components/schemas/activedirectory' operationId: putErsConfigActivedirectoryByIdAddGroups x-operation-id-source: derived /ers/config/activedirectory/{id}/leave: put: tags: - Active Directory summary: Make Cisco ISE node leave Active Directory domain description: This API makes a Cisco ISE node to leave an Active Directory domain. parameters: - name: id in: path required: true schema: type: string - in: header name: HTTP ERS-Media-Type Header description: Example:- identitystores.activedirectory.1.1 required: false schema: type: string - in: header name: HTTP X-CSRF-TOKEN Header description: The Token value from the GET X-CSRF-TOKEN fetch request schema: type: string - in: header name: Additional Attributes description: username,password,node schema: type: string - in: header name: Additional Information description:

Make a Cisco ISE node leave an Active Directory domain.

username (Required) The domain user to use
password (Required) The domain user's password
node (Required) The name of the ISE node to leave the domain. The node names can be retrieved with the "Node Details/Get All" ERS operation
orgunit (Optional) the organizational unit in AD where the machine object for the joined ISE will be stored
schema: type: string responses: 200: description: OK requestBody: content: application/json: schema: $ref: '#/components/schemas/additional' application/xml: schema: $ref: '#/components/schemas/additional' operationId: putErsConfigActivedirectoryByIdLeave x-operation-id-source: derived /ers/config/activedirectory/{id}/isUserMemberOf: put: tags: - Active Directory summary: Verify if user is member of given groups description: This API verifies if the user is a member of the given groups. parameters: - name: id in: path required: true schema: type: string - in: header name: HTTP ERS-Media-Type Header description: Example:- identitystores.activedirectory.1.1 required: false schema: type: string - in: header name: HTTP X-CSRF-TOKEN Header description: The Token value from the GET X-CSRF-TOKEN fetch request schema: type: string - in: header name: Additional Attributes description: username,groupsids schema: type: string - in: header name: Additional Information description:

Is user a member of the given groups.

username (Required) Perform the check on this user
groupsids (Required) Comma (,) or semicolon (;) delimitered groups sid numbers in which user membership is looked for. The result will be a subset of this list of the groups the user is a member of
schema: type: string responses: 200: description: OK content: application/json: schema: $ref: '#/components/schemas/ERSGroups' application/xml: schema: $ref: '#/components/schemas/ERSGroups' requestBody: content: application/json: schema: $ref: '#/components/schemas/additional' application/xml: schema: $ref: '#/components/schemas/additional' operationId: putErsConfigActivedirectoryByIdIsUserMemberOf x-operation-id-source: derived /ers/config/activedirectory/{id}/getTrustedDomains: put: tags: - Active Directory summary: Get list of domains that are accessible through given join point via trust… description: This API gets the list of domains that are accessible through the given join point via trust relationships. parameters: - name: id in: path required: true schema: type: string - in: header name: HTTP ERS-Media-Type Header description: Example:- identitystores.activedirectory.1.1 required: false schema: type: string - in: header name: HTTP X-CSRF-TOKEN Header description: The Token value from the GET X-CSRF-TOKEN fetch request schema: type: string - in: header name: Additional Information description:

Get the list of domains that are accessible through the given join point via trust relationships.

schema: type: string responses: 200: description: OK content: application/json: schema: $ref: '#/components/schemas/ERSDomains' application/xml: schema: $ref: '#/components/schemas/ERSDomains' operationId: putErsConfigActivedirectoryByIdGetTrustedDomains x-operation-id-source: derived /ers/config/activedirectory/{id}/joinAllNodes: put: tags: - Active Directory summary: Join all Cisco ISE Nodes to Active Directory domain description: This API joins all Cisco ISE Nodes to an Active Directory domain. parameters: - name: id in: path required: true schema: type: string - in: header name: HTTP ERS-Media-Type Header description: Example:- identitystores.activedirectory.1.1 required: false schema: type: string - in: header name: HTTP X-CSRF-TOKEN Header description: The Token value from the GET X-CSRF-TOKEN fetch request schema: type: string - in: header name: Additional Attributes description: username,password schema: type: string - in: header name: Additional Information description:

Join all Cisco ISE Nodes to an Active Directory domain.

username (Required) The domain user to use
password (Required) The domain user's password
schema: type: string responses: 200: description: OK requestBody: content: application/json: schema: $ref: '#/components/schemas/additional' application/xml: schema: $ref: '#/components/schemas/additional' operationId: putErsConfigActivedirectoryByIdJoinAllNodes x-operation-id-source: derived /ers/config/activedirectory/{id}/leaveAllNodes: put: tags: - Active Directory summary: Make all Cisco ISE nodes leave Active Directory domain description: This API joins makes all Cisco ISE nodes leave an Active Directory domain. parameters: - name: id in: path required: true schema: type: string - in: header name: HTTP ERS-Media-Type Header description: Example:- identitystores.activedirectory.1.1 required: false schema: type: string - in: header name: HTTP X-CSRF-TOKEN Header description: The Token value from the GET X-CSRF-TOKEN fetch request schema: type: string - in: header name: Additional Attributes description: username,password schema: type: string - in: header name: Additional Information description:

Make all Cisco ISE nodes leave an Active Directory domain.

username (Required) The domain user to use
password (Required) The domain user's password
schema: type: string responses: 200: description: OK requestBody: content: application/json: schema: $ref: '#/components/schemas/additional' application/xml: schema: $ref: '#/components/schemas/additional' operationId: putErsConfigActivedirectoryByIdLeaveAllNodes x-operation-id-source: derived /ers/config/activedirectory/{id}/getGroupsByDomain: put: tags: - Active Directory summary: List the groups of given domain description: This API lists the groups of the given domain. parameters: - name: id in: path required: true schema: type: string - in: header name: HTTP ERS-Media-Type Header description: Example:- identitystores.activedirectory.1.1 required: false schema: type: string - in: header name: HTTP X-CSRF-TOKEN Header description: The Token value from the GET X-CSRF-TOKEN fetch request schema: type: string - in: header name: Additional Attributes description: domain,filter,sidFilter,typeFilter schema: type: string - in: header name: Additional Information description:

List the groups of the given domain.

domain (Required) The domain whose groups we want to fetch
filter (Required) Exact match filter on group's CN
sidFilter (Optional) Exact match filter on group's SID, optionally specifying the domain as prefix. e.g. S-1-5-33-544 and R1.dom/S-1-5-33-544 are legal
typeFilter (Optional) Can be exactly one of:BUILTIN, DOMAIN LOCAL, GLOBAL, UNIVERSAL
schema: type: string responses: 200: description: OK content: application/json: schema: $ref: '#/components/schemas/ERSActiveDirectoryGroups' application/xml: schema: $ref: '#/components/schemas/ERSActiveDirectoryGroups' requestBody: content: application/json: schema: $ref: '#/components/schemas/additional' application/xml: schema: $ref: '#/components/schemas/additional' operationId: putErsConfigActivedirectoryByIdGetGroupsByDomain x-operation-id-source: derived /ers/config/activedirectory/{id}: get: tags: - Active Directory summary: Fetch join point details by ID description: This API fetchs the join point details by ID. The ID can be retrieved with the Get All operation. Fetch join point details by ID. The ID can be retrieved with the Get All operation. The Groups field contains an array of groups that are retrieved from AD-allowed domains for authentication. The Groups field contains an empty array if no such groups exist. parameters: - name: id in: path required: true schema: type: string - in: header name: HTTP ERS-Media-Type Header description: Example:- identitystores.activedirectory.1.1 required: false schema: type: string - in: header name: HTTP X-CSRF-TOKEN Header description: Required Only if Enabled from GUI Example:- fetch schema: type: string - in: header name: Additional Information description:

Fetch join point details by ID. The ID can be retrieved with the Get All operation.

schema: type: string responses: 200: description: OK content: application/json: schema: $ref: '#/components/schemas/activedirectory' application/xml: schema: $ref: '#/components/schemas/activedirectory' operationId: getErsConfigActivedirectoryById x-operation-id-source: derived delete: tags: - Active Directory summary: Delete AD join point from Cisco ISE description: This API deletes an AD join point from Cisco ISE. parameters: - name: id in: path required: true schema: type: string - in: header name: HTTP ERS-Media-Type Header description: Example:- identitystores.activedirectory.1.1 required: false schema: type: string - in: header name: HTTP X-CSRF-TOKEN Header description: The Token value from the GET X-CSRF-TOKEN fetch request schema: type: string - in: header name: Bulk support description: Operation 'Delete join point' can be used within Bulk Request schema: type: string - in: header name: Additional Information description:

Deletes an AD join point from Cisco ISE.

schema: type: string responses: 204: description: No Content operationId: deleteErsConfigActivedirectoryById x-operation-id-source: derived /ers/config/activedirectory/{id}/join: put: tags: - Active Directory summary: Join Cisco ISE node to Active Directory domain description: This API joins a Cisco ISE node to an Active Directory domain. parameters: - name: id in: path required: true schema: type: string - in: header name: HTTP ERS-Media-Type Header description: Example:- identitystores.activedirectory.1.1 required: false schema: type: string - in: header name: HTTP X-CSRF-TOKEN Header description: The Token value from the GET X-CSRF-TOKEN fetch request schema: type: string - in: header name: Additional Attributes description: username,password,node,orgunit schema: type: string - in: header name: Additional Information description:

Join a Cisco ISE node to an Active Directory domain.

username (Required) The domain user to use
password (Required) The domain user's password
node (Required) The name of the ISE node to join the domain. The node names can be retrieved with the "Node Details/Get All" ERS operation
schema: type: string responses: 200: description: OK requestBody: content: application/json: schema: $ref: '#/components/schemas/additional' application/xml: schema: $ref: '#/components/schemas/additional' operationId: putErsConfigActivedirectoryByIdJoin x-operation-id-source: derived /ers/config/activedirectory: post: tags: - Active Directory summary: Create AD join point in Cisco ISE description: This API creates an AD join point in Cisco ISE. parameters: - in: header name: HTTP ERS-Media-Type Header description: Example:- identitystores.activedirectory.1.1 required: false schema: type: string - in: header name: HTTP X-CSRF-TOKEN Header description: The Token value from the GET X-CSRF-TOKEN fetch request schema: type: string - in: header name: Additional Attributes description: username,password,node,orgunit schema: type: string - in: header name: Additional Information description:

Creates an AD join point in Cisco ISE.

name (Required) Unique name for the join point
description (Optional) Join point description
domain (Required) AD domain associated with the join point
schema: type: string responses: 201: description: Created requestBody: content: application/json: schema: $ref: '#/components/schemas/activedirectory' application/xml: schema: $ref: '#/components/schemas/activedirectory' operationId: postErsConfigActivedirectory x-operation-id-source: derived get: tags: - Active Directory summary: List all join points for Active Directory domains in Cisco ISE description: This API lists all the join points for Active Directory domains in Cisco ISE. parameters: - in: header name: HTTP ERS-Media-Type Header description: Example:- identitystores.activedirectory.1.1 required: false schema: type: string - in: header name: HTTP X-CSRF-TOKEN Header description: The Token value from the GET X-CSRF-TOKEN fetch request schema: type: string - in: header name: Additional Information description:

List all join points for Active Directory domains in Cisco ISE.

schema: type: string responses: 200: description: OK content: application/json: schema: $ref: '#/components/schemas/search' application/xml: schema: $ref: '#/components/schemas/search' operationId: getErsConfigActivedirectory x-operation-id-source: derived /ers/config/activedirectory/versioninfo: get: tags: - Active Directory summary: Get Active Directory version information description: This API helps to retrieve the version information related to the active directory. responses: 200: description: OK content: application/json: schema: $ref: '#/components/schemas/VersionInfo' operationId: getErsConfigActivedirectoryVersioninfo x-operation-id-source: derived components: schemas: identitystores.activedirectory: required: - ERSActiveDirectory type: object properties: ERSActiveDirectory: $ref: '#/components/schemas/ERSActiveDirectory' example: null ERSResponse: type: object properties: operation: type: string example: Operation messages: type: array example: null items: properties: title: type: string example: title type: type: string example: type code: type: string example: code example: null example: null ERSActiveDirectory: required: - domain - name properties: domain: title: domain type: string description: The AD domain example: null adScopesNames: title: adScopesNames type: string description: String that contains the names of the scopes that the active directory belongs to. Names are separated by comma example: null enableDomainAllowedList: title: enableDomainAllowedList type: boolean description: '' example: null adgroups: properties: groups: title: groups type: array description: List of Groups example: null items: properties: name: title: name type: string description: Required for each group in the group list with no duplication between groups example: null sid: title: sid type: string description: Required for each group in the group list with no duplication between groups example: null type: title: type type: string description: '' example: null example: null example: null adAttributes: properties: attributes: title: attributes type: array description: List of Attributes example: null items: properties: name: title: name type: string description: Required for each attribute in the attribute list with no duplication between attributes example: null type: title: type type: object description: 'Required for each group in the group list. Allowed values: STRING, IP, BOOLEAN, INT, OCTET_STRING' example: null internalName: title: internalName type: string description: Required for each attribute in the attribute list example: null defaultValue: title: defaultValue type: string description: Required for each attribute in the attribute list. Can contain an empty string example: null example: null example: null advancedSettings: properties: rewriteRules: title: rewriteRules type: array description: List of Rewrite rules example: null items: properties: rowId: title: rowId type: string description: Required for each rule in the list in serial order example: null rewriteMatch: title: rewriteMatch type: string description: Required for each rule in the list with no duplication between rules example: null rewriteResult: title: rewriteResult type: string description: Required for each rule in the list example: null example: null enableRewrites: title: enableRewrites type: boolean description: '' example: null enablePassChange: title: enablePassChange type: boolean description: '' example: null enableMachineAuth: title: enableMachineAuth type: boolean description: '' example: null enableMachineAccess: title: enableMachineAccess type: boolean description: '' example: null enableDialinPermissionCheck: title: enableDialinPermissionCheck type: boolean description: '' example: null plaintextAuth: title: plaintextAuth type: boolean description: '' example: null agingTime: title: agingTime type: number description: '' example: null enableCallbackForDialinClient: title: enableCallbackForDialinClient type: boolean description: '' example: null identityNotInAdBehaviour: title: identityNotInAdBehaviour type: object description: 'Allowed values: REJECT, SEARCH_JOINED_FOREST, SEARCH_ALL' example: null unreachableDomainsBehaviour: title: unreachableDomainsBehaviour type: object description: 'Allowed values: PROCEED, DROP' example: null schema: title: schema type: object description: 'Allowed values: ACTIVE_DIRECTORY, CUSTOM' example: null firstName: title: firstName type: string description: User info attribute example: null department: title: department type: string description: User info attribute example: null lastName: title: lastName type: string description: User info attribute example: null organizationalUnit: title: organizationalUnit type: string description: User info attribute example: null jobTitle: title: jobTitle type: string description: User info attribute example: null locality: title: locality type: string description: User info attribute example: null email: title: email type: string description: User info attribute example: null stateOrProvince: title: stateOrProvince type: string description: User info attribute example: null telephone: title: telephone type: string description: User info attribute example: null country: title: country type: string description: User info attribute example: null streetAddress: title: streetAddress type: string description: User info attribute example: null enableFailedAuthProtection: title: enableFailedAuthProtection type: boolean description: Enable prevent AD account lockout due to too many bad password attempts example: null failedAuthThreshold: title: failedAuthThreshold type: number description: Number of bad password attempts example: null authProtectionType: title: authProtectionType type: string description: Enable prevent AD account lockout for WIRELESS/WIRED/BOTH example: null example: null ERSActiveDirectoryDomains: properties: domains: title: domains type: array description: List of Domains example: null items: properties: dnsName: title: dnsName type: string description: '' example: null forest: title: forest type: string description: '' example: null unusableReason: title: unusableReason type: string description: '' example: null example: null example: null name: title: name type: string description: name example: null id: title: id type: string description: Id example: null description: title: description type: string description: Description example: null example: ERSActiveDirectory: adScopesNames: Default_Scope enableDomainAllowedList: true advancedSettings: authProtectionType: WIRELESS schema: ACTIVE_DIRECTORY lastName: sn country: co enableFailedAuthProtection: false jobTitle: title agingTime: 5 identityNotInAdBehaviour: SEARCH_JOINED_FOREST department: department unreachableDomainsBehaviour: PROCEED email: mail organizationalUnit: company enableDialinPermissionCheck: false enablePassChange: false plaintextAuth: false locality: l enableMachineAccess: true enableRewrites: false telephone: telephoneNumber enableCallbackForDialinClient: false enableAuthorizationFlow: false sshKeysAttributeName: sshPublicKey firstName: givenName stateOrProvince: st failedAuthThreshold: 5 streetAddress: streetAddress enableMachineAuth: true enableSessionStitching: false rewriteRules: - rewriteMatch: exampleMatch0 rewriteResult: exampleResult0 rowId: 0 - rewriteMatch: exampleMatch1 rewriteResult: exampleResult1 rowId: 1 - rewriteMatch: exampleMatch2 rewriteResult: exampleResult2 rowId: 2 - rewriteMatch: exampleMatch3 rewriteResult: exampleResult3 rowId: 3 domain: cisco.com name: Company_users description: Group of Active company users adgroups: groups: - name: cisco.com/operators type: GLOBAL sid: S-1-5-32-548 - name: cisco.com/office users type: DOMAIN LOCAL sid: S-1-5-33-326 id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b adAttributes: attributes: - internalName: internalName1 defaultValue: defaultString name: name1 type: STRING - internalName: internalName2 defaultValue: 1.1.1.1 name: name2 type: IP - internalName: internalName3 defaultValue: 'true' name: name3 type: BOOLEAN - internalName: internalName4 defaultValue: '5' name: name4 type: INT - internalName: internalName5 defaultValue: defaultOctetString name: name5 type: OCTET_STRING activedirectoryListResponse: type: object properties: SearchResult: type: object properties: total: type: integer example: '2' resources: type: array example: null items: $ref: '#/components/schemas/activedirectoryListResponseEntity' example: null example: SearchResult: total: 2 previousPage: rel: previous href: link-to-previous-page type: application/xml nextPage: rel: next href: link-to-next-page type: application/xml resources: - name: name1 link: rel: self href: type: application/xml description: description1 id: id1 - name: name2 link: rel: self href: type: application/xml description: description2 id: id2 activedirectoryListResponseEntity: properties: id: title: id type: string description: Id description example: null name: title: name type: string description: name description example: null description: title: description type: string description: description example: null link: $ref: '#/components/schemas/Link' example: null ersActiveDirectoryDomainsResponse: properties: ERSActiveDirectoryDomains: properties: domains: title: domains type: array description: List of Domains example: null items: properties: dnsName: title: dnsName type: string description: '' example: null forest: title: forest type: string description: '' example: null unusableReason: title: unusableReason type: string description: '' example: null example: null example: null example: null activedirectoryResponseEntity: properties: domain: title: domain type: string description: The AD domain example: null adScopesNames: title: adScopesNames type: string description: String that contains the names of the scopes that the active directory belongs to. Names are separated by comma example: null enableDomainAllowedList: title: enableDomainAllowedList type: boolean description: '' example: null adgroups: properties: groups: title: groups type: array description: List of Groups example: null items: properties: name: title: name type: string description: Required for each group in the group list with no duplication between groups example: null sid: title: sid type: string description: Required for each group in the group list with no duplication between groups example: null type: title: type type: string description: '' example: null example: null example: null adAttributes: properties: attributes: title: attributes type: array description: List of Attributes example: null items: properties: name: title: name type: string description: Required for each attribute in the attribute list with no duplication between attributes example: null type: title: type type: object description: 'Required for each group in the group list. Allowed values: STRING, IP, BOOLEAN, INT, OCTET_STRING' example: null internalName: title: internalName type: string description: Required for each attribute in the attribute list example: null defaultValue: title: defaultValue type: string description: Required for each attribute in the attribute list. Can contain an empty string example: null example: null example: null advancedSettings: properties: rewriteRules: title: rewriteRules type: array description: List of Rewrite rules example: null items: properties: rowId: title: rowId type: string description: Required for each rule in the list in serial order example: null rewriteMatch: title: rewriteMatch type: string description: Required for each rule in the list with no duplication between rules example: null rewriteResult: title: rewriteResult type: string description: Required for each rule in the list example: null example: null enableRewrites: title: enableRewrites type: boolean description: '' example: null enablePassChange: title: enablePassChange type: boolean description: '' example: null enableMachineAuth: title: enableMachineAuth type: boolean description: '' example: null enableMachineAccess: title: enableMachineAccess type: boolean description: '' example: null enableDialinPermissionCheck: title: enableDialinPermissionCheck type: boolean description: '' example: null plaintextAuth: title: plaintextAuth type: boolean description: '' example: null agingTime: title: agingTime type: number description: '' example: null enableCallbackForDialinClient: title: enableCallbackForDialinClient type: boolean description: '' example: null identityNotInAdBehaviour: title: identityNotInAdBehaviour type: object description: 'Allowed values: REJECT, SEARCH_JOINED_FOREST, SEARCH_ALL' example: null unreachableDomainsBehaviour: title: unreachableDomainsBehaviour type: object description: 'Allowed values: PROCEED, DROP' example: null schema: title: schema type: object description: 'Allowed values: ACTIVE_DIRECTORY, CUSTOM' example: null firstName: title: firstName type: string description: User info attribute example: null department: title: department type: string description: User info attribute example: null lastName: title: lastName type: string description: User info attribute example: null organizationalUnit: title: organizationalUnit type: string description: User info attribute example: null jobTitle: title: jobTitle type: string description: User info attribute example: null locality: title: locality type: string description: User info attribute example: null email: title: email type: string description: User info attribute example: null stateOrProvince: title: stateOrProvince type: string description: User info attribute example: null telephone: title: telephone type: string description: User info attribute example: null country: title: country type: string description: User info attribute example: null streetAddress: title: streetAddress type: string description: User info attribute example: null enableFailedAuthProtection: title: enableFailedAuthProtection type: boolean description: Enable prevent AD account lockout due to too many bad password attempts example: null failedAuthThreshold: title: failedAuthThreshold type: number description: Number of bad password attempts example: null authProtectionType: title: authProtectionType type: string description: Enable prevent AD account lockout for WIRELESS/WIRED/BOTH example: null example: null ERSActiveDirectoryDomains: properties: domains: title: domains type: array description: List of Domains example: null items: properties: dnsName: title: dnsName type: string description: '' example: null forest: title: forest type: string description: '' example: null unusableReason: title: unusableReason type: string description: '' example: null example: null example: null name: title: name type: string description: name example: null id: title: id type: string description: Id example: null description: title: description type: string description: Description example: null link: $ref: '#/components/schemas/Link' example: null Link: type: object properties: rel: type: string example: self enum: - next - previous - self - status href: type: string example: https://{server}:{port}/ers/config type: type: string example: application/json example: null activedirectoryResponse: type: object properties: ERSActiveDirectory: $ref: '#/components/schemas/activedirectoryResponseEntity' example: ERSActiveDirectory: adScopesNames: Default_Scope enableDomainAllowedList: true advancedSettings: authProtectionType: WIRELESS schema: ACTIVE_DIRECTORY lastName: sn country: co enableFailedAuthProtection: false jobTitle: title agingTime: 5 identityNotInAdBehaviour: SEARCH_JOINED_FOREST department: department unreachableDomainsBehaviour: PROCEED email: mail organizationalUnit: company enableDialinPermissionCheck: false enablePassChange: false plaintextAuth: false locality: l enableMachineAccess: true enableRewrites: false telephone: telephoneNumber enableCallbackForDialinClient: false enableAuthorizationFlow: false sshKeysAttributeName: sshPublicKey firstName: givenName stateOrProvince: st failedAuthThreshold: 5 streetAddress: streetAddress enableMachineAuth: true enableSessionStitching: false rewriteRules: - rewriteMatch: exampleMatch0 rewriteResult: exampleResult0 rowId: 0 - rewriteMatch: exampleMatch1 rewriteResult: exampleResult1 rowId: 1 - rewriteMatch: exampleMatch2 rewriteResult: exampleResult2 rowId: 2 - rewriteMatch: exampleMatch3 rewriteResult: exampleResult3 rowId: 3 domain: cisco.com name: Company_users description: Group of Active company users adgroups: groups: - name: cisco.com/operators type: GLOBAL sid: S-1-5-32-548 - name: cisco.com/office users type: DOMAIN LOCAL sid: S-1-5-33-326 id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b adAttributes: attributes: - internalName: internalName1 defaultValue: defaultString name: name1 type: STRING - internalName: internalName2 defaultValue: 1.1.1.1 name: name2 type: IP - internalName: internalName3 defaultValue: 'true' name: name3 type: BOOLEAN - internalName: internalName4 defaultValue: '5' name: name4 type: INT - internalName: internalName5 defaultValue: defaultOctetString name: name5 type: OCTET_STRING ersActiveDirectoryGroupsResponse: properties: ERSActiveDirectoryGroups: properties: groups: title: groups type: array description: List of Groups example: null items: properties: name: title: name type: string description: Required for each group in the group list with no duplication between groups example: null sid: title: sid type: string description: Required for each group in the group list with no duplication between groups example: null type: title: type type: string description: '' example: null example: null example: null example: null updatedField: properties: field: type: string example: null oldValue: type: string example: null newValue: type: string example: null example: null UpdatedFieldsResponse: type: object properties: UpdatedFieldsList: type: object properties: updatedField: type: array example: null items: $ref: '#/components/schemas/updatedField' example: null example: null OperationAdditionalDataEntity: properties: OperationAdditionalData: properties: additionalData: type: array example: null items: properties: value: type: string example: null name: type: string example: null example: null example: null example: null ERSGroups: type: object properties: ERSActiveDirectory: $ref: '#/components/schemas/ERSActiveDirectoryGroups' additional: type: object properties: OperationAdditionalData: $ref: '#/components/schemas/OperationAdditionalData' VersionInfo: type: object properties: VersionInfo: $ref: '#/components/schemas/version' ERSActiveDirectoryGroups: type: object properties: groups: type: array example: - groupName: operators sid: r1.dom/S-1-5-32-548 type: GLOBAL - groupName: office users sid: r1.dom/S-1-5-33-326 type: DOMAIN LOCAL items: properties: name: type: string activedirectory: type: object properties: ERSActiveDirectory: $ref: '#/components/schemas/ERSActiveDirectory_2' ERSActiveDirectoryDomains: type: object properties: domains: type: array example: - dnsName: R1.cisco.com forest: cisco.com unusableReason: '' - dnsName: R2.R1.cisco.com forest: cisco.com unusableReason: '' items: properties: name: type: string ERSActiveDirectory_2: type: object properties: id: type: string example: af1cd190-7d71-11eb-b02e-ead13cf60dcb name: type: string example: Company_users description: type: string example: Group of Active company users domain: type: string example: cisco.com enableDomainWhiteList: type: boolean example: true adGroups: type: object properties: groups: type: array example: - name: dcloud.cisco.com/Users/device-admins sid: S-1-5-21-3064548688-3193819538-1298560677-1276 - name: dcloud.cisco.com/Users/Domain Computers sid: S-1-5-21-3064548688-3193819538-1298560677-515 - name: dcloud.cisco.com/Users/Domain Users sid: S-1-5-21-3064548688-3193819538-1298560677-513 items: properties: name: type: string advancedsettings: type: object properties: enablePassChange: type: boolean example: true enablePasswordlessAuth: type: boolean example: false enableMachineAuth: type: boolean example: true enableMachineAccess: type: boolean example: true agingTime: type: integer example: 5 enableDialinPermissionCheck: type: boolean example: false enableCallbackForDialinClient: type: boolean example: false plaintextAuth: type: boolean example: false enableFailedAuthProtection: type: boolean example: false authProtectionType: type: string example: WIRELESS failedAuthThreshold: type: integer example: 5 identityNotInAdBehaviour: type: string example: SEARCH_JOINED_FOREST unreachableDomainsBehaviour: type: string example: PROCEED enableRewrites: type: boolean example: false rewriteRules: type: array example: - rowId: 0 rewriteMatch: exampleMatch0 rewriteResult: exampleResult0 - rowId: 1 rewriteMatch: exampleMatch1 rewriteResult: exampleResult1 - rowId: 2 rewriteMatch: exampleMatch2 rewriteResult: exampleResult2 - rowId: 3 rewriteMatch: exampleMatch3 rewriteResult: exampleResult3 items: properties: name: type: string firstName: type: string example: givenName department: type: string example: department lastName: type: string example: sn organizationalUnit: type: string example: company jobTitle: type: string example: title locality: type: string example: l email: type: string example: mail stateOrProvince: type: string example: st telephone: type: string example: telephoneNumber country: type: string example: co streetAddress: type: string example: streetAddress schema: type: string example: ACTIVE_DIRECTORY adAttributes: type: object properties: attributes: type: array example: - name: name1 type: STRING defaultValue: defaultString internalName: internalName1 - name: name2 type: IP defaultValue: 1.1.1.1 internalName: internalName2 - name: name3 type: BOOLEAN defaultValue: 'true' internalName: internalName3 - name: name4 type: INT defaultValue: '5' internalName: internalName4 - name: name5 type: OCTET_STRING defaultValue: defaultOctetString internalName: internalName5 items: properties: name: type: string adScopesNames: type: string example: Default_Scope link: type: object properties: rel: type: string example: self href: type: string example: https://:9060/ers/config/activedirectory/af1cd190-7d71-11eb-b02e-ead13cf60dcb type: type: string example: application/json domain-response1: type: object properties: name: type: string example: user1 search: type: object properties: SearchResult: $ref: '#/components/schemas/SearchResult' link1: type: object properties: rel: type: string example: self href: type: string example: https://:9060/ers/config/activedirectory/versioninfo type: type: string example: application/json SearchResult: type: object properties: total: type: integer example: 1 resources: type: array example: - id: af1cd190-7d71-11eb-b02e-ead13cf60dcb name: Company_users description: Example link: rel: self href: https://:9060/ers/config/activedirectory/af1cd190-7d71-11eb-b02e-ead13cf60dcb type: application/json items: properties: name: type: string ERSActiveDirectory_name: type: object properties: id: type: string example: af1cd190-7d71-11eb-b02e-ead13cf60dcb name: type: string example: Company_users description: type: string example: Group of Active company users domain: type: string example: cisco.com enableDomainWhiteList: type: boolean example: true adGroups: type: object properties: groups: type: array example: - name: dcloud.cisco.com/Users/device-admins sid: S-1-5-21-3064548688-3193819538-1298560677-1276 - name: dcloud.cisco.com/Users/Domain Computers sid: S-1-5-21-3064548688-3193819538-1298560677-515 - name: dcloud.cisco.com/Users/Domain Users sid: S-1-5-21-3064548688-3193819538-1298560677-513 items: properties: name: type: string advancedsettings: type: object properties: enablePassChange: type: boolean example: true enablePasswordlessAuth: type: boolean example: false enableMachineAuth: type: boolean example: true enableMachineAccess: type: boolean example: true agingTime: type: integer example: 5 enableDialinPermissionCheck: type: boolean example: false enableCallbackForDialinClient: type: boolean example: false plaintextAuth: type: boolean example: false enableFailedAuthProtection: type: boolean example: false authProtectionType: type: string example: WIRELESS failedAuthThreshold: type: integer example: 5 identityNotInAdBehaviour: type: string example: SEARCH_JOINED_FOREST unreachableDomainsBehaviour: type: string example: PROCEED enableRewrites: type: boolean example: false rewriteRules: type: array example: - rowId: 0 rewriteMatch: exampleMatch0 rewriteResult: exampleResult0 - rowId: 1 rewriteMatch: exampleMatch1 rewriteResult: exampleResult1 - rowId: 2 rewriteMatch: exampleMatch2 rewriteResult: exampleResult2 - rowId: 3 rewriteMatch: exampleMatch3 rewriteResult: exampleResult3 items: properties: name: type: string firstName: type: string example: givenName department: type: string example: department lastName: type: string example: sn organizationalUnit: type: string example: company jobTitle: type: string example: title locality: type: string example: l email: type: string example: mail stateOrProvince: type: string example: st telephone: type: string example: telephoneNumber country: type: string example: co streetAddress: type: string example: streetAddress schema: type: string example: ACTIVE_DIRECTORY adAttributes: type: object properties: attributes: type: array example: - name: name1 type: STRING defaultValue: defaultString internalName: internalName1 - name: name2 type: IP defaultValue: 1.1.1.1 internalName: internalName2 - name: name3 type: BOOLEAN defaultValue: 'true' internalName: internalName3 - name: name4 type: INT defaultValue: '5' internalName: internalName4 - name: name5 type: OCTET_STRING defaultValue: defaultOctetString internalName: internalName5 items: properties: name: type: string adScopesNames: type: string example: Default_Scope link: type: object properties: rel: type: string example: self href: type: string example: https://:9060/ers/config/activedirectory/name/Company_users type: type: string example: application/json version: type: object properties: currentServerVersion: type: string example: 1.2 supportedVersions: type: string example: 1.0,1.1,1.2 link: $ref: '#/components/schemas/link1' OperationAdditionalData: type: object properties: additionalData: $ref: '#/components/schemas/additionalData' ERSDomains: type: object properties: ERSActiveDirectoryDomains: $ref: '#/components/schemas/ERSActiveDirectoryDomains' domain-response: type: object properties: ERSActiveDirectoryUsers: type: object properties: users: type: array items: $ref: '#/components/schemas/domain-response1' getbyname: type: object properties: ERSActiveDirectory: $ref: '#/components/schemas/ERSActiveDirectory_name' additionalData: type: array items: $ref: '#/components/schemas/additionalData1' additionalData1: type: object properties: name: type: string example: example additional attribute name value: type: string example: its value parameters: psize: name: size in: query description: Items by Page allowReserved: true schema: type: integer example: null example: '20' ppage: name: page in: query description: Page Number (0...N) allowReserved: true schema: type: integer example: null example: '1' securitySchemes: HTTPBasicAuthentication: type: http scheme: basic x-refined-from: - cisco-ise-ers-open-api-ers-apis.yaml - cisco-ise-legacy-ers-active-directory.yaml