PUT api/v2/admin/identityproviders/{id}

This method modifies an identity provider by ID.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ID of the Identity Provider to be updated	globally unique identifier	Required

Body Parameters

The new data for the Identity Provider

TwoSms.CustomerPortalRole.API.Admin.SSO.SSO

Name	Description	Type	Additional 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": "55093f13-cf9c-46ac-93ad-d0b409045b89",
  "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>55093f13-cf9c-46ac-93ad-d0b409045b89</ID>
</SSO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'TwoSms.CustomerPortalRole.API.Admin.SSO.SSO'.

Response Information

Resource Description

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

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.Admin.SSO.IdentityProviderDetails	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": {
      "EntityID": "sample string 1",
      "ReplyURL": "sample string 2",
      "Domain": "sample string 3",
      "DomainTXTString": "sample string 4",
      "errorIDP": {
        "InvalidCert": true,
        "ProviderDup": true,
        "SignonUrl": true,
        "LogoutURL": true
      }
    }
  }
}

application/xml, text/xml

Sample:

<ResponseOfIdentityProviderDetails 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 3</Domain>
      <DomainTXTString>sample string 4</DomainTXTString>
      <errorIDP>
        <InvalidCert>true</InvalidCert>
        <ProviderDup>true</ProviderDup>
        <SignonUrl>true</SignonUrl>
        <LogoutURL>true</LogoutURL>
      </errorIDP>
      <EntityID>sample string 1</EntityID>
      <ReplyURL>sample string 2</ReplyURL>
    </Detail>
  </ResponseData>
</ResponseOfIdentityProviderDetails>