List Certificates for Device - Cloud Security API

{"type":"api","title":"List Certificates for Device","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/40c74b80-600f-321b-b515-00f16a3f3d22","info":{"version":"1.0.0","title":"Cisco Secure Access Zero Trust User Devices API","description":"Get the certificate information and user summaries for the zero trust user devices.\nRevoke the certificates on the zero trust user device.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"ACME Client Certificates"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/admin/zta-users-overview.md","uri":"secure-access-api-reference-zta-users-overview"}},"openapi":"3.0.3","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.ztna.certificates:read":"Read the certificate metadata for the users.","admin.ztna.users:read":"Read the user summaries.","admin.ztna.devices:read":"Read the certificate metadata for the user device","admin.ztna.enrollment:write":"Revoke the certificates for the user device"}}}}}},"spec":{"summary":"List Certificates for Device","description":"Get the latest ACME-issued certificate for the zero trust user and device.","tags":["ACME Client Certificates","Secure Access"],"operationId":"getZtaDeviceCertificates","security":[{"oauthFlow":["admin.ztna.devices:read"]}],"parameters":[{"name":"userId","description":"The ID of the user.","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier for the user.","readOnly":true,"example":"1251001730","$$ref":"#/components/schemas/userId"},"$$ref":"#/components/parameters/userId"},{"name":"deviceId","description":"The ID of the user device.","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the user device.","readOnly":true,"example":"0ace1b5f6104a466","$$ref":"#/components/schemas/deviceId"},"$$ref":"#/components/parameters/deviceId"}],"responses":{"200":{"description":"ZTNA Device Certificate Response","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 ID and certificates for the user device.","properties":{"deviceId":{"type":"string","description":"The unique identifier of the user device.","readOnly":true,"example":"0ace1b5f6104a466","$$ref":"#/components/schemas/deviceId"},"certificates":{"description":"A list of ACME-issued certificates issued for the user device. Only the most recently issued certificate is present.","type":"array","items":{"type":"object","description":"The properties of the device certificate.","required":["certificateId","status","createdAt","expiresAt"],"properties":{"certificateId":{"description":"The unique identifier of the ACME-issued certificate.","type":"string","$$ref":"#/components/schemas/certificateId"},"status":{"description":"The status of the ACME-issued certificate.","type":"string","enum":["active","expired","revoked"]},"createdAt":{"description":"The date and time (in ISO 8601 format) when the ACME-issued certificate was created.","type":"string","format":"date-time","example":"2024-07-02T18:46:38Z"},"expiresAt":{"description":"The date and time (in ISO 8601 format) when the ACME-issued certificate expires.","type":"string","format":"date-time","example":"2024-07-02T18:46:38Z"},"revokedAt":{"description":"The date and time (in ISO 8601 format) when the ACME-issued certificate was revoked.","type":"string","format":"date-time","example":"2024-07-02T18:46:38Z"}},"example":{"certificateId":"54321","status":"active","createdAt":"2024-05-15T21:36:32Z","expiresAt":"2024-07-15T21:36:32Z"},"$$ref":"#/components/schemas/certificate"},"$$ref":"#/components/schemas/certificates"}},"example":{"deviceId":"0ace1b5f6104a466","certificates":[{"certificateId":"54321","status":"active","createdAt":"2023-08-15T21:36:32Z","expiresAt":"2023-09-15T21:36:32Z"}]},"$$ref":"#/components/schemas/deviceCertificateInfo"}}},"$$ref":"#/components/responses/deviceCertificateResponse"},"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 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"},"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"}},"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"},"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 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 the resource doesn't exist.","properties":{"message":{"type":"string","example":"error","enum":["success","error"]},"description":{"type":"string"}},"example":{"message":"error","description":"Not Found"}}}},"$$ref":"#/components/responses/notFoundError"},"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 timestamp of 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"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"$$ref":"#/components/responses/internalServerError"}},"__originalOperationId":"getZtaDeviceCertificates","method":"get","path":"/ztna/users/{userId}/devices/{deviceId}/certificates"}}