identity_providers

Creates, updates, deletes, gets or lists an identity_providers resource.

Overview

Name	identity_providers
Type	Resource
Id	sumologic.saml.identity_providers

Fields

The following fields are returned by SELECT queries:

getIdentityProviders

A list of SAML configurations in the organization.

Name	Datatype	Description
id	string	Unique identifier of the SAML Identity Provider. (example: 00000000361130F7)
assertionConsumerUrl	string	The URL on Sumo Logic where the IdP will redirect to with its authentication response. (example: https://service.sumologic.com/sumo/saml/consume/9483922, default: )
authnRequestUrl	string	The URL that the identity provider has assigned for Sumo Logic to submit SAML authentication requests to the identity provider. (example: https://www.okta.com/app/sumologic/abxcseyuiwelflkdjh/sso/saml, default: )
certificate	string	Authentication Request Signing Certificate for the user.
configurationName	string	Name of the SSO policy or another name used to describe the policy internally. (example: SumoLogic)
createdAt	string (date-time)	Creation timestamp in UTC in RFC3339 format. (example: 2018-10-16T09:10:00Z)
createdBy	string	Identifier of the user who created the resource. (example: 0000000006743FDD)
debugMode	boolean	True if additional details are included when a user fails to sign in.
disableRequestedAuthnContext	boolean	True if Sumo Logic will include the RequestedAuthnContext element of the SAML AuthnRequests it sends to the identity provider.
emailAttribute	string	The email address of the new user account. (example: attribute/subject, default: )
entityId	string	A unique identifier that is the intended audience of the SAML assertion. (example: https://service.sumologic.com/sumo/saml/9483922, default: )
isRedirectBinding	boolean	True if the SAML binding is of HTTP Redirect type.
issuer	string	The unique URL assigned to the organization by the SAML Identity Provider. (example: http://www.okta.com/abxcseyuiwelflkdjh)
logoutEnabled	boolean	True if users are redirected to a URL after signing out of Sumo Logic.
logoutUrl	string	The URL that users will be redirected to after signing out of Sumo Logic. (example: https://www.sumologic.com, default: )
modifiedAt	string (date-time)	Last modification timestamp in UTC. (example: 2018-10-16T09:10:00Z)
modifiedBy	string	Identifier of the user who last modified the resource. (example: 0000000006743FE8)
onDemandProvisioningEnabled	object
rolesAttribute	string	The role that Sumo Logic will assign to users when they sign in. (example: Sumo_Role, default: )
signAuthnRequest	boolean	True if Sumo Logic will send signed Authn requests to the identity provider.
spInitiatedLoginEnabled	boolean	True if Sumo Logic redirects users to your identity provider with a SAML AuthnRequest when signing in.
spInitiatedLoginPath	string	This property has been deprecated and is no longer used. (example: http://www.okta.com/abxcseyuiwelflkdjh, default: )
x509cert1	string	The certificate is used to verify the signature in SAML assertions.
x509cert2	string	The backup certificate used to verify the signature in SAML assertions when x509cert1 expires. (default: )
x509cert3	string	The backup certificate used to verify the signature in SAML assertions when x509cert1 expires and x509cert2 is empty. (default: )

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
getIdentityProviders	select	region		Get a list of all SAML configurations in the organization.
createIdentityProvider	insert	region, data__configurationName, data__issuer, data__x509cert1		Create a new SAML configuration in the organization.
deleteIdentityProvider	delete	id, region		Delete a SAML configuration with the given identifier from the organization.
updateIdentityProvider	exec	id, region, configurationName, issuer, x509cert1		Update an existing SAML configuration in the organization.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	Identifier of the SAML configuration to update.
region	string	SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2)

SELECT examples

getIdentityProviders

Get a list of all SAML configurations in the organization.

SELECT
id,
assertionConsumerUrl,
authnRequestUrl,
certificate,
configurationName,
createdAt,
createdBy,
debugMode,
disableRequestedAuthnContext,
emailAttribute,
entityId,
isRedirectBinding,
issuer,
logoutEnabled,
logoutUrl,
modifiedAt,
modifiedBy,
onDemandProvisioningEnabled,
rolesAttribute,
signAuthnRequest,
spInitiatedLoginEnabled,
spInitiatedLoginPath,
x509cert1,
x509cert2,
x509cert3
FROM sumologic.saml.identity_providers
WHERE region = '{{ region }}' -- required
;

INSERT examples

createIdentityProvider

Create a new SAML configuration in the organization.

INSERT INTO sumologic.saml.identity_providers (
data__spInitiatedLoginPath,
data__configurationName,
data__issuer,
data__spInitiatedLoginEnabled,
data__authnRequestUrl,
data__x509cert1,
data__x509cert2,
data__x509cert3,
data__onDemandProvisioningEnabled,
data__rolesAttribute,
data__logoutEnabled,
data__logoutUrl,
data__emailAttribute,
data__debugMode,
data__signAuthnRequest,
data__disableRequestedAuthnContext,
data__isRedirectBinding,
region
)
SELECT 
'{{ spInitiatedLoginPath }}',
'{{ configurationName }}' /* required */,
'{{ issuer }}' /* required */,
{{ spInitiatedLoginEnabled }},
'{{ authnRequestUrl }}',
'{{ x509cert1 }}' /* required */,
'{{ x509cert2 }}',
'{{ x509cert3 }}',
'{{ onDemandProvisioningEnabled }}',
'{{ rolesAttribute }}',
{{ logoutEnabled }},
'{{ logoutUrl }}',
'{{ emailAttribute }}',
{{ debugMode }},
{{ signAuthnRequest }},
{{ disableRequestedAuthnContext }},
{{ isRedirectBinding }},
'{{ region }}'
RETURNING
id,
assertionConsumerUrl,
authnRequestUrl,
certificate,
configurationName,
createdAt,
createdBy,
debugMode,
disableRequestedAuthnContext,
emailAttribute,
entityId,
isRedirectBinding,
issuer,
logoutEnabled,
logoutUrl,
modifiedAt,
modifiedBy,
onDemandProvisioningEnabled,
rolesAttribute,
signAuthnRequest,
spInitiatedLoginEnabled,
spInitiatedLoginPath,
x509cert1,
x509cert2,
x509cert3
;

Manifest

# Description fields are for documentation purposes
- name: identity_providers
  props:
    - name: region
      value: string
      description: Required parameter for the identity_providers resource.
    - name: spInitiatedLoginPath
      value: string
      description: |
        This property has been deprecated and is no longer used.
      default: 
    - name: configurationName
      value: string
      description: |
        Name of the SSO policy or another name used to describe the policy internally.
    - name: issuer
      value: string
      description: |
        The unique URL assigned to the organization by the SAML Identity Provider.
    - name: spInitiatedLoginEnabled
      value: boolean
      description: |
        True if Sumo Logic redirects users to your identity provider with a SAML AuthnRequest when signing in.
      default: false
    - name: authnRequestUrl
      value: string
      description: |
        The URL that the identity provider has assigned for Sumo Logic to submit SAML authentication requests to the identity provider.
      default: 
    - name: x509cert1
      value: string
      description: |
        The certificate is used to verify the signature in SAML assertions.
    - name: x509cert2
      value: string
      description: |
        The backup certificate used to verify the signature in SAML assertions when x509cert1 expires.
      default: 
    - name: x509cert3
      value: string
      description: |
        The backup certificate used to verify the signature in SAML assertions when x509cert1 expires and x509cert2 is empty.
      default: 
    - name: onDemandProvisioningEnabled
      value: object
    - name: rolesAttribute
      value: string
      description: |
        The role that Sumo Logic will assign to users when they sign in.
      default: 
    - name: logoutEnabled
      value: boolean
      description: |
        True if users are redirected to a URL after signing out of Sumo Logic.
      default: false
    - name: logoutUrl
      value: string
      description: |
        The URL that users will be redirected to after signing out of Sumo Logic.
      default: 
    - name: emailAttribute
      value: string
      description: |
        The email address of the new user account.
      default: 
    - name: debugMode
      value: boolean
      description: |
        True if additional details are included when a user fails to sign in.
      default: false
    - name: signAuthnRequest
      value: boolean
      description: |
        True if Sumo Logic will send signed Authn requests to the identity provider.
      default: false
    - name: disableRequestedAuthnContext
      value: boolean
      description: |
        True if Sumo Logic will include the RequestedAuthnContext element of the SAML AuthnRequests it sends to the identity provider.
      default: false
    - name: isRedirectBinding
      value: boolean
      description: |
        True if the SAML binding is of HTTP Redirect type.
      default: false

DELETE examples

deleteIdentityProvider

Delete a SAML configuration with the given identifier from the organization.

DELETE FROM sumologic.saml.identity_providers
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

updateIdentityProvider

Update an existing SAML configuration in the organization.

EXEC sumologic.saml.identity_providers.updateIdentityProvider 
@id='{{ id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"spInitiatedLoginPath": "{{ spInitiatedLoginPath }}", 
"configurationName": "{{ configurationName }}", 
"issuer": "{{ issuer }}", 
"spInitiatedLoginEnabled": {{ spInitiatedLoginEnabled }}, 
"authnRequestUrl": "{{ authnRequestUrl }}", 
"x509cert1": "{{ x509cert1 }}", 
"x509cert2": "{{ x509cert2 }}", 
"x509cert3": "{{ x509cert3 }}", 
"onDemandProvisioningEnabled": "{{ onDemandProvisioningEnabled }}", 
"rolesAttribute": "{{ rolesAttribute }}", 
"logoutEnabled": {{ logoutEnabled }}, 
"logoutUrl": "{{ logoutUrl }}", 
"emailAttribute": "{{ emailAttribute }}", 
"debugMode": {{ debugMode }}, 
"signAuthnRequest": {{ signAuthnRequest }}, 
"disableRequestedAuthnContext": {{ disableRequestedAuthnContext }}, 
"isRedirectBinding": {{ isRedirectBinding }}
}'
;