Retrieve public keys configured for user accounts
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
GET /security/authentication/publickeys
Introduced In: 9.7
Retrieves the public keys configured for user accounts.
Related ONTAP commands
-
security login publickey show
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
certificate_expired |
string |
query |
False |
Filter by certificate_expired
|
obfuscated_fingerprint |
string |
query |
False |
Filter by obfuscated_fingerprint |
certificate_details |
string |
query |
False |
Filter by certificate_details
|
comment |
string |
query |
False |
Filter by comment |
owner.uuid |
string |
query |
False |
Filter by owner.uuid |
owner.name |
string |
query |
False |
Filter by owner.name |
account.name |
string |
query |
False |
Filter by account.name |
certificate |
string |
query |
False |
Filter by certificate
|
index |
integer |
query |
False |
Filter by index
|
public_key |
string |
query |
False |
Filter by public_key |
scope |
string |
query |
False |
Filter by scope |
sha_fingerprint |
string |
query |
False |
Filter by sha_fingerprint |
certificate_revoked |
string |
query |
False |
Filter by certificate_revoked
|
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.
|
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.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_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"
},
"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"
}
]
}
Error
Status: Default, Error
Name | Type | Description |
---|---|---|
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 |
||
self |
_links
Name | Type | Description |
---|---|---|
self |
account_reference
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
User account |
owner
Owner name and UUID that uniquely identifies the public key.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the SVM. This field cannot be specified in a PATCH method. |
uuid |
string |
The unique identifier of the SVM. This field cannot be specified in a PATCH method. |
publickey
The public key for the user account (to access SSH).
Name | Type | Description |
---|---|---|
_links |
||
account |
||
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). |