Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

SAML Federation API, REST: Federation.ValidateDomain

Written by
Updated at August 8, 2025

Validates a domain in the specified federation.

HTTP request

POST https://organization-manager.api.cloud.yandex.net/organization-manager/v1/saml/federations/{federationId}/domains/{domain}:validate

Path parameters

Field

Description

federationId

string

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

domain

string

Required field. Domain name to validate for the federation.
Must be a valid domain name (1-253 characters).

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "federationId": "string",
    "domain": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "domain": "string",
    "status": "string",
    "statusCode": "string",
    "createdAt": "string",
    "validatedAt": "string",
    "challenges": [
      {
        "createdAt": "string",
        "updatedAt": "string",
        "type": "string",
        "status": "string",
        // Includes only one of the fields `dnsChallenge`
        "dnsChallenge": {
          "name": "string",
          "type": "string",
          "value": "string"
        }
        // end of the list of possible fields
      }
    ]
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

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

ValidateFederationDomainMetadata

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

Domain

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.

ValidateFederationDomainMetadata

Field

Description

federationId

string

ID of the federation that the domain validation is being performed for.

domain

string

Domain name that is being validated for the federation.

Status

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

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.

Domain

A domain.

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.

DomainChallenge

A domain validation challenge.

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.

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

  • TYPE_UNSPECIFIED
  • TXT: TXT record type.

value

string

Value to set in the DNS record for verification.
Previous
AddDomain
Next
DeleteDomain