Identity Provider API, REST: Userpool.ListDomains

Field

Description

userpoolId

string

Required field. ID of the userpool to list domains for.

Field

Description

pageSize

string (int64)

The maximum number of results per page to return.

pageToken

string

Page token for pagination.

filter

string

A filter expression that filters resources listed in the response.

Field

Description

domains[]

Domain

List of domains.

nextPageToken

string

Token for getting the next page of the list.

Field

Description

domain

string

Domain name.

status

enum (Status)

Current status of the domain.

• STATUS_UNSPECIFIED: The status is not specified.
• NEED_TO_VALIDATE: The domain needs to be validated.
• VALIDATING: The domain is in the process of being validated.
• VALID: The domain has been successfully validated.
• INVALID: The domain validation has failed.
• DELETING: The domain is in the process of being deleted.

statusCode

string

Optional code providing details about validation errors.

createdAt

string (date-time)

Timestamp when the domain was created.

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).

validatedAt

string (date-time)

Timestamp when the domain was validated.

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).

challenges[]

DomainChallenge

List of challenges associated with this domain.

deletionProtection

boolean

Whether the domain is protected from deletion.

Field

Description

createdAt

string (date-time)

Timestamp when the challenge was created.

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).

updatedAt

string (date-time)

Timestamp when the challenge was last updated.

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).

type

enum (Type)

Type of the challenge.

• TYPE_UNSPECIFIED: The type is not specified.
• DNS_TXT: DNS TXT record challenge.

status

enum (Status)

Current status of the challenge.

• STATUS_UNSPECIFIED: The status is not specified.
• PENDING: The challenge is pending verification.
• PROCESSING: The challenge verification is in progress.
• VALID: The challenge has been successfully verified.
• INVALID: The challenge verification has failed.

dnsChallenge

DnsRecord

DNS record challenge details.

Includes only one of the fields dnsChallenge.

Challenge details.

Field

Description

name

string

Name of the DNS record.

type

enum (Type)

Type of the DNS record.

• TYPE_UNSPECIFIED: The type is not specified.
• TXT: TXT record type.

value

string

Value of the DNS record.