GET api/v1/admin/identityproviders/{ID}/verification

This method tests that your domain contains the TXT string assigned to the identity provider

Request Information

URI Parameters

Name	Description	Type	Additional information
ID	The id of the identity provider to be validated	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Returns the identity provider object. This will include the domain TXT record

ResponseOfIdentityProviderAPI

Name	Description	Type	Additional information
Error		Error	None.
ResponseData		ResponseDataOfIdentityProviderAPI	None.

Response Formats

application/json, text/json

Sample:

{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {
      "ID": "a8916535-6038-4d82-a31c-27b2ea7df906",
      "Name": "sample string 2",
      "Provider": "sample string 3",
      "Domain": "sample string 4",
      "Enabled": true,
      "Certificate": "sample string 6",
      "Expiry": "2025-10-30T07:38:08.8310739+00:00",
      "SignOnURL": "sample string 8",
      "LogoutURL": "sample string 9",
      "SignAuthnRequest": true,
      "SAMLResponseSigned": true,
      "SAMLAssertionSigned": true,
      "SAMLAssertionEncrypted": true,
      "ClockSkew": "00:00:00.1234567",
      "Verified": true,
      "DomainTXTrecord": "sample string 11"
    }
  }
}

application/xml, text/xml

Sample:

<ResponseOfIdentityProviderAPI xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <ID>a8916535-6038-4d82-a31c-27b2ea7df906</ID>
      <Name>sample string 2</Name>
      <Provider>sample string 3</Provider>
      <Domain>sample string 4</Domain>
      <Enabled>true</Enabled>
      <Certificate>sample string 6</Certificate>
      <Expiry>2025-10-30T07:38:08.8310739+00:00</Expiry>
      <SignOnURL>sample string 8</SignOnURL>
      <LogoutURL>sample string 9</LogoutURL>
      <SignAuthnRequest>true</SignAuthnRequest>
      <SAMLResponseSigned>true</SAMLResponseSigned>
      <SAMLAssertionSigned>true</SAMLAssertionSigned>
      <SAMLAssertionEncrypted>true</SAMLAssertionEncrypted>
      <ClockSkew />
      <Verified>true</Verified>
      <DomainTXTrecord>sample string 11</DomainTXTrecord>
    </Detail>
  </ResponseData>
</ResponseOfIdentityProviderAPI>