Skip to main content

ICognitoIdentityProviderAdminUpdateUserAttributesRequest

Interface in AWS.CognitoIdentityProvider

Interface for AdminUpdateUserAttributes requests.

Ancestors

Properties

ClientMetadata

property ClientMetadata: TDictionary<string, string>

Specifies a map of key-value pairs that you can provide as input for any custom workflows that this action triggers.

Use AddClientMetadata to populate values.

UserAttributes

property UserAttributes: TList<ICognitoIdentityProviderAttributeType>

Type: ICognitoIdentityProviderAttributeType

Specifies a list of name-value pairs containing user attributes and attribute values to be set for the user to be created.

For custom attributes, you must prefix the attribute name with custom:.

Username

property Username: string

Specify the Username of the user.

UserPoolId

property UserPoolId: string

Specify the ID of the user pool.

Methods

AddClientMetadata

procedure AddClientMetadata(const AKey, AValue: string);

Add a key-value pair to ClientMetadata.

Parameters

NameDescription
AKeySpecify a key for the value.
AValueSpecify a value.

AddUserAttribute

function AddUserAttribute(const AName: string; const AValue: string = ''): Integer;

Add a name-value pair to UserAttributes.

Parameters

NameDescription
ANameSpecify the name of the user attribute to add.
AValueSpecify the value of the user attribute to add.

Returns

The index of the added user attribute.