GET api/v1/admin/identityproviders?Name={Name}

This method returns a list of all identity providers of TYPE=4 (SAML) on the customer’s account according to the name of the identity provider record. For each identity providers it will include all parameters stored for the identity provider. If the Name field is left blank, then no filter will be applied and a full list of identity providers will be returned for the domain

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Name

This is the name of the identity provider to be returned (Leave blank to return all IDP's for this account)

string

Required

Body Parameters

None.

Response Information

Resource Description

Returns the identity provider for the specified name, or a full list of identity providers where null is used (this will include the domain TXT record(s))

ResponseOfListOfIdentityProviderAPI
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfListOfIdentityProviderAPI

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": "120b19d5-f640-4846-8a8b-20f05ec4a08b",
        "Name": "sample string 2",
        "Provider": "sample string 3",
        "Domain": "sample string 4",
        "Enabled": true,
        "Certificate": "sample string 6",
        "Expiry": "2017-10-20T03:06:52.4486327Z",
        "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"
      },
      {
        "ID": "120b19d5-f640-4846-8a8b-20f05ec4a08b",
        "Name": "sample string 2",
        "Provider": "sample string 3",
        "Domain": "sample string 4",
        "Enabled": true,
        "Certificate": "sample string 6",
        "Expiry": "2017-10-20T03:06:52.4486327Z",
        "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:
<ResponseOfListOfIdentityProviderAPI 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>
      <IdentityProviderAPI>
        <ID>120b19d5-f640-4846-8a8b-20f05ec4a08b</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>2017-10-20T03:06:52.4486327Z</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>
      </IdentityProviderAPI>
      <IdentityProviderAPI>
        <ID>120b19d5-f640-4846-8a8b-20f05ec4a08b</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>2017-10-20T03:06:52.4486327Z</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>
      </IdentityProviderAPI>
    </Detail>
  </ResponseData>
</ResponseOfListOfIdentityProviderAPI>