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:

list

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	region		Get a list of allowlisted users.
delete	delete	user_id, region		Remove an allowlisted user requiring them to sign in using SAML.
add	exec	userId, region		Allowlist a user from SAML lockdown allowing them to sign in using a password in addition to 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	Sumo Logic deployment (au, ca, ch, de, eu, fed, in, jp, kr, us1, us2). Resolved from the SUMOLOGIC_ENVIRONMENT environment variable when it is set (x-stackQL-envVar, the same variable the Terraform provider reads); otherwise defaults to us2. A WHERE region = '...' value always takes precedence. (enum: [au, ca, ch, de, eu, fed, in, jp, kr, us1, us2], default: us2, x-stackQL-envVar: SUMOLOGIC_ENVIRONMENT)
userId	string	Identifier of the user.
user_id	string	Identifier of user that will no longer be allowlisted from SAML Lockdown. (wire: userId)

SELECT examples

list

Get a list of allowlisted users.

SELECT
user_id,
first_name,
last_name,
can_manage_saml,
email,
is_active,
last_login
FROM sumologic.saml.allowlisted_users
WHERE region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;

DELETE examples

delete

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

DELETE FROM sumologic.saml.allowlisted_users
WHERE user_id = '{{ user_id }}' --required
AND region = '{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set
;

Lifecycle Methods

EXEC variables use wire (API) names.

add

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

EXEC sumologic.saml.allowlisted_users.add 
@userId='{{ userId }}' --required, 
@region='{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set
;