{"type":"api","title":"Get All Global Credentials V2","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/a58b8872fdc3116cb1a0478252ee81e8011d37c2/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"getAllGlobalCredentialsV2","tags":["Discovery"],"summary":"Get All Global Credentials V2","deprecated":false,"description":"API to get device credentials' details. It fetches all global credentials of all types at once, without the need to pass any input parameters.","parameters":[],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"cliCredential":{"type":"array","items":{"type":"object","properties":{"password":{"type":"string","description":"CLI Password"},"username":{"type":"string","description":"CLI Username"},"enablePassword":{"type":"string","description":"CLI Enable Password"},"description":{"type":"string","description":"Description of the CLI credential"},"comments":{"type":"string","description":"Comments to identify the CLI credential"},"credentialType":{"type":"string","enum":["GLOBAL","APP"],"description":"Credential type to identify the application that uses the CLI credential"},"instanceTenantId":{"type":"string","description":"Instance Tenant Id of CLI Credential"},"instanceUuid":{"type":"string","description":"Instance Uuid of CLI Credential"},"id":{"type":"string","description":"Id of the CLI Credential"}}},"description":""},"snmpV2cRead":{"type":"array","items":{"type":"object","properties":{"readCommunity":{"type":"string","description":"Snmp RO community"},"description":{"type":"string","description":"Description for Snmp RO community"},"comments":{"type":"string","description":"Comments to identify the SNMP Read credential"},"credentialType":{"type":"string","enum":["GLOBAL","APP"],"description":"Credential type to identify the application that uses the SNMP Read credential"},"instanceTenantId":{"type":"string","description":"Instance Tenant Id of SNMP Read Credential"},"instanceUuid":{"type":"string","description":"Instance Uuid of SNMP Read Credential"},"id":{"type":"string","description":"Id of the SNMP Read Credential"}}},"description":""},"snmpV2cWrite":{"type":"array","items":{"type":"object","properties":{"writeCommunity":{"type":"string","description":"Snmp RW community"},"description":{"type":"string","description":"Description for Snmp RW community"},"comments":{"type":"string","description":"Comments to identify the SNMP Write credential"},"credentialType":{"type":"string","enum":["GLOBAL","APP"],"description":"Credential type to identify the application that uses the SNMP Write credential"},"instanceTenantId":{"type":"string","description":"Instance Tenant Id of SNMP Write Credential"},"instanceUuid":{"type":"string","description":"Instance Uuid of SNMP Write Credential"},"id":{"type":"string","description":"Id of SNMP Write Credential"}}},"description":""},"httpsRead":{"type":"array","items":{"type":"object","properties":{"password":{"type":"string","description":"HTTP(S) Read Password"},"port":{"type":"integer","description":"HTTP(S) Port"},"username":{"type":"string","description":"HTTP(S) Read Username"},"secure":{"type":"boolean","description":"Flag for HTTP(S) Read"},"description":{"type":"string","description":"Description for HTTP(S) Read Credential"},"comments":{"type":"string","description":"Comments to identify the HTTP(S) Read credential"},"credentialType":{"type":"string","enum":["GLOBAL","APP"],"description":"Credential type to identify the application that uses the HTTP(S) Read credential"},"instanceTenantId":{"type":"string","description":"Instance Tenant Id of HTTP(S) Read Credential"},"instanceUuid":{"type":"string","description":"Instance Uuid of HTTP(S) Read Credential"},"id":{"type":"string","description":"Id of the HTTP(S) Read Credential"}}},"description":""},"httpsWrite":{"type":"array","items":{"type":"object","properties":{"password":{"type":"string","description":"HTTP(S) Write Password"},"port":{"type":"integer","description":"HTTP(S) Port"},"username":{"type":"string","description":"HTTP(S) Write Username"},"secure":{"type":"boolean","description":"Flag for HTTP(S) Write"},"description":{"type":"string","description":"Description for HTTP(S) Write Credetntials"},"comments":{"type":"string","description":"Comments to identify the HTTP(S) Write credential"},"credentialType":{"type":"string","enum":["GLOBAL","APP"],"description":"Credential type to identify the application that uses the HTTP(S) Write credential"},"instanceTenantId":{"type":"string","description":"Instance Tenant Id of HTTP(S) Write Credential"},"instanceUuid":{"type":"string","description":"Instance Uuid of HTTP(S) Write Credential"},"id":{"type":"string","description":"Id of the HTTP(S) Write Credential"}}},"description":""},"snmpV3":{"type":"array","items":{"type":"object","properties":{"username":{"type":"string","description":"SNMP V3 Username"},"authPassword":{"type":"string","description":"Auth Password for SNMP V3"},"authType":{"type":"string","description":"SNMP auth protocol. SHA' or 'MD5' "},"privacyPassword":{"type":"string","description":"Privacy Password for SNMP privacy"},"privacyType":{"type":"string","description":"SNMP privacy protocol. 'AES128','AES192','AES256' "},"snmpMode":{"type":"string","description":"Mode of SNMP. 'AUTHPRIV' or 'AUTHNOPRIV' or 'NOAUTHNOPRIV'"},"description":{"type":"string","description":"Description for Snmp V3 Credential"},"comments":{"type":"string","description":"Comments to identify the SNMP V3 credential"},"credentialType":{"type":"string","enum":["GLOBAL","APP"],"description":"Credential type to identify the application that uses the SNMP V3 credential"},"instanceTenantId":{"type":"string","description":"Instance Tenant Id of SNMP V3 Credential"},"instanceUuid":{"type":"string","description":"Instance Tenant Id of SNMP V3 Credential"},"id":{"type":"string","description":"Id of the SNMP V3 Credential"}}},"description":""}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/GetAllGlobalCredentialsVResponse"}}}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"401":{"description":"The client's authentication credentials included with the request are missing or invalid.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}}},"x-rapi-id":"6088-4a03-4b5b-8252","x-rapi-overview":"API to get device credentials' details. It fetches all global credentials of all types at once, without the need to pass any input parameters.","x-rapi-domain":"Operational Tasks","x-rapi-subdomain":"Discovery","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v2/global-credential","x-rapi-publicPath":"/dna/intent/api/v2/global-credential","x-rapi-registerInKONG":true,"x-rapi-banner":[],"__originalOperationId":"getAllGlobalCredentialsV2","method":"get","path":"/dna/intent/api/v2/global-credential"}}