Skip to main content

assigned_apps

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

Overview​

Nameassigned_apps
TypeResource
Idokta.groups.assigned_apps

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringUnique ID for the app instance
_embeddedobjectEmbedded 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.
_linksobjectDiscoverable resources related to the app
accessibilityobjectSpecifies access settings for the app
createdstring (date-time)Timestamp when the application object was created
expressConfigurationobject<div class="x-lifecycle-container"><x-lifecycle class="oie"></x-lifecycle></div> Indicates which Express Configuration capabilities the app supports and has enabled
featuresarrayEnabled app features > Note: See Application Features for app provisioning features.
labelstringUser-defined display name for app
lastUpdatedstring (date-time)Timestamp when the application object was last updated
licensingobjectLicenses for the app
ornstringThe Okta resource name (ORN) for the current app instance
profileobjectContains 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.
signOnModestringAuthentication 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)
statusstringApp instance status (ACTIVE, DELETED, INACTIVE)
universalLogoutobject<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)
visibilityobjectSpecifies visibility settings for the app

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_assigned_applications_for_groupselectgroupId, subdomainafter, limitLists all apps that are assigned to a group. See Application Groups API.

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
groupIdstringThe id of the group
subdomainstring(default: my-org)
afterstringSpecifies the pagination cursor for the next page of apps
limitinteger (int32)Specifies the number of app results for a page

SELECT examples​

Lists all apps that are assigned to a group. See Application Groups API.

SELECT
id,
_embedded,
_links,
accessibility,
created,
expressConfiguration,
features,
label,
lastUpdated,
licensing,
orn,
profile,
signOnMode,
status,
universalLogout,
visibility
FROM okta.groups.assigned_apps
WHERE groupId = '{{ groupId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND after = '{{ after }}'
AND limit = '{{ limit }}'
;