Update a TOTP profile for a user account
Suggest changes
PDFs
PATCH /security/login/totps/{owner.uuid}/{account.name}
Introduced In: 9.13
Updates a TOTP user account.
Related ONTAP commands
-
security login totp modify
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
owner.uuid |
string |
path |
True |
Account owner UUID |
account.name |
string |
path |
True |
User account name |
Request Body
| Name | Type | Description |
|---|---|---|
comment |
string |
Optional comment for the TOTP profile. |
enabled |
boolean |
Status of the TOTP profile. |
scope |
string |
Scope of the entity. Set to "cluster" for cluster owned objects and to "svm" for SVM owned objects. |
sha_fingerprint |
string |
SHA fingerprint for the TOTP secret key. |
Example request
{
"comment": "string",
"enabled": "",
"scope": "string",
"sha_fingerprint": "string"
}Response
Status: 200, OkError
Status: DefaultONTAP Error Response Codes
| Error Code | Description |
|---|---|
144834564 |
Only users with the admin role are allowed to modify the TOTP status. |
144834565 |
Invalid option for the field -enabled |
144834566 |
The user does not have a TOTP configuration available for modification. |
Also see the table of common errors in the Response body overview section of this documentation.
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
account_reference
| Name | Type | Description |
|---|---|---|
name |
string |
User account |
owner
Owner name and UUID that uniquely identifies the TOTP profile.
| Name | Type | Description |
|---|---|---|
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. |
totp
TOTP profile for the user account used to access SSH.
| Name | Type | Description |
|---|---|---|
comment |
string |
Optional comment for the TOTP profile. |
enabled |
boolean |
Status of the TOTP profile. |
scope |
string |
Scope of the entity. Set to "cluster" for cluster owned objects and to "svm" for SVM owned objects. |
sha_fingerprint |
string |
SHA fingerprint for the TOTP secret key. |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
returned_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. |