allowlisted_users

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

Overview

Name	allowlisted_users
Type	Resource
Id	sumologic.saml.allowlisted_users

Fields

The following fields are returned by SELECT queries:

getAllowlistedUsers

A list of allowlisted users from the organization.

Name	Datatype	Description
canManageSaml	boolean	If the user can manage SAML Configurations.
email	string	Email of the user. (example: john@sumologic.com)
firstName	string	First name of the user.
isActive	boolean	Checks if the user is active.
lastLogin	string (date-time)	Timestamp of the last login of the user.
lastName	string	Last name of the user.
userId	string	Unique identifier of the user.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
getAllowlistedUsers	select	region		Get a list of allowlisted users.
createAllowlistedUser	insert	userId, region		Allowlist a user from SAML lockdown allowing them to sign in using a password in addition to SAML.
deleteAllowlistedUser	delete	userId, region		Remove an allowlisted user requiring them to sign in using SAML.

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
region	string	SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2)
userId	string	Identifier of user that will no longer be allowlisted from SAML Lockdown.

SELECT examples

getAllowlistedUsers

Get a list of allowlisted users.

SELECT
canManageSaml,
email,
firstName,
isActive,
lastLogin,
lastName,
userId
FROM sumologic.saml.allowlisted_users
WHERE region = '{{ region }}' -- required
;

INSERT examples

createAllowlistedUser

Allowlist a user from SAML lockdown allowing them to sign in using a password in addition to SAML.

INSERT INTO sumologic.saml.allowlisted_users (
userId,
region
)
SELECT 
'{{ userId }}',
'{{ region }}'
RETURNING
canManageSaml,
email,
firstName,
isActive,
lastLogin,
lastName,
userId
;

Manifest

# Description fields are for documentation purposes
- name: allowlisted_users
  props:
    - name: userId
      value: string
      description: Required parameter for the allowlisted_users resource.
    - name: region
      value: string
      description: Required parameter for the allowlisted_users resource.

DELETE examples

deleteAllowlistedUser

Remove an allowlisted user requiring them to sign in using SAML.

DELETE FROM sumologic.saml.allowlisted_users
WHERE userId = '{{ userId }}' --required
AND region = '{{ region }}' --required
;