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

Update a public key for a user account

PDFs

PATCH /security/authentication/publickeys/{owner.uuid}/{account.name}/{index}

Updates the public key for a user account.

Learn more

Parameters

Name Type In Required Description

owner.uuid

string

path

True

Account owner UUID

account.name

string

path

True

User account name

index

integer

path

True

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

  • Max value: 99

  • Min value: 0

Request Body

Name Type Description

_links

_links

comment

string

Optional comment for the public key.

obfuscated_fingerprint

string

The obfuscated fingerprint for the public key (READONLY).

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"
    }
  },
  "comment": "string",
  "obfuscated_fingerprint": "string",
  "public_key": "string",
  "scope": "string",
  "sha_fingerprint": "string"
}

Response

Status: 200, Ok

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

comment

string

Optional comment for the public key.

obfuscated_fingerprint

string

The obfuscated fingerprint for the public key (READONLY).

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.