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

Create a public key for a user account

Contributors
PDFs

POST /security/authentication/publickeys

Introduced In: 9.7

Creates a public key along with an optional certificate for a user account.

Required properties

  • owner.uuid - UUID of the account owner.

  • name - User account name.

  • index - Index number for the public key (where there are multiple keys for the same account).

  • public_key - The publickey details for the creation of the user account.

Optional properties

  • comment - Comment text for the public key.

  • certificate - The certificate in PEM format.

  • security login publickey create

Learn more

Parameters

Name Type In Required Description

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

_links

account

account_reference

certificate

string

Optional certificate for the public key.

certificate_details

string

The details present in the certificate (READONLY).

certificate_expired

string

The expiration details of the certificate (READONLY).

certificate_revoked

string

The revocation details of the certificate (READONLY).

comment

string

Optional comment for the public key.

index

integer

Index number for the public key (where there are multiple keys for the same account).

obfuscated_fingerprint

string

The obfuscated fingerprint for the public key (READONLY).

owner

owner

Owner name and UUID that uniquely identifies the public key.

public_key

string

The public key

scope

string

Scope of the entity. Set to "cluster" for cluster owned objects and to "svm" for SVM owned objects.

sha_fingerprint

string

The SHA fingerprint for the public key (READONLY).
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "account": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "joe.smith"
  },
  "certificate": "string",
  "certificate_details": "string",
  "certificate_expired": "string",
  "certificate_revoked": "string",
  "comment": "string",
  "obfuscated_fingerprint": "string",
  "owner": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "public_key": "string",
  "scope": "string",
  "sha_fingerprint": "string"
}

Response

Status: 201, Created

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default, Error
Name Type Description

error

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

_links

Name Type Description

self

href

account_reference

Name Type Description

_links

_links

name

string

User account

owner

Owner name and UUID that uniquely identifies the public key.

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

publickey

The public key for the user account (to access SSH).

Name Type Description

_links

_links

account

account_reference

certificate

string

Optional certificate for the public key.

certificate_details

string

The details present in the certificate (READONLY).

certificate_expired

string

The expiration details of the certificate (READONLY).

certificate_revoked

string

The revocation details of the certificate (READONLY).

comment

string

Optional comment for the public key.

index

integer

Index number for the public key (where there are multiple keys for the same account).

obfuscated_fingerprint

string

The obfuscated fingerprint for the public key (READONLY).

owner

owner

Owner name and UUID that uniquely identifies the public key.

public_key

string

The public key

scope

string

Scope of the entity. Set to "cluster" for cluster owned objects and to "svm" for SVM owned objects.

sha_fingerprint

string

The SHA fingerprint for the public key (READONLY).

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.