Update a public key for a user account
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
PATCH /security/authentication/publickeys/{owner.uuid}/{account.name}/{index}
Introduced In: 9.7
Updates the public key and/or certificate for a user account.
Related ONTAP commands
-
security login publickey modify
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).
|
Request Body
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). |
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: 200, Ok
Error
Status: Default
ONTAP Error Response Codes
Error Code | Description |
---|---|
5832707 |
Failed to generate fingerprint for the public key. |
Also see the table of common errors in the Response body overview section of this documentation.
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 |
---|---|---|
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). |