SAML Federation API, gRPC: FederationService.GetDomain
Returns the specified domain in the federation.
To get the list of available domains, make a ListDomains request.
gRPC request
rpc GetDomain (GetFederationDomainRequest) returns (Domain)
GetFederationDomainRequest
{
"federation_id": "string",
"domain": "string"
}
|
Field |
Description |
|
federation_id |
string Required field. ID of the federation to get domain information for. The maximum string length in characters is 50. |
|
domain |
string Required field. Domain name to get information for. The string length in characters must be 1-253. |
Domain
{
"domain": "string",
"status": "Status",
"status_code": "string",
"created_at": "google.protobuf.Timestamp",
"validated_at": "google.protobuf.Timestamp",
"challenges": [
{
"created_at": "google.protobuf.Timestamp",
"updated_at": "google.protobuf.Timestamp",
"type": "Type",
"status": "Status",
// Includes only one of the fields `dns_challenge`
"dns_challenge": {
"name": "string",
"type": "Type",
"value": "string"
}
// end of the list of possible fields
}
]
}
A domain.
|
Field |
Description |
|
domain |
string Domain name |
|
status |
enum Status Current status of the domain.
|
|
status_code |
string Optional code providing details about validation errors. |
|
created_at |
Timestamp of domain creation. |
|
validated_at |
Timestamp when the domain was successfully validated. |
|
challenges[] |
List of challenges to confirm domain ownership. |
DomainChallenge
A domain validation challenge.
|
Field |
Description |
|
created_at |
Timestamp of challenge creation. |
|
updated_at |
Timestamp of the last challenge status update. |
|
type |
enum Type Type of the validation challenge.
|
|
status |
enum Status Current status of the challenge.
|
|
dns_challenge |
DNS record configuration for domain verification. Includes only one of the fields Validation challenge payload. Currently supports only DNS records. |
DnsRecord
DNS record data for validation challenges.
|
Field |
Description |
|
name |
string Fully qualified domain name for the record. |
|
type |
enum Type DNS record type (always TXT for current implementation).
|
|
value |
string Value to set in the DNS record for verification. |