API Reference

Modify the specified user basic information

Changes the information for a single user. An owner must always have web access, so disabling web access for an owner is not allowed.

For local_user category user, If you do not plan to change the category, then you MUST exclude category, auth_method_id parameter.

For local_user category user, if you plan to change it into sso_user category user, then you MUST include category=sso_user, auth_method_id (with value > 0) parameters.
Here auth_method_id value comes from auth method id returned from GET /api/open/v1/authmethods API.
Since sso_user category user depends on external login credentials, so you MUST exclude encrypted_pwd, encrypted_iv and change_pwd_login parameters.

For ad_user and ad_group category user, you MUST exclude auth_method_id, encrypted_pwd, encrypted_iv and change_pwd_login parameters.

For sso_user category user, if you plan to change its auth method, then you ONLY need to include auth_method_id (with value > 0).
Here auth_method_id value comes from auth method id returned from GET /api/open/v1/authmethods API.
Since sso_user category user depends on external credentials, so you MUST exclude encrypted_pwd, encrypted_iv and change_pwd_login parameters.

For sso_user category user, if you plan to change it into local_user category user, then you MUST include category=local_user, encrypted_pwd, encrypted_iv parameters
and exclude auth_method_id parameter.
Since local_user depends on local login credentials, so you MUST include encrypted_pwd, encrypted_iv parameters. Of course, if you want the user to change its password on
next login, then you also can include change_pwd_login parameter.

For sso_group category user, you MUST exclude auth_method_id, encrypted_pwd, encrypted_iv and change_pwd_login parameters.

Log in to see full request history
Path Params
int32
required
0 to 2147483647

Unique id for a resource in decimal in int32.

Body Params
boolean

SOS capability settings of the user.

boolean

Web access capability settings of the user.

boolean

Status settings of the user.

string

[Added in v3.28.0] Encrypted password with your negotiaged aes_key in base64 encoding, namely base64(aes(your_password)).
The original password also must satisfy the rules specified in your password policy settingon your onpremise system.
Only valid for local_user.

string

[Added in v3.28.0] Symmetric encryption iv in base64 encoding.
Only valid for local_user.

boolean

[Added in v3.28.0] Request to change the password when next login.
Only valid for local_user.

integer

[Added in v3.32.0] The id for auth method.

User category, used when switch local_user to sso_user, or inverse

Responses

Language
Credentials
OAuth2
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json