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
SSOName | 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": "8a202ea3-6a68-4ad0-9f52-2f6fcdeb9d4a", "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>8a202ea3-6a68-4ad0-9f52-2f6fcdeb9d4a</ID> </SSO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseOfIdentityProviderDetailsName | Description | Type | Additional information |
---|---|---|---|
Error | Error |
None. |
|
ResponseData | ResponseDataOfIdentityProviderDetails |
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>