SAML Federation API, REST: Federation.ListDomains

Field

Description

federationId

string

Required field. ID of the federation to list domains for.
To get the federation ID, make a FederationService.List request.

Field

Description

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize, the service returns a ListFederationDomainsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

pageToken

string

Page token. To get the next page of results, set pageToken
to the ListFederationDomainsResponse.nextPageToken
returned by a previous list request.

filter

string

A filter expression that filters resources listed in the response.
The expression supports the following operations:

• = for exact match: domain = 'domain-1.com'
• IN for multiple values: status IN ('NEED_TO_VALIDATE', 'VALID')
• contains for domain substring search: domain contains '3'
• AND for combining conditions: status = 'INVALID' AND domain contains '3'

Available fields for filtering:

• domain - domain name
• status - domain validation status

Must be 1-1000 characters long.

Field

Description

domains[]

Domain

List of domains for the specified federation.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListFederationDomainsRequest.pageSize, use the nextPageToken as the value
for the ListFederationDomainsRequest.pageToken query parameter in the next list request.
Each subsequent list request will have its own nextPageToken to continue paging through the results.

Field

Description

domain

string

Domain name

status

enum (Status)

Current status of the domain.

• STATUS_UNSPECIFIED
• NEED_TO_VALIDATE: Domain requires ownership validation.
• VALIDATING: Domain validation is in progress.
• VALID: Domain has been successfully validated and is active.
• INVALID: Domain validation failed (check status_code for details).
• DELETING: Domain is being deleted.

statusCode

string

Optional code providing details about validation errors.

createdAt

string (date-time)

Timestamp of domain creation.

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 successfully validated.
Not set if validation hasn't been completed.

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 to confirm domain ownership.

Field

Description

createdAt

string (date-time)

Timestamp of challenge creation.

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 of the last challenge status update.

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 validation challenge.

• TYPE_UNSPECIFIED
• DNS_TXT: DNS TXT record validation method.

status

enum (Status)

Current status of the challenge.

• STATUS_UNSPECIFIED
• PENDING: Challenge is awaiting completion.
• PROCESSING: Challenge verification is in progress.
• VALID: Challenge has been completed successfully.
• INVALID: Challenge verification failed.

dnsChallenge

DnsRecord

DNS record configuration for domain verification.

Includes only one of the fields dnsChallenge.

Validation challenge payload. Currently supports only DNS records.

Field

Description

name

string

Fully qualified domain name for the record.

type

enum (Type)

DNS record type (always TXT for current implementation).

• TYPE_UNSPECIFIED
• TXT: TXT record type.

value

string

Value to set in the DNS record for verification.