opt_in_status

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

Overview

Name	opt_in_status
Type	Resource
Id	okta.iam.opt_in_status

Fields

The following fields are returned by SELECT queries:

get_opt_in_status

Name	Datatype	Description
_links	object
optInStatus	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_opt_in_status	select	subdomain		Retrieves the opt-in status of the Admin Console from RAMP
opt_in	exec	subdomain		Opts in the Admin Console to RAMP
opt_out	exec	subdomain		Opts out the Admin Console from RAMP

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
subdomain	string	The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains. (default: my-org)

SELECT examples

get_opt_in_status

Retrieves the opt-in status of the Admin Console from RAMP

SELECT
_links,
optInStatus
FROM okta.iam.opt_in_status
WHERE subdomain = '{{ subdomain }}' -- required
;

Lifecycle Methods

opt_in

Opts in the Admin Console to RAMP

EXEC okta.iam.opt_in_status.opt_in 
@subdomain='{{ subdomain }}' --required
;

opt_out

Opts out the Admin Console from RAMP

EXEC okta.iam.opt_in_status.opt_out 
@subdomain='{{ subdomain }}' --required
;