features

Creates, updates, deletes, gets or lists a features resource.

Overview

Name	features
Type	Resource
Id	okta.apps.features

Fields

The following fields are returned by SELECT queries:

get_feature_for_application

Name	Datatype	Description
name	string	Key name of the feature | Feature name | Description | | --------- | ------------- | | USER_PROVISIONING | User profiles are pushed from Okta to the third-party app. Represents the To App provisioning feature setting in the Admin Console. | | INBOUND_PROVISIONING | User profiles are imported from the third-party app into Okta. This feature represents the To Okta provisioning feature setting in the Admin Console. | Select the feature: (USER_PROVISIONING, INBOUND_PROVISIONING) (example: USER_PROVISIONING)
_links	object	Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
description	string	Description of the feature (example: Settings for provisioning users from Okta to a downstream app)
status	string	Setting status (DISABLED, ENABLED) (default: DISABLED, example: ENABLED)

list_features_for_application

The Feature object is used to configure app feature settings.

Name	Datatype	Description
name	string	Key name of the feature | Feature name | Description | | --------- | ------------- | | USER_PROVISIONING | User profiles are pushed from Okta to the third-party app. Represents the To App provisioning feature setting in the Admin Console. | | INBOUND_PROVISIONING | User profiles are imported from the third-party app into Okta. This feature represents the To Okta provisioning feature setting in the Admin Console. | Select the feature: (USER_PROVISIONING, INBOUND_PROVISIONING) (example: USER_PROVISIONING)
_links	object	Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
description	string	Description of the feature (example: Settings for provisioning users from Okta to a downstream app)
status	string	Setting status (DISABLED, ENABLED) (default: DISABLED, example: ENABLED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_feature_for_application	select	appId, featureName, subdomain		Retrieves a Feature object for an app
list_features_for_application	select	appId, subdomain		Lists all features for an app > Note: This request returns an error if provisioning isn't enabled for the app. > To set up provisioning, see Update the default provisioning connection.
update_feature_for_application	replace	appId, featureName, subdomain, importSettings, importRules		Updates a Feature object for an app > Note: This endpoint supports partial updates.

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
appId	string	Application ID
featureName	string	Name of the Feature
subdomain	string	(default: my-org)

SELECT examples

get_feature_for_application

Retrieves a Feature object for an app

SELECT
name,
_links,
description,
status
FROM okta.apps.features
WHERE appId = '{{ appId }}' -- required
AND featureName = '{{ featureName }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

list_features_for_application

Lists all features for an app
> Note: This request returns an error if provisioning isn't enabled for the app.
> To set up provisioning, see Update the default provisioning connection.

SELECT
name,
_links,
description,
status
FROM okta.apps.features
WHERE appId = '{{ appId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

REPLACE examples

update_feature_for_application

Updates a Feature object for an app
> Note: This endpoint supports partial updates.

REPLACE okta.apps.features
SET 
create = '{{ create }}',
update = '{{ update }}',
importRules = '{{ importRules }}',
importSettings = '{{ importSettings }}'
WHERE 
appId = '{{ appId }}' --required
AND featureName = '{{ featureName }}' --required
AND subdomain = '{{ subdomain }}' --required
AND importSettings = '{{ importSettings }}' --required
AND importRules = '{{ importRules }}' --required
RETURNING
name,
_links,
description,
status;