CreateUser - CloudSSO - Alibaba Cloud Documentation Center

Creates a user.

Operation description

This topic provides an example on how to create a user named Alice.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cloudsso:CreateUser	Write	User acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	The ID of the directory.	d-00fc2p61****
UserName	string	Yes	The name of the user. The name must be unique within the directory. The name cannot be changed. The name can contain numbers, letters, and the following special characters: `@_-.` The name can be up to 64 characters in length.	Alice
FirstName	string	No	The first name of the user. The name can be up to 64 characters in length.	Alice
LastName	string	No	The last name of the user. The name can be up to 64 characters in length.	Lee
DisplayName	string	No	The display name of the user. The name can be up to 256 characters in length.	Alice
Description	string	No	The description of the user. The description can be up to 1,024 characters in length.	This is a user.
Email	string	No	The email address of the user. The email address must be unique within the directory. The email address can be up to 128 characters in length.	Alice@example.com
Status	string	No	The status of the user. Valid values: Enabled: The logon of the user is enabled. This is the default value. Disabled: The logon of the user is disabled.	Enabled

Response parameters

Parameter	Type	Description	Example
	object
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 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.	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 user was modified.	2021-10-26T03:03:42Z
LastName	string	The last name of the user.	Lee
RequestId	string	The ID of the request.	F6F90F3D-4502-5877-B80B-97476F6AE2CC

Examples

Sample success responses

JSONformat

{
  "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-26T03:03:42Z",
    "LastName": "Lee"
  },
  "RequestId": "F6F90F3D-4502-5877-B80B-97476F6AE2CC"
}

Error codes

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