All Products
Search

This Product

    Identity as a Service:PatchUser

    Document Center

    Identity as a Service:PatchUser

    Last Updated:Jul 31, 2025

    Modifies an Employee Identity and Access Management (EIAM) account.

    Operation description

    The operation conforms to the HTTP PATCH request method. The value of a parameter is modified only if the parameter is specified in the request.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request syntax

    PATCH /v2/{instanceId}/{applicationId}/users/{userId} HTTP/1.1

    Request parameters

    ParameterTypeRequiredDescriptionExample
    AuthorizationstringYes

    The authentication information. The value is in the Bearer ${access_token} format. Example: Bearer ATxxxx.

    		Bearer AT8csE2seYxxxxxij
    instanceIdstringYes

    The instance ID.

    		idaas_ue2jvisn35ea5lmthk267xxxxx
    applicationIdstringYes

    The application ID.

    		app_mkv7rgt4d7i4u7zqtzev2mxxxx
    userIdstringYes

    The account ID.

    		user_d6sbsuumeta4h66ec3il7yxxxx
    bodyobjectNo

    The request body.

    usernamestringNo

    The name of the account.

    		name001
    displayNamestringNo

    The display name of the account.

    		display_name001
    phoneRegionstringNo

    The country code of the mobile number. For example, the country code of China is 86 without 00 or +. This parameter is required if a mobile number is specified.

    		86
    phoneNumberstringNo

    The mobile number.

    		156xxxxxxx
    phoneNumberVerifiedbooleanNo

    Specifies whether the mobile number is verified. This field is required if a mobile number is specified. If you have no special requirement, set this parameter to true.

    		true
    emailstringNo

    The email address.

    		example@example.com
    emailVerifiedbooleanNo

    Specifies whether the email address is verified. This field is required if an email address is specified. If you have no special requirement, set this parameter to true.

    		true
    customFieldsarray<object>No

    The extended fields of the account.

    customFieldobjectNo

    The extended field.

    operatordeprecatedstringNo

    The type of the operation. This parameter is deprecated. Replace it with operation.

    		replace
    fieldNamestringNo

    The name of the extended field. For more information about the type and valid values of the extended field, see the detailed description of the extended field in the IDaaS console.

    		age
    fieldValuestringNo

    The value of the extended field.

    		test_value
    operationstringNo

    The operation to be performed on the field. Valid values:

    • add
    • replace If you leave the value of the extended field empty, the replace operation is converted to an add operation.
    • remove
    		replace

    Response parameters

    ParameterTypeDescriptionExample
    The current API has no return parameters

    Examples

    Sample success responses

    JSONformat

    {}

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-10-24The internal configuration of the API is changed, but the call is not affectedView Change Details
    2023-04-16The internal configuration of the API is changed, but the call is not affectedView Change Details