v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

samlConfigurationManagement

Update a SAML configuration.

Update an existing SAML configuration in the organization.

put/v1/saml/identityProviders/{id}

Path parameters

idstring required

Identifier of the SAML configuration to update.

Request body

spInitiatedLoginPathstring

This property has been deprecated and is no longer used.

configurationNamestring required

Name of the SSO policy or another name used to describe the policy internally.

issuerstring required

The unique URL assigned to the organization by the SAML Identity Provider.

spInitiatedLoginEnabledboolean

True if Sumo Logic redirects users to your identity provider with a SAML AuthnRequest when signing in.

authnRequestUrlstring

The URL that the identity provider has assigned for Sumo Logic to submit SAML authentication requests to the identity provider.

x509cert1string required

The certificate is used to verify the signature in SAML assertions.

x509cert2string

The backup certificate used to verify the signature in SAML assertions when x509cert1 expires.

x509cert3string

The backup certificate used to verify the signature in SAML assertions when x509cert1 expires and x509cert2 is empty.

rolesAttributestring

The role that Sumo Logic will assign to users when they sign in.

logoutEnabledboolean

True if users are redirected to a URL after signing out of Sumo Logic.

logoutUrlstring

The URL that users will be redirected to after signing out of Sumo Logic.

emailAttributestring

The email address of the new user account.

debugModeboolean

True if additional details are included when a user fails to sign in.

signAuthnRequestboolean

True if Sumo Logic will send signed Authn requests to the identity provider.

disableRequestedAuthnContextboolean

True if Sumo Logic will include the RequestedAuthnContext element of the SAML AuthnRequests it sends to the identity provider.

isRedirectBindingboolean

True if the SAML binding is of HTTP Redirect type.

Example request

{
  "spInitiatedLoginPath": "http://www.okta.com/abxcseyuiwelflkdjh",
  "configurationName": "SumoLogic",
  "issuer": "http://www.okta.com/abxcseyuiwelflkdjh",
  "authnRequestUrl": "https://www.okta.com/app/sumologic/abxcseyuiwelflkdjh/sso/saml",
  "onDemandProvisioningEnabled": {
    "firstNameAttribute": "http://schemas.microsoft.com/ws/2008/06/identity/claims/givenname",
    "lastNameAttribute": "http://schemas.microsoft.com/ws/2008/06/identity/claims/surname"
  },
  "rolesAttribute": "Sumo_Role",
  "logoutUrl": "https://www.sumologic.com",
  "emailAttribute": "attribute/subject"
}

Response

The SAML configuration was successfully modified.

spInitiatedLoginPathstring

This property has been deprecated and is no longer used.

configurationNamestring required

Name of the SSO policy or another name used to describe the policy internally.

issuerstring required

The unique URL assigned to the organization by the SAML Identity Provider.

spInitiatedLoginEnabledboolean

True if Sumo Logic redirects users to your identity provider with a SAML AuthnRequest when signing in.

authnRequestUrlstring

The URL that the identity provider has assigned for Sumo Logic to submit SAML authentication requests to the identity provider.

x509cert1string required

The certificate is used to verify the signature in SAML assertions.

x509cert2string

The backup certificate used to verify the signature in SAML assertions when x509cert1 expires.

x509cert3string

The backup certificate used to verify the signature in SAML assertions when x509cert1 expires and x509cert2 is empty.

rolesAttributestring

The role that Sumo Logic will assign to users when they sign in.

logoutEnabledboolean

True if users are redirected to a URL after signing out of Sumo Logic.

logoutUrlstring

The URL that users will be redirected to after signing out of Sumo Logic.

emailAttributestring

The email address of the new user account.

debugModeboolean

True if additional details are included when a user fails to sign in.

signAuthnRequestboolean

True if Sumo Logic will send signed Authn requests to the identity provider.

disableRequestedAuthnContextboolean

True if Sumo Logic will include the RequestedAuthnContext element of the SAML AuthnRequests it sends to the identity provider.

isRedirectBindingboolean

True if the SAML binding is of HTTP Redirect type.

certificatestring required

Authentication Request Signing Certificate for the user.

createdAtstring date-time required

Creation timestamp in UTC in RFC3339 format.

createdBystring required

Identifier of the user who created the resource.

modifiedAtstring date-time required

Last modification timestamp in UTC.

modifiedBystring required

Identifier of the user who last modified the resource.

idstring required

Unique identifier of the SAML Identity Provider.

assertionConsumerUrlstring

The URL on Sumo Logic where the IdP will redirect to with its authentication response.

entityIdstring

A unique identifier that is the intended audience of the SAML assertion.

metadataUrlstring

The URL to fetch SAML metadata XML.

Example response

{
  "spInitiatedLoginPath": "http://www.okta.com/abxcseyuiwelflkdjh",
  "configurationName": "SumoLogic",
  "issuer": "http://www.okta.com/abxcseyuiwelflkdjh",
  "authnRequestUrl": "https://www.okta.com/app/sumologic/abxcseyuiwelflkdjh/sso/saml",
  "onDemandProvisioningEnabled": {
    "firstNameAttribute": "http://schemas.microsoft.com/ws/2008/06/identity/claims/givenname",
    "lastNameAttribute": "http://schemas.microsoft.com/ws/2008/06/identity/claims/surname"
  },
  "rolesAttribute": "Sumo_Role",
  "logoutUrl": "https://www.sumologic.com",
  "emailAttribute": "attribute/subject",
  "createdAt": "2018-10-16T09:10:00Z",
  "createdBy": "0000000006743FDD",
  "modifiedAt": "2018-10-16T09:10:00Z",
  "modifiedBy": "0000000006743FE8",
  "id": "00000000361130F7",
  "assertionConsumerUrl": "https://service.sumologic.com/sumo/saml/consume/9483922",
  "entityId": "https://service.sumologic.com/sumo/saml/9483922",
  "metadataUrl": "https://api.sumologic.com/api/v1/saml/identityProviders/00000000361130F7/metadata"
}