Skip to main content
REST API reference
A newer release of this product is available.

Delete an authentication key

PDFs

DELETE /security/key-managers/{security_key_manager.uuid}/auth-keys/{key_id}

Introduced In: 9.12

Deletes an authentication key.

  • security key-manager key delete

Required properties

  • security_key_manager.uuid - UUID of the external key manager.

  • key_id - Key ID of the authentication key to be deleted.

Parameters

Name Type In Required Description

security_key_manager.uuid

string

path

True

External key manager UUID

key_id

string

path

True

Key ID of the authentication key to be deleted.

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

65536828

External key management is not enabled for the SVM.

65536859

Authentication key-Id provided for deletion is in use.

65536860

Key-id provided for deletion is not an authentication key.

65538800

External KMIP DKMIP keymanager not configured on administrative Vserver.

65538801

Internal error while accessing keymanager database.

65538802

The UUID provided is not associated with the administrator SVM key manager.

66060296

Failed to delete key from an external key server.

Also see the table of common errors in the Response body overview section of this documentation.

Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.