UserProps
Properties for defining a User.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-cloudsso-user
Initializer
import { UserProps } from '@alicloud/ros-cdk-cloudsso'
const userProps: UserProps = { ... }
Properties
| Name | Type | Description |
|---|---|---|
directoryId |
string | @alicloud/ros-cdk-core.IResolvable |
Property directoryId: The ID of the directory. |
userName |
string | @alicloud/ros-cdk-core.IResolvable |
Property userName: The name of the user. |
description |
string | @alicloud/ros-cdk-core.IResolvable |
Property description: The description of the user. |
displayName |
string | @alicloud/ros-cdk-core.IResolvable |
Property displayName: The display name of the user. |
email |
string | @alicloud/ros-cdk-core.IResolvable |
Property email: The email address of the user. |
firstName |
string | @alicloud/ros-cdk-core.IResolvable |
Property firstName: The first name of the user. |
lastName |
string | @alicloud/ros-cdk-core.IResolvable |
Property lastName: The last name of the user. |
status |
string | @alicloud/ros-cdk-core.IResolvable |
Property status: The status of the user. |
directoryIdRequired
public readonly directoryId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property directoryId: The ID of the directory.
userNameRequired
public readonly userName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property userName: 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.
descriptionOptional
public readonly description: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property description: The description of the user.
The description can be up to 1,024 characters in length.
displayNameOptional
public readonly displayName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property displayName: The display name of the user.
The name can be up to 256 characters in length.
emailOptional
public readonly email: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property email: 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.
firstNameOptional
public readonly firstName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property firstName: The first name of the user.
The name can be up to 64 characters in length.
lastNameOptional
public readonly lastName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property lastName: The last name of the user.
The name can be up to 64 characters in length.
statusOptional
public readonly status: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property status: 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.