Integration Guide › CA ControlMinder REST API › Update an Account

Update an Account

To update an account, send the HTTP PUT request to the following URL:

https://<host_name>:18443/iam/api/1.0/restapi/environments/ac/endpoints/<endpoint_name>/accounts/<account_name>

host_name

Specifies the host name.

endpoint_name

Specifies the endpoint name.

account_name

Specifies the account name.

The following example shows the HTTP body content to update an account:

<Account>

<Name>myaccount_name</Name>

<Disconnected>true</Disconnected>

<Type>Shared</Type>

<Container>MS SQL Logins</Container>

<PasswordPolicy>default password policy</PasswordPolicy>

<PasswordState>CheckedIn</PasswordState>

<Exclusive>false</Exclusive>

<ChangePasswordOnCheckOut>false</ChangePasswordOnCheckOut>

<ChangePasswordOnCheckIn>false</ChangePasswordOnCheckIn>

<LoginApplicationCheckoutOnly>false</LoginApplicationCheckoutOnly>

<Owner ownerType="Group">my_group</Owner>

</Account>

Name

Specifies the account name.

Disconnected

Specifies if the account is disconnected.

Type

Specifies the type of account.

Container

Specifies the container.

PasswordPolicy

Specifies the password policy that is implemented for the account.

PasswordState

Specifies the password state of the account.

Note: The password state value is specified as Out Of Sync if the password change request fails. For example, the password state value is Out Of Sync if a password reset task is running and the database server is down.

Exclusive

Specifies if the account is exclusive or not.

ChangePasswordOnCheckOut

Specifies if the password is changed when the account is checked out.

ChangePasswordOnCheckIn

Specifies if the password is changed when the account is checked in.

LoginApplicationCheckoutOnly

Specifies if the login application checks out the account.

Owner

Specifies the owner type.