PUT api/v1/admin/identityprovider

This method modifies an identity provider by ID.

Request Information

URI Parameters

None.

Body Parameters

The identity provider that will be used to update this record

SSO
NameDescriptionTypeAdditional information
ID

ID of this Identity Provider

globally unique identifier

Required

Name

Name of your SSO for this Identity Provider

string

Required

Provider

Name of the Provider

string

Required

LoginUrl

Log In URL

string

Required

LogoutUrl

Log Out URL

string

Required

Certificate

Security Certificate for the Provider

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": "8751b963-dd6d-420d-a178-402e8be231a0",
  "Name": "sample string 2",
  "Provider": "sample string 3",
  "LoginUrl": "sample string 4",
  "LogoutUrl": "sample string 5",
  "Certificate": "sample string 6"
}

application/xml, text/xml

Sample:
<SSO xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Name>sample string 2</Name>
  <Provider>sample string 3</Provider>
  <LoginUrl>sample string 4</LoginUrl>
  <LogoutUrl>sample string 5</LogoutUrl>
  <Certificate>sample string 6</Certificate>
  <ID>8751b963-dd6d-420d-a178-402e8be231a0</ID>
</SSO>

Response Information

Resource Description

ResponseOfDomainTXTRecord
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfDomainTXTRecord

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": {
      "Domain": "sample string 1",
      "DomainTXTString": "sample string 2",
      "errorIDP": {
        "InvalidCert": true,
        "ProviderDup": true,
        "SignonUrl": true,
        "LogoutURL": true
      }
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfDomainTXTRecord 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>
      <Domain>sample string 1</Domain>
      <DomainTXTString>sample string 2</DomainTXTString>
      <errorIDP>
        <InvalidCert>true</InvalidCert>
        <ProviderDup>true</ProviderDup>
        <SignonUrl>true</SignonUrl>
        <LogoutURL>true</LogoutURL>
      </errorIDP>
    </Detail>
  </ResponseData>
</ResponseOfDomainTXTRecord>