List API Keys - Cloud Security API

{"type":"api","title":"List API Keys","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/d2a1854d5c0ed9069a7f0bc54a9b813f3075ddc9/58f2e698-d5ac-386a-a48e-d2b53c21bcd9","info":{"version":"2.0.0","title":"Cisco Secure Access Key Admin API","description":"Manage your Secure Access API keys.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"API Keys"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/admin/key-admin-overview.md","uri":"secure-access-api-reference-keyadmin-overview"}},"openapi":"3.0.2","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"admin/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"admin.apikeys:create":"Create admin API keys","admin.apikeys:read":"Read admin API keys","admin.apikeys:delete":"Delete admin API keys","admin.apikeys:update":"Update admin API keys","admin.apikeys:refresh":"Refresh admin API keys"}}}}}},"spec":{"summary":"List API Keys","description":"List the API keys created by your organization.","tags":["API Keys","Secure Access"],"operationId":"getAPIKeys","security":[{"oauthFlow":["admin.apikeys:read"]}],"parameters":[{"in":"query","name":"offset","description":"The place to start reading in the collection. The default offset is 0.","schema":{"type":"integer","format":"int64","default":0},"example":1,"$$ref":"#/components/parameters/offset"},{"in":"query","name":"limit","description":"The number of items to return in the page. The default limit is 0, which\ndesignates no limit.","schema":{"type":"integer","format":"int64","default":0},"example":25,"$$ref":"#/components/parameters/limit"}],"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"List the key information.","properties":{"message":{"type":"string","example":"success","enum":["success","error"],"description":"The status message that describes the response."},"offset":{"type":"integer","format":"int64","description":"The place to start reading in the collection. The default offset is 0.","example":1},"limit":{"type":"integer","format":"int64","description":"The number of items to return in the page. The default limit is 0, which\ndesignates no limit.","example":10},"total":{"type":"integer","format":"int64","example":1,"description":"The total number of items read in the collection."},"keys":{"type":"array","items":{"type":"object","description":"The API key information.","properties":{"name":{"description":"The unique descriptive label for the API key.","type":"string","pattern":"^[a-zA-Z0-9:.-_+=\\s]+$","maxLength":256,"example":"Network deployments","$$ref":"#/components/schemas/name"},"id":{"type":"string","description":"A unique identifier for the key.","example":"39b18499-4cf3-470d-997b-960e55ee0085","$$ref":"#/components/schemas/id"},"clientId":{"type":"string","description":"The client ID associated with the API key. The client ID is used with the client secret to attain a token for making API calls.\n","example":"1023845394834890324032948234","$$ref":"#/components/schemas/clientId"},"creatorKeyId":{"type":"string","description":"The ID of the KeyAdmin key that generated the key.","example":"130eec4c3825463e8d06f1dd9c0b2c19","$$ref":"#/components/schemas/creatorKeyId"},"creatorName":{"type":"string","description":"The name of the user who created the key.","example":"The name of API key creator.","$$ref":"#/components/schemas/creatorName"},"creatorEmail":{"type":"string","description":"The email address of the user who created the key.","example":"yourname@cisco.com","$$ref":"#/components/schemas/creatorEmail"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the key was created, specified in the ISO 8601 format.","example":"2021-10-02T20:00:00Z","$$ref":"#/components/schemas/createdAt"},"description":{"type":"string","maxLength":256,"description":"The text that describes the purpose of the API key.","example":"An API key to create and modify network deployments.","$$ref":"#/components/schemas/description"},"expireAt":{"type":"string","description":"The date and time when the key is set to expire. The timestamp is specified as an ISO 8601 formatted string,\nor an empty string (`''`). An empty string indicates that the key never expires.\n","example":"2022-10-02T20:00:00Z","$$ref":"#/components/schemas/expireAt"},"modifiedAt":{"type":"string","format":"date-time","description":"The date and time when the key was updated, specified in the ISO 8601 format.","example":"2021-11-02T20:00:00Z","$$ref":"#/components/schemas/modifiedAt"},"lastUsedAt":{"type":"string","format":"date-time","description":"The date and time when the key was last used, specified in the ISO 8601 format.","example":"2021-10-02T20:00:00","$$ref":"#/components/schemas/lastUsedAt"},"lastRefreshedAt":{"type":"string","format":"date-time","description":"The date and time when the key was last refreshed, specified in the ISO 8601 format.","example":"2021-12-02T20:00:00Z","$$ref":"#/components/schemas/lastRefreshedAt"},"scopes":{"type":"array","description":"A list of scopes and permissions attached to the API key.","items":{"type":"string"},"example":["deployments.networks:read","deployments.networks:write"],"$$ref":"#/components/schemas/scopes"}},"required":["id","creatorName","creatorEmail","createdAt","expireAt","modifiedAt","lastUsedAt","lastRefreshedAt","scopes"],"example":{"name":"Networks RW","id":"39b18499-4cf3-470d-997b-960e55ee0085","clientId":"1023845394834890324032948234","creatorName":"Name of API key creator","creatorEmail":"yourname@cisco.com","createdAt":"2021-10-02T20:00:00Z","description":"An API key to create and modify network deployments.","expireAt":"2023-12-05T19:34:00Z","lastUsedAt":"2021-10-05T19:34:00Z","modifiedAt":"2021-10-02T20:00:00Z","lastRefreshedAt":"2021-10-02T20:00:00Z","scopes":["deployments.networks:read","deployments.networks:write"]},"$$ref":"#/components/schemas/KeyForList"}}}},"example":{"message":"success","offset":0,"limit":100,"total":40,"keys":[{"id":"39b18499-4cf3-470d-997b-960e55ee0085","creatorName":"Name of the API key creator","creatorEmail":"yourname@cisco.com","createdAt":"2021-10-02T20:00:00","description":"An API key to create and modify network deployments.","expireAt":"2022-01-12T20:00:00Z00:00","lastUsedAt":"2021-10-05T19:34:00","modifiedAt":"2021-10-02T20:00:00","lastRefreshedAt":"2021-10-02T20:00:00Z","scopes":["deployments.networks:read","deployments.networks:write"]}]}}},"$$ref":"#/components/responses/KeysResponseList"},"401":{"description":"Unauthorized","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"},"WWW-Authenticate":{"schema":{"type":"string"},"description":"A challenge response for the intended resource."}},"content":{"application/json":{"schema":{"type":"object","description":"The request is not authorized.","properties":{"message":{"type":"string","example":"success","enum":["success","error"]},"description":{"type":"string"}},"example":{"message":"error","description":"Unauthorized request"}}}},"$$ref":"#/components/responses/unauthorizedError"},"403":{"description":"Forbidden","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The request is forbidden.","properties":{"message":{"type":"string","example":"success","enum":["success","error"]},"description":{"type":"string"}},"example":{"message":"error","description":"Forbidden"}}}},"$$ref":"#/components/responses/forbiddenError"},"503":{"description":"Service Unavailable","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The request failed because a dependent service is temporarily unavailable.","properties":{"message":{"type":"string","example":"error","enum":["success","error"]},"description":{"type":"string"}},"example":{"message":"error","description":"Service Unavailable"}}}},"$$ref":"#/components/responses/serviceUnavailableError"},"default":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"}},"example":{"message":"error","description":"Bad Request"}}}},"$$ref":"#/components/responses/invalidRequestError"}},"__originalOperationId":"getAPIKeys","method":"get","path":"/apiKeys"}}