UserProps
Properties for defining a User.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-edsuser-user
Initializer
import { UserProps } from '@alicloud/ros-cdk-edsuser'
const userProps: UserProps = { ... }
Properties
| Name | Type | Description |
|---|---|---|
endUserId | string | @alicloud/ros-cdk-core.IResolvable | Property endUserId: The name of the end user. |
autoLockTime | string | @alicloud/ros-cdk-core.IResolvable | Property autoLockTime: The date when the account is automatically locked. |
businessChannel | string | @alicloud/ros-cdk-core.IResolvable | Property businessChannel: The business channel. |
email | string | @alicloud/ros-cdk-core.IResolvable | Property email: The email address of the end user. |
isLocalAdmin | boolean | @alicloud/ros-cdk-core.IResolvable | Property isLocalAdmin: Whether to set this convenient account as a local administrator. |
orgId | string | @alicloud/ros-cdk-core.IResolvable | Property orgId: The organization to which the end user belongs. |
ownerType | string | @alicloud/ros-cdk-core.IResolvable | Property ownerType: The type of the account ownership. |
password | string | @alicloud/ros-cdk-core.IResolvable | Property password: The initial password. |
passwordExpireDays | string | @alicloud/ros-cdk-core.IResolvable | Property passwordExpireDays: The default password is valid indefinitely. |
phone | string | @alicloud/ros-cdk-core.IResolvable | Property phone: Mobile numbers are not supported on the international site. |
realNickName | string | @alicloud/ros-cdk-core.IResolvable | Property realNickName: The display name of the user. |
remark | string | @alicloud/ros-cdk-core.IResolvable | Property remark: The remarks of the end user. |
endUserIdRequired
public readonly endUserId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property endUserId: The name of the end user.
The name must be 3 to 24 characters in length, and can contain lowercase letters, digits, and underscores (_).
autoLockTimeOptional
public readonly autoLockTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property autoLockTime: The date when the account is automatically locked.
Format: yyyy-MM-dd HH:mm:ss.
businessChannelOptional
public readonly businessChannel: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property businessChannel: The business channel.
emailOptional
public readonly email: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property email: The email address of the end user.
The email address is used to receive notifications about events such as desktop assignment. You must specify an email address or a mobile number to receive notifications.
isLocalAdminOptional
public readonly isLocalAdmin: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
Property isLocalAdmin: Whether to set this convenient account as a local administrator.
orgIdOptional
public readonly orgId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property orgId: The organization to which the end user belongs.
ownerTypeOptional
public readonly ownerType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property ownerType: The type of the account ownership.
Enumeration Value: CreateFromManager Normal
passwordOptional
public readonly password: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property password: The initial password.
If this parameter is left empty, an email for password reset is sent to the specified email address.
passwordExpireDaysOptional
public readonly passwordExpireDays: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property passwordExpireDays: The default password is valid indefinitely.
This parameter can be used to set a validity period of 30 to 365 days. When the password expires, the end user must change the password before logging in again.
This feature is currently in invitation-only testing. To try it, submit a ticket to enable it.
phoneOptional
public readonly phone: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property phone: Mobile numbers are not supported on the international site.
realNickNameOptional
public readonly realNickName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property realNickName: The display name of the user.
remarkOptional
public readonly remark: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property remark: The remarks of the end user.