PUT /v1/saml/identityProviders/{id}
Update an existing SAML configuration in the organization.
Servers
- https://api.au.sumologic.com/api/
- https://api.ca.sumologic.com/api/
- https://api.de.sumologic.com/api/
- https://api.eu.sumologic.com/api/
- https://api.fed.sumologic.com/api/
- https://api.jp.sumologic.com/api/
- https://api.kr.sumologic.com/api/
- https://api.in.sumologic.com/api/
- https://api.sumologic.com/api/
- https://api.us2.sumologic.com/api/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Identifier of the SAML configuration to update. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
onDemandProvisioningEnabled |
Object | No | |
onDemandProvisioningEnabled.firstNameAttribute |
String | No |
First name attribute of the new user account. |
onDemandProvisioningEnabled.lastNameAttribute |
String | No |
Last name attribute of the new user account. |
onDemandProvisioningEnabled.onDemandProvisioningRoles[] |
Array | Yes |
Sumo Logic RBAC roles to be assigned when user accounts are provisioned. |
debugMode |
Boolean | No |
True if additional details are included when a user fails to sign in. Default value: false |
rolesAttribute |
String | No |
The role that Sumo Logic will assign to users when they sign in. |
spInitiatedLoginPath |
String | No |
This property has been deprecated and is no longer used. |
disableRequestedAuthnContext |
Boolean | No |
True if Sumo Logic will include the RequestedAuthnContext element of the SAML AuthnRequests it sends to the identity provider. Default value: false |
isRedirectBinding |
Boolean | No |
True if the SAML binding is of HTTP Redirect type. Default value: false |
logoutUrl |
String | No |
The URL that users will be redirected to after signing out of Sumo Logic. |
emailAttribute |
String | No |
The email address of the new user account. |
authnRequestUrl |
String | No |
The URL that the identity provider has assigned for Sumo Logic to submit SAML authentication requests to the identity provider. |
logoutEnabled |
Boolean | No |
True if users are redirected to a URL after signing out of Sumo Logic. Default value: false |
spInitiatedLoginEnabled |
Boolean | No |
True if Sumo Logic redirects users to your identity provider with a SAML AuthnRequest when signing in. Default value: false |
signAuthnRequest |
Boolean | No |
True if Sumo Logic will send signed Authn requests to the identity provider. Default value: false |
x509cert1 |
String | Yes |
The certificate is used to verify the signature in SAML assertions. |
issuer |
String | Yes |
The unique URL assigned to the organization by the SAML Identity Provider. |
x509cert2 |
String | No |
The backup certificate used to verify the signature in SAML assertions when x509cert1 expires. |
x509cert3 |
String | No |
The backup certificate used to verify the signature in SAML assertions when x509cert1 expires and x509cert2 is empty. |
configurationName |
String | Yes |
Name of the SSO policy or another name used to describe the policy internally. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.