Update Identity Provider
PUT {{apiPath}}/environments/{{envID}}/identityProviders/{{providerID}}
To update a property value associated with a selected identity provider resource, use the PUT /environments/{{envID}}/identityProviders/{{providerID}}
operation to modify the specified attribute values. For example, you can change the description
attribute value of the identity provider.
If the client secret has been updated, you must also update the client secret in both the PingOne configuration for the OIDC external identity provider, and the external OpenID provider.
Note: For trademarked identity providers such as Facebook, Google, and LinkedIn, updates to the loginButtonIcon.id
and loginButtonIcon.href
properties are ignored to preserve the identity provider's branding rules.
Prerequisites
- See Identity Provider Management for important overview information.
Request Body
{"name"=>"SAMLIdP", "description"=>"This is s SAML IdP test", "type"=>"SAML", "enabled"=>false, "spEntityId"=>"sp-{$timestamp}", "idpEntityId"=>"idp-{$timestamp}", "ssoBinding"=>"HTTP_POST", "ssoEndpoint"=>"https://idp.com/sso", "authnRequestSigned"=>"false", "idpVerification"=>{"certificates"=>[{"id"=>"{{certID}}"}]}, "spSigning"=>{"key"=>{"id"=>"{{spSigningID}}"}}}
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/identityProviders/a9e4e181-f520-4e6e-af30-d3559781ad1b"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"attributes":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/identityProviders/a9e4e181-f520-4e6e-af30-d3559781ad1b/attributes"}},"id":"a9e4e181-f520-4e6e-af30-d3559781ad1b","type":"SAML","name":"SAMLIdP","description":"This is s SAML IdP test","enabled":false,"environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"createdAt":"2019-06-17T17:20:12.294Z","updatedAt":"2021-06-02T09:24:26.468Z","_embedded":{"attributes":[{"name":"username","value":"${samlAssertion.subject}","update":"EMPTY_ONLY","id":"51a036c6-41ed-44f7-bd1d-eacaa2a1feab","mappingType":"CORE","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"identityProvider":{"id":"a9e4e181-f520-4e6e-af30-d3559781ad1b"},"createdAt":"2019-06-17T17:20:12.294Z","updatedAt":"2019-06-17T17:20:12.294Z"}]},"authnRequestSigned":false,"ssoEndpoint":"https://idp.com/sso","ssoBinding":"HTTP_POST","idpVerification":{"certificates":[{"id":"123f67f8-c56c-4903-9c9b-c4b162e22789"}]},"spEntityId":"sp-1560792011","spSigning":{"key":{"id":"a65318d7-eaa2-4070-bb73-ffe21a6fca06"}},"idpEntityId":"idp-1560792011"}