<access-service>/api/v1/keys/{keyId}

URL structure

https://access-service.xy-company.com/api/v1/keys/{keyId}

where {keyId} is the ID of a cryptographic key.

Supported methods and overview

• DELETE - used to delete a cryptographic key that has not been associated with a Secure Object, which thereby frees up the unallocated key limit once this has been reached.

Note: This method takes no parameters.

Detailed description

This API endpoint deletes an unallocated cryptographic key (i.e. a key which has not been associated with a Secure Object), which thereby frees up the default limit of 10 unallocated keys that can be generated per user's session/valid access token.

Unallocated keys typically result from failures in associating a key with a Secure Object (i.e. initializing an Incomplete Secure Object).

Supported roles and conditions

This API endpoint supports the following Covata user roles (as described in the Covata Platform Administrator's Guide) and conditions:

• Originator, Collaborator and Ad hoc - a Covata user with any of these roles can call this endpoint on a key they generated.

The Covata Platform's resources available to one of these Covata users (above) is determined by the access token passed in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

• Authorization: Bearer a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6

Returns

If the request succeeded, then an HTTP response status 200 OK is returned.