Identity Provider API, REST: User.Create

Field

Description

userpoolId

string

Required field. ID of the userpool to create the user in.

The maximum string length in characters is 50.

username

string

Required field. Username for the new user.

The maximum string length in characters is 254. Value must match the regular expression [a-z0-9A-Z\._-]{1,64}@.{1,256}.

fullName

string

Required field. Full name of the user.

The maximum string length in characters is 256.

givenName

string

First name of the user.

The maximum string length in characters is 256.

familyName

string

Last name of the user.

The maximum string length in characters is 256.

email

string

Email address of the user.

The maximum string length in characters is 254. Value must match the regular expression |(.{3,254}).

phoneNumber

string

Phone number of the user.

The maximum string length in characters is 50.

passwordSpec

PasswordSpec

Password specification. Credentials type. Exactly one of credentials type must be specified.

Includes only one of the fields passwordSpec, passwordHash.

User credentials.

passwordHash

PasswordHash

Password hash. Credentials type. Exactly one of credentials type must be specified.

Includes only one of the fields passwordSpec, passwordHash.

User credentials.

isActive

boolean

Whether the user is active. Default is true.

externalId

string

External identifier for the user.

The maximum string length in characters is 256.

companyName

string

User's company name.

The maximum string length in characters is 256.

department

string

User's department.

The maximum string length in characters is 256.

jobTitle

string

User's job title.

The maximum string length in characters is 256.

employeeId

string

User's employee ID

The maximum string length in characters is 256.

Field

Description

password

string

Required field. The password string.

The maximum string length in characters is 128.

generationProof

string

Proof that the password was generated by the system.

The maximum string length in characters is 128.

Field

Description

passwordHash

string

Required field. The password hash string.

The maximum string length in characters is 128.

passwordHashType

enum (PasswordHashType)

Required field. Type of the password hash.

• AD_MD4: Microsoft Active Directory MD4 hash.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

object

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

object

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.