Skip to main content

Update the user account password

Contributors
PDFs

POST /security/authentication/password

Introduced In: 9.6

Updates the password for a user account.

Required parameters

  • name - User account name.

  • password - New password for the user account.

Optional parameters

  • owner.name or owner.uuid - Name or UUID of the SVM for an SVM-scoped user account.

  • password_hash_algorithm - Optional property that specifies the password hash algorithm used to generate a hash of the user's password for password matching. Default value is "sha512".

  • security login password

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

name

string

The user account name whose password is being modified.

owner

owner

Owner name and UUID that uniquely identifies the user account. This field is optional and valid only when a cluster administrator is executing the API to uniquely identify the account whose password is being modified. The "owner" field is not required to be specified for SVM user accounts trying to modify their password.

password

string

The password string

password_hash_algorithm

string

Optional property that specifies the password hash algorithm used to generate a hash of the user's password for password matching.
Example request 
{
  "name": "string",
  "owner": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "password": "string",
  "password_hash_algorithm": "sha512"
}

Response

Status: 201, Created

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

7077918

The password cannot contain the username.

7077919

The minimum length for new password does not meet the policy.

7077920

The new password must have both letters and numbers.

7077921

The minimum number of special characters required do not meet the policy.

7077924

The new password must be different than last N passwords.

7077925

The new password must be different to the old password.

7077940

The password exceeds maximum supported length.

7077941

Defined password composition exceeds the maximum password length of 128 characters.

Also see the table of common errors in the Response body overview section of this documentation.

Name Type Description

error

returned_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

owner

Owner name and UUID that uniquely identifies the user account. This field is optional and valid only when a cluster administrator is executing the API to uniquely identify the account whose password is being modified. The "owner" field is not required to be specified for SVM user accounts trying to modify their password.

Name Type Description

_links

_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.

account_password

The password object

Name Type Description

name

string

The user account name whose password is being modified.

owner

owner

Owner name and UUID that uniquely identifies the user account. This field is optional and valid only when a cluster administrator is executing the API to uniquely identify the account whose password is being modified. The "owner" field is not required to be specified for SVM user accounts trying to modify their password.

password

string

The password string

password_hash_algorithm

string

Optional property that specifies the password hash algorithm used to generate a hash of the user's password for password matching.

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.