Change User Password

Change User Password

All the listed privileges are required -

Privileges Description
GLOBAL_CONFIG_MANAGEMENT Caller should have permission to this privilege to change the password of AD User.
Request
URI
POST
https://{api_host}/rest/external/v1/ad-users-or-groups/action/change-user-password
COPY
Request Body
ADUserChangePasswordSpec of type(s) application/json
Required
{
    "domain": "example.com",
    "key_id": "ut0yGq7CbhtBUGfW3ngjkvjQ2cc=",
    "new_encrypted_password": "4TGdfggfwrrGUPSg4/JK/tYub7lUI8pGtyHd/ty5g8h5=",
    "old_encrypted_password": "9QYxpdXrcrOGPSSz1/K/pJu8QlYT7pDkaKg/rb3hlw4=",
    "protected_password_key": "Qvvjglg5iZinyuldroueo/hQFyqydMMDJPmfYGgIebqxbU9chJ9I8iM9SCBRHSkSW9y+RMQOfC",
    "username": "testuser or [email protected]"
}
string
domain
Optional

The domain of user. Note that domain is optional if UPN is supplied.

string
key_id
Required

The keyId of the cluster's SSO KeyPair used to encrypt the password key.

string
new_encrypted_password
Required

New password for the user in encrypted format.

string
old_encrypted_password
Required

Old password for the user in encrypted format.

string
protected_password_key
Required

Decryption key for the password. This key is itself encrypted with cluster's SSO keypair.

string
username
Required

The username or UPN.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ADUserInfo of type(s) */*
{
    "domain": "example.com",
    "group_guids": [
        "5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA",
        "6H8S6Y4-35D3-6534-5ERC-A678E3YG4FAD"
    ],
    "group_sids": [
        "S-1-5-21-544",
        "S-1-5-21-1111111111-2222222222-3333333333-513"
    ],
    "user_guid": "5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA",
    "user_principal_name": "[email protected]",
    "user_sid": "S-1-5-21-544",
    "username": "testuser"
}
string
domain
Optional

DNS name of the domain in which this user or group belongs to.

array of string
group_guids
Optional

Guids of the user's groups in RFC 4122 format.

array of string
group_sids
Optional

List of unique SIDs of the groups, this user or group belongs to.

string
user_guid
Optional

GUID of the user in RFC 4122 format.

string
user_principal_name
Optional

User Principal name(UPN) of this user.

string
user_sid
Optional

Unique SID representing this AD User.

string
username
Optional

Username of this user.


400

Bad Request

Operation doesn't return any data structure

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure