{"type":"api","title":"Refresh S3 Bucket Key","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/83e8a10367d157243cd1c3e478b807cb81262a3d/a33ad213-9e0a-310c-bc83-54b500237a80","info":{"version":"1.0.0","title":"Cisco Secure Access S3 Bucket Key Rotation API","description":"Refresh the Cisco-managed S3 bucket key in the Secure Access organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"S3 Bucket Key Rotation"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/admin/s3-key-rotation-overview.md","uri":"secure-access-api-reference-s3-key-rotation-overview"}},"openapi":"3.0.2","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"admin/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"admin.iam:write":"Write the Cisco-managed S3 bucket key."}}}}}},"spec":{"summary":"Refresh S3 Bucket Key","description":"Rotate the Cisco-managed S3 bucket key for the organization.","tags":["S3 Bucket Key Rotation","Secure Access"],"operationId":"createS3BucketKey","security":[{"oauthFlow":["admin.iam:write"]}],"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 date and time (ISO 8601-formatted timestamp) when the system returned the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the refreshed Cisco-managed S3 bucket key.","required":["oldKeyId","currentKeyId","secretAccessKey","keyCreationDate"],"properties":{"oldKeyId":{"type":"string","description":"The previous ID of the Cisco-managed S3 bucket key.","example":"AKIAYGSCHXQI2NAWY4UZ"},"currentKeyId":{"type":"string","description":"The ID of the Cisco-managed S3 bucket key.","example":"AKIARB5FPGFNZR3BZAXN"},"secretAccessKey":{"type":"string","description":"The secret for the Cisco-managed S3 bucket key.","example":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY"},"keyCreationDate":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time (ISO 8601-formatted timestamp) when the system created the Cisco-managed S3 bucket key.","example":"2025-03-12T22:00:00"}},"example":{"oldKeyId":"AKIAYGSCHXQI2NAWY4UZ","currentKeyId":"AKIARB5FPGFNZR3BZAXN","secretAccessKey":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY","keyCreationDate":"2025-03-12T22:00:00"},"$$ref":"#/components/schemas/KeyRotation"},"example":{"oldKeyId":"AKIAYGSCHXQI2NAWY4UZ","currentKeyId":"AKIARB5FPGFNZR3BZAXN","secretAccessKey":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY","keyCreationDate":"2025-03-12T22:00:00"}}}},"400":{"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 date and time (ISO 8601-formatted timestamp) when the system returned the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Bad Request","example":"Not found IAM key info for org 12355."},"status":{"type":"integer","description":"The HTTP status code returned in the response.","example":400},"path":{"type":"string","description":"The path of the API request.","example":"/iam/rotate-key"},"timestamp":{"type":"string","description":"The date and time (ISO 8601-formatted timestamp) when the system returned the response.","format":"date-time","example":"2025-03-28T10:54:00"}}}}},"$$ref":"#/components/responses/400Error"},"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 date and time (ISO 8601-formatted timestamp) when the system returned the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Unauthorized","example":"Authorization token is invalid."},"status":{"type":"integer","description":"The HTTP status code returned in the response.","example":401},"path":{"type":"string","description":"The path of the API request.","example":"/iam/rotate-key"},"timestamp":{"type":"string","description":"The date and time (ISO 8601-formatted timestamp) when the system returned the response.","format":"date-time","example":"2025-03-28T10:54:00"}}}}},"$$ref":"#/components/responses/401Error"},"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 date and time (ISO 8601-formatted timestamp) when the system returned the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Forbidden"},"status":{"type":"integer","description":"The HTTP status code returned in the response.","example":403},"path":{"type":"string","description":"The path of the API request.","example":"/iam/rotate-key"},"timestamp":{"type":"string","format":"date-time","description":"The date and time (ISO 8601-formatted timestamp) when the system returned the response.","example":"2025-03-28T10:54:00"}}}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","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 date and time (ISO 8601-formatted timestamp) when the system returned the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Found"},"status":{"type":"integer","description":"The HTTP status code returned in the response.","example":404},"path":{"type":"string","description":"The path of the API request.","example":"/iam/rotate-key"},"timestamp":{"type":"string","description":"The date and time (ISO 8601-formatted timestamp) when the system returned the response.","format":"date-time","example":"2025-03-28T10:54:00"}}}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","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 date and time (ISO 8601-formatted timestamp) when the system returned the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Internal Server Error"},"status":{"type":"integer","description":"The HTTP status code returned in the response.","example":500},"path":{"type":"string","description":"The path of the API request.","example":"/iam/rotate-key"},"timestamp":{"type":"string","format":"date-time","example":"2025-03-28T10:54:00"}}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"createS3BucketKey","method":"post","path":"/iam/rotateKey"}}