All Products
Search

This Product

    Identity as a Service:PatchUser

    Document Center

    Identity as a Service:PatchUser

    Last Updated:Mar 30, 2026

    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.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request syntax

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

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    instanceId

    string

    Yes

    The instance ID.

    idaas_ue2jvisn35ea5lmthk267xxxxx
    applicationId

    string

    Yes

    The application ID.

    app_mkv7rgt4d7i4u7zqtzev2mxxxx
    userId

    string

    Yes

    The account ID.

    user_d6sbsuumeta4h66ec3il7yxxxx

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Authorization

    string

    Yes

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

    Bearer AT8csE2seYxxxxxij
    body

    object

    No

    The request body.

    user_001
    username

    string

    No

    The name of the account.

    name001
    displayName

    string

    No

    The display name of the account.

    display_name001
    phoneRegion

    string

    No

    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
    phoneNumber

    string

    No

    The mobile number.

    156xxxxxxx
    phoneNumberVerified

    boolean

    No

    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
    email

    string

    No

    The email address.

    example@example.com
    emailVerified

    boolean

    No

    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
    customFields

    array<object>

    No

    The extended fields of the account.

    object

    No

    The extended field.

    operator deprecated

    string

    No

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

    replace
    fieldName

    string

    No

    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
    fieldValue

    string

    No

    The value of the extended field.

    test_value
    operation

    string

    No

    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 elements

    Element

    Type

    Description

    Example

    None defined.

    Examples

    Success response

    JSON format

    {}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.