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

This method will retrieve the identity provider for a particular ID

Request Information

URI Parameters

Name	Description	Type	Additional information
id		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.Admin.SSO.IdentityProviderAPI

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.Admin.SSO.IdentityProviderAPI	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": "86220e02-ebbe-4f34-86d2-8f97238c6fce",
      "Name": "sample string 2",
      "Provider": "sample string 3",
      "Domain": "sample string 4",
      "Enabled": true,
      "Certificate": "sample string 6",
      "Expiry": "2024-04-23T23:15:49.0523572+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>86220e02-ebbe-4f34-86d2-8f97238c6fce</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-04-23T23:15:49.0523572+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>