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

Create an authentication key

Contributors
PDFs

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

Introduced In: 9.12

Creates an authentication key.

  • security key-manager key create

Required properties

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

Parameters

Name Type In Required Description

security_key_manager.uuid

string

path

True

External key manager UUID

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

_links

self_link

key_id

string

Key identifier.

key_tag

string

Optional parameter to define key-tag for the authentication key, length 0-32 characters.

passphrase

string

Authentication passphrase, length 20-32 characters. May contain the '=' character.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "key_id": "000000000000000002000000000001003aa8ce6a4fea3e466620134bea9510a10000000000000000",
  "key_tag": "Authentication-Key-01",
  "passphrase": "AuthenticationKey_01"
}

Response

Status: 201, Created
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[key_manager_auth_key]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "key_id": "000000000000000002000000000001003aa8ce6a4fea3e466620134bea9510a10000000000000000",
      "key_tag": "Authentication-Key-01",
      "passphrase": "AuthenticationKey_01"
    }
  ]
}

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

65536048

The maximum number of authentication keys are already configured.

65536053

Invalid passphrase length; passphrase must be 20-32 ASCII-range characters.

65536056

The key tag value provided contains invalid characters.

65536056

The key-tag option cannot contain any spaces, tabs or new lines.

65536076

Failed to push authentication key to any registered key servers.

65536160

Unable to determine the current number of configured authentication keys.

65536264

Failed to create authentication key.

65536265

Failed to create a key-id for the authentication key.

65536828

External key management is not enabled for the SVM.

65536856

No key servers found for the SVM.

65536872

Error cleaning up key database after key creation error.

65536896

External key management is not configured on the partner site.

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.

66060289

Failed to store authentication key on key server.

66060304

Invalid key length.

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

href

Name Type Description

href

string
Name Type Description

self

href

key_manager_auth_key

Name Type Description

_links

self_link

key_id

string

Key identifier.

key_tag

string

Optional parameter to define key-tag for the authentication key, length 0-32 characters.

passphrase

string

Authentication passphrase, length 20-32 characters. May contain the '=' character.

_links

Name Type Description

next

href

self

href

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.