<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 - deletes an unallocated cryptographic key (i.e. the key specified by keyId that has not been associated with a file object or version) to avoid breaching the unallocated keys limit.

Note: This method takes no parameters.

Detailed description

This API endpoint deletes an unallocated cryptographic key (i.e. the key specified by keyId that has not been associated with a file object or version). This allows the generation of more (unallocated) cryptographic keys and helps avoid breaching the unallocated keys limit (which is 100 per user's session/valid access token).

Note: Unallocated keys typically result from failures in associating a key with a file object (i.e. initializing an Incomplete file object).

Supported roles and conditions

This API endpoint supports requests utilizing Covata user accounts with the following roles (as described in the Organization Administrator's Guide) and conditions:

• Originator, Collaborator and Ad hoc - when this user generated the key specified by the {keyId} of the request's URL.

The Covata Platform's resources available to a Covata user meeting the criteria above is determined by the access token submitted in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

• Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

Returns

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