All Products
Search

This Product

    CloudSSO:UpdateUser

    Document Center

    CloudSSO:UpdateUser

    Last Updated:Mar 18, 2026

    Modifies information about a user.

    Operation description

    You can modify FirstName, LastName, DisplayName, Email, and Description for a user. You cannot modify UserName for a user.

    Note

    If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify information about a user that is synchronized by using SCIM.

    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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    cloudsso:UpdateUser

    update

    *User

    acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user/{#UserId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DirectoryId

    string

    Yes

    The ID of the directory.

    d-00fc2p61****
    UserId

    string

    Yes

    The ID of the user.

    u-00q8wbq42wiltcrk****
    NewFirstName

    string

    No

    The new first name of the user.

    Alice
    NewLastName

    string

    No

    The new last name of the user.

    Lee
    NewDisplayName

    string

    No

    The new display name of the user.

    AliceLee
    NewDescription

    string

    No

    The new description of the user.

    This is a user.
    NewEmail

    string

    No

    The new email address of the user.

    AliceLee@example.com

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    User

    object

    The information about the user.

    Status

    string

    The status of the user. Valid values:

    • Enabled: The logon of the user is enabled.

    • Disabled: The logon of the user is disabled.

    Enabled
    UserName

    string

    The username of the user.

    Alice
    Email

    string

    The email address of the user.

    AliceLee@example.com
    Description

    string

    The description of the user.

    This is a user.
    UserId

    string

    The ID of the user.

    u-00q8wbq42wiltcrk****
    FirstName

    string

    The first name of the user.

    Alice
    CreateTime

    string

    The time when the user was created. The value is displayed in UTC.

    2021-10-26T03:03:42Z
    ProvisionType

    string

    The type of the user. Valid values:

    • Manual: The user is manually created.

    • Synchronized: The user is synchronized from an external identity provider (IdP).

    Manual
    DisplayName

    string

    The display name of the user.

    Alice
    UpdateTime

    string

    The time when the information about the user was modified. The value is displayed in UTC.

    2021-10-26T07:32:32Z
    LastName

    string

    The last name of the user.

    Lee
    RequestId

    string

    The request ID.

    F44F02EC-70D1-5E51-8E8E-FA9AC4EF952A

    Examples

    Success response

    JSON format

    {
  "User": {
    "Status": "Enabled",
    "UserName": "Alice",
    "Email": "AliceLee@example.com",
    "Description": "This is a user.",
    "UserId": "u-00q8wbq42wiltcrk****",
    "FirstName": "Alice",
    "CreateTime": "2021-10-26T03:03:42Z",
    "ProvisionType": "Manual",
    "DisplayName": "Alice",
    "UpdateTime": "2021-10-26T07:32:32Z",
    "LastName": "Lee"
  },
  "RequestId": "F44F02EC-70D1-5E51-8E8E-FA9AC4EF952A"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.