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

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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": "e053891d-9550-4770-a545-fcf7bd2c9a79",
      "Name": "sample string 2",
      "Provider": "sample string 3",
      "Domain": "sample string 4",
      "Enabled": true,
      "Certificate": "sample string 6",
      "Expiry": "2024-10-09T23:16:23.8499826+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>e053891d-9550-4770-a545-fcf7bd2c9a79</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>2024-10-09T23:16:23.8499826+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>