admin_app_targets

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

Overview

Name	admin_app_targets
Type	Resource
Id	okta.users.admin_app_targets

Fields

The following fields are returned by SELECT queries:

list_application_targets_for_application_administrator_role_for_user

An app in the OIN catalog

Name	Datatype	Description
id	string	ID of the app instance. Okta returns this property only for apps not in the OIN catalog.
name	string	App key name. For OIN catalog apps, this is a unique key for the app definition.
_links	object	Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification
category	string	Category for the app in the OIN catalog (example: SOCIAL)
description	string	Description of the app in the OIN catalog
displayName	string	OIN catalog app display name
features	array	Features supported by the app. See app features.
lastUpdated	string (date-time)	Timestamp when the object was last updated (example: 2024-09-19T23:37:37.000Z)
signOnModes	array	Authentication mode for the app. See app signOnMode.
status	string	App status (ACTIVE, INACTIVE)
verificationStatus	string	OIN verification status of the catalog app (example: OKTA_VERIFIED)
website	string	Website of the OIN catalog app

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_application_targets_for_application_administrator_role_for_user	select	userId, roleAssignmentId, subdomain	after, limit	Lists all app targets for an APP_ADMIN role assigned to a user. The response is a list that includes OIN-cataloged apps or app instances. The response payload for an app instance contains the id property, but an OIN-cataloged app payload doesn't.
unassign_app_instance_target_from_admin_role_for_user	delete	userId, roleAssignmentId, appName, appId, subdomain		Unassigns an app instance target from an APP_ADMIN role assignment to an admin user. > Note: You can't remove the last app instance target from a role assignment since this causes an exception. > If you need a role assignment that applies to all apps, delete the APP_ADMIN role assignment and recreate a new one.
unassign_app_target_from_app_admin_role_for_user	delete	userId, roleAssignmentId, appName, subdomain		Unassigns an OIN app target from an APP_ADMIN role assignment to an admin user. > Note: You can't remove the last OIN app target from a role assignment since this causes an exception. > If you need a role assignment that applies to all apps, delete the APP_ADMIN role assignment to the user and recreate a new one.

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
appName	string	Name of the app definition (the OIN catalog app key name)
roleAssignmentId	string	The id of the role assignment
subdomain	string	(default: my-org)
userId	string	ID of an existing Okta user
after	string	The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the Link response header. See Pagination and Link header.
limit	integer	A limit on the number of objects to return

SELECT examples

list_application_targets_for_application_administrator_role_for_user

Lists all app targets for an APP_ADMIN role assigned to a user. The response is a list that includes OIN-cataloged apps or app instances. The response payload for an app instance contains the id property, but an OIN-cataloged app payload doesn't.

SELECT
id,
name,
_links,
category,
description,
displayName,
features,
lastUpdated,
signOnModes,
status,
verificationStatus,
website
FROM okta.users.admin_app_targets
WHERE userId = '{{ userId }}' -- required
AND roleAssignmentId = '{{ roleAssignmentId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND after = '{{ after }}'
AND limit = '{{ limit }}'
;

DELETE examples

unassign_app_instance_target_from_admin_role_for_user

Unassigns an app instance target from an APP_ADMIN role assignment to an admin user.

> Note: You can't remove the last app instance target from a role assignment since this causes an exception.
> If you need a role assignment that applies to all apps, delete the APP_ADMIN role assignment and recreate a new one.

DELETE FROM okta.users.admin_app_targets
WHERE userId = '{{ userId }}' --required
AND roleAssignmentId = '{{ roleAssignmentId }}' --required
AND appName = '{{ appName }}' --required
AND appId = '{{ appId }}' --required
AND subdomain = '{{ subdomain }}' --required
;

unassign_app_target_from_app_admin_role_for_user

Unassigns an OIN app target from an APP_ADMIN role assignment to an admin user.

> Note: You can't remove the last OIN app target from a role assignment since this causes an exception.
> If you need a role assignment that applies to all apps, delete the APP_ADMIN role assignment to the user and recreate a new one.

DELETE FROM okta.users.admin_app_targets
WHERE userId = '{{ userId }}' --required
AND roleAssignmentId = '{{ roleAssignmentId }}' --required
AND appName = '{{ appName }}' --required
AND subdomain = '{{ subdomain }}' --required
;