Identity Provider API, gRPC: UserpoolService.GetDomain
Returns the specified domain for a userpool.
gRPC request
rpc GetDomain (GetUserpoolDomainRequest) returns (Domain)
GetUserpoolDomainRequest
{
"userpool_id": "string",
"domain": "string"
}
Request to get a domain for a userpool.
|
Field |
Description |
|
userpool_id |
string Required field. ID of the userpool to get a domain for. The maximum string length in characters is 50. |
|
domain |
string Required field. Domain name. 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
}
],
"deletion_protection": "bool"
}
A domain associated with a userpool.
|
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 when the domain was created. |
|
validated_at |
Timestamp when the domain was validated. |
|
challenges[] |
List of challenges associated with this domain. |
|
deletion_protection |
bool Whether the domain is protected from deletion. |
DomainChallenge
A challenge used to validate domain ownership.
|
Field |
Description |
|
created_at |
Timestamp when the challenge was created. |
|
updated_at |
Timestamp when the challenge was last updated. |
|
type |
enum Type Type of the challenge.
|
|
status |
enum Status Current status of the challenge.
|
|
dns_challenge |
DNS record challenge details. Includes only one of the fields Challenge details. |
DnsRecord
DNS record information for domain validation.
|
Field |
Description |
|
name |
string Name of the DNS record. |
|
type |
enum Type Type of the DNS record.
|
|
value |
string Value of the DNS record. |