{"type":"model","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/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":{"type":"object","description":"The API key information including the client id and secret.","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"},"clientSecret":{"type":"string","description":"The client secret. The client secret is used with the client ID to attain a token for making API calls.\n","example":"1023845394834890324032948233","$$ref":"#/components/schemas/clientSecret"},"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","clientId","clientSecret","creatorName","creatorEmail","createdAt","expireAt","modifiedAt","lastUsedAt","lastRefreshedAt","scopes"],"example":{"name":"Networks RW","id":"39b18499-4cf3-470d-997b-960e55ee0085","clientId":"1023845394834890324032948234","clientSecret":"1023845394834890324032948233","creatorKeyId":"130eec4c3825463e8d06f1dd9c0b2c19","creatorName":"Name of API key creator","creatorEmail":"","createdAt":"2021-10-02T20:00:00Z","description":"An API key to create and modify network deployments.","expireAt":"2022-01-12T20:00: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/KeyRefreshSecret","title":"KeyRefreshSecret"}}