GET api/v1/admin/identityproviders/{id}

This method will retrieve the identity provider for a particular ID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

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": "23a29b23-fedd-4084-938f-7b81ac9671cb",
      "Name": "sample string 2",
      "Provider": "sample string 3",
      "Domain": "sample string 4",
      "Enabled": true,
      "Certificate": "sample string 6",
      "Expiry": "2024-12-22T09:55:46.3659142+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>23a29b23-fedd-4084-938f-7b81ac9671cb</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-12-22T09:55:46.3659142+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>