GetUser - CloudSSO - Alibaba Cloud Documentation Center

Retrieves information about a specified user.

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:GetUser

get

*User

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

None

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The ID of the user.	u-00q8wbq42wiltcrk****
DirectoryId	string	Yes	The ID of the directory.	d-00fc2p61****

Response elements

Element	Type	Description	Example
	object	The returned data.
User	object	The information about the user.
Status	string	The status of the user. Valid values: Enabled: The user is enabled. Disabled: The user is disabled.	Enabled
UserName	string	The name of the user.	Alice
Email	string	The email address of the user.	Alice@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 time is in Coordinated Universal Time (UTC).	2021-10-26T03:03:42Z
ProvisionType	string	The type of the user. Valid values: Manual: The user is created manually. Synchronized: The user is synchronized from an external source.	Manual
DisplayName	string	The display name of the user.	Alice
UpdateTime	string	The time when the user was last modified. The time is in UTC.	2021-10-26T06:43:55Z
LastName	string	The last name of the user.	Lee
ExternalId	object	The information about the user identifier from an external identity provider.
Id	string	The user identifier from the external identity provider.	c73******a5fdd5
Issuer	string	The channel for external identity synchronization. Only System for Cross-domain Identity Management (SCIM) is supported.	SCIM
Tags	array<object>
	object
Key	string
Value	string
RequestId	string	The ID of the request.	EE42D2C4-A30A-59B7-ACEB-6D22FB44174A

Examples

Success response

JSON format

{
  "User": {
    "Status": "Enabled",
    "UserName": "Alice",
    "Email": "Alice@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-26T06:43:55Z",
    "LastName": "Lee",
    "ExternalId": {
      "Id": "c73******a5fdd5",
      "Issuer": "SCIM"
    },
    "Tags": [
      {
        "Key": "",
        "Value": ""
      }
    ]
  },
  "RequestId": "EE42D2C4-A30A-59B7-ACEB-6D22FB44174A"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.