policy_apps

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

Overview

Name	policy_apps
Type	Resource
Id	okta.policies.policy_apps

Fields

The following fields are returned by SELECT queries:

list_policy_apps

Name	Datatype	Description
id	string	Unique ID for the app instance
_embedded	object	Embedded resources related to the app using the JSON Hypertext Application Language specification. If the expand=user/{userId} query parameter is specified, then the assigned Application User is embedded.
_links	object	Discoverable resources related to the app
accessibility	object	Specifies access settings for the app
created	string (date-time)	Timestamp when the application object was created
expressConfiguration	object	<div class="x-lifecycle-container"><x-lifecycle class="oie"></x-lifecycle></div> Indicates which Express Configuration capabilities the app supports and has enabled
features	array	Enabled app features > Note: See Application Features for app provisioning features.
label	string	User-defined display name for app
lastUpdated	string (date-time)	Timestamp when the application object was last updated
licensing	object	Licenses for the app
orn	string	The Okta resource name (ORN) for the current app instance
profile	object	Contains any valid JSON schema for specifying properties that can be referenced from a request (only available to OAuth 2.0 client apps). For example, add an app manager contact email address or define an allowlist of groups that you can then reference using the Okta Expression Language getFilteredGroups function. > Notes: > * profile isn't encrypted, so don't store sensitive data in it. > * profile doesn't limit the level of nesting in the JSON schema you created, but there is a practical size limit. Okta recommends a JSON schema size of 1 MB or less for best performance.
signOnMode	string	Authentication mode for the app | signOnMode | Description | | ---------- | ----------- | | AUTO_LOGIN | Secure Web Authentication (SWA) | | BASIC_AUTH | HTTP Basic Authentication with Okta Browser Plugin | | BOOKMARK | Just a bookmark (no-authentication) | | BROWSER_PLUGIN | Secure Web Authentication (SWA) with Okta Browser Plugin | | OPENID_CONNECT | Federated Authentication with OpenID Connect (OIDC) | | SAML_1_1 | Federated Authentication with SAML 1.1 WebSSO (not supported for custom apps) | | SAML_2_0 | Federated Authentication with SAML 2.0 WebSSO | | SECURE_PASSWORD_STORE | Secure Web Authentication (SWA) with POST (plugin not required) | | WS_FEDERATION | Federated Authentication with WS-Federation Passive Requestor Profile | Select the signOnMode for your custom app: (AUTO_LOGIN, BASIC_AUTH, BOOKMARK, BROWSER_PLUGIN, OPENID_CONNECT, SAML_1_1, SAML_2_0, SECURE_PASSWORD_STORE, WS_FEDERATION)
status	string	App instance status (ACTIVE, DELETED, INACTIVE)
universalLogout	object	<div class="x-lifecycle-container"><x-lifecycle class="oie"></x-lifecycle></div> Universal Logout properties for the app. These properties are only returned and can't be updated. (example: ACTIVE)
visibility	object	Specifies visibility settings for the app

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_policy_apps	select	policyId, subdomain		Lists all applications mapped to a policy identified by policyId > Note: Use List all resources mapped to a policy to list all applications mapped to a policy.

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
policyId	string	id of the policy
subdomain	string	(default: my-org)

SELECT examples

list_policy_apps

Lists all applications mapped to a policy identified by policyId

> Note: Use List all resources mapped to a policy to list all applications mapped to a policy.

SELECT
id,
_embedded,
_links,
accessibility,
created,
expressConfiguration,
features,
label,
lastUpdated,
licensing,
orn,
profile,
signOnMode,
status,
universalLogout,
visibility
FROM okta.policies.policy_apps
WHERE policyId = '{{ policyId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;