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

Retrieve public keys configured for user accounts

Contributors
PDFs

GET /security/authentication/publickeys

Introduced In: 9.7

Retrieves the public keys configured for user accounts.

  • security login publickey show

Learn more

Parameters

Name Type In Required Description

sha_fingerprint

string

query

False

Filter by sha_fingerprint

comment

string

query

False

Filter by comment

scope

string

query

False

Filter by scope

obfuscated_fingerprint

string

query

False

Filter by obfuscated_fingerprint

account.name

string

query

False

Filter by account.name

owner.uuid

string

query

False

Filter by owner.uuid

owner.name

string

query

False

Filter by owner.name

index

integer

query

False

Filter by index

  • Max value: 99

  • Min value: 0

public_key

string

query

False

Filter by public_key

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Max value: 120

  • Min value: 0

  • Default value: 1

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[publickey]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "account": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "joe.smith"
      },
      "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"
    }
  ]
}

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

next

href

self

href

_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

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.