Skip to main content

auto_assign_admin_app_setting

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

Overview

Nameauto_assign_admin_app_setting
TypeResource
Idokta.org.auto_assign_admin_app_setting

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
autoAssignAdminAppSettingbooleanAutomatically assigns the Okta Admin Console to the user when an admin role is assigned

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_auto_assign_admin_app_settingselectsubdomainRetrieves the org setting to automatically assign the Okta Admin Console when an admin role is assigned
update_auto_assign_admin_app_settingupdatesubdomainUpdates the org setting to automatically assign the Okta Admin Console when an admin role is assigned

> Note: This setting doesn't apply to the SUPER_ADMIN role.
> When you assign the SUPER_ADMIN role to a user, the Admin Console is always assigned to the user regardless of the autoAssignAdminAppSetting setting.

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.

NameDatatypeDescription
subdomainstringThe 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

Retrieves the org setting to automatically assign the Okta Admin Console when an admin role is assigned

SELECT
autoAssignAdminAppSetting
FROM okta.org.auto_assign_admin_app_setting
WHERE subdomain = '{{ subdomain }}' -- required
;

UPDATE examples

Updates the org setting to automatically assign the Okta Admin Console when an admin role is assigned

> Note: This setting doesn't apply to the SUPER_ADMIN role.
> When you assign the SUPER_ADMIN role to a user, the Admin Console is always assigned to the user regardless of the autoAssignAdminAppSetting setting.

UPDATE okta.org.auto_assign_admin_app_setting
SET
data__autoAssignAdminAppSetting = {{ autoAssignAdminAppSetting }}
WHERE
subdomain = '{{ subdomain }}' --required
RETURNING
autoAssignAdminAppSetting
;