CreateUserRequest

import type { CreateUserRequest } from "https://aws-api.deno.dev/v0.3/services/connect.ts?docs=full";

interface CreateUserRequest {

DirectoryUserId?: string | null;

HierarchyGroupId?: string | null;

IdentityInfo?: UserIdentityInfo | null;

InstanceId: string;

Password?: string | null;

PhoneConfig: UserPhoneConfig;

RoutingProfileId: string;

SecurityProfileIds: string[];

Tags?: {

[key: string]: string | null | undefined;

} | null;

Username: string;

}

§Properties

DirectoryUserId?: string | null

[src]

The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

HierarchyGroupId?: string | null

[src]

The identifier of the hierarchy group for the user.

IdentityInfo?: UserIdentityInfo | null

[src]

The information about the identity of the user.

InstanceId: string

[src]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Password?: string | null

[src]

The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

PhoneConfig: UserPhoneConfig

[src]

The phone settings for the user.

RoutingProfileId: string

[src]

The identifier of the routing profile for the user.

SecurityProfileIds: string[]

[src]

The identifier of the security profile for the user.

Tags?: {

[key: string]: string | null | undefined;

} | null

[src]

One or more tags.

Username: string

[src]

The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.@]+.