device_os_accounts

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

Overview

Name	device_os_accounts
Type	Resource
Id	okta.devices.device_os_accounts

Fields

The following fields are returned by SELECT queries:

get_device_osaccount

Name	Datatype	Description
id	string	Unique identifier for the OS account
_embedded	object	Embedded resources related to the OS account
_links	object
created	string (date-time)	Timestamp when the OS account was created
deviceId	string	Unique identifier of the device this OS account belongs to
lastSeenAt	string (date-time)	Timestamp when the OS account was last seen
lastUpdated	string (date-time)	Timestamp when the OS account was last updated
platform	string	OS platform for OS accounts (desktop platforms only) (MACOS, WINDOWS)
profile	object
resourceAlternateId	string
resourceDisplayName	object	Display name of the OS account
resourceId	string	Alternate key for the id
resourceType	string	(default: DOSAccount)
status	string	Status of the OS account (ACTIVE, DELETED)

list_device_osaccounts

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_device_osaccount	select	deviceId, osAccountId, subdomain	expand	Retrieves an OS account by osAccountId for a device
list_device_osaccounts	select	deviceId, subdomain	expand	Lists all OS accounts for a device by deviceId

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
deviceId	string	id of the device
osAccountId	string	The unique identifier for the OS account (example: dao3qgkIEKjhNZudR0g4)
subdomain	string	(default: my-org)
expand	array	Comma-separated list of related resources to include in the _embedded attribute. Supported values are users and account_linked_enrollments.

SELECT examples

get_device_osaccount

Retrieves an OS account by osAccountId for a device

SELECT
id,
_embedded,
_links,
created,
deviceId,
lastSeenAt,
lastUpdated,
platform,
profile,
resourceAlternateId,
resourceDisplayName,
resourceId,
resourceType,
status
FROM okta.devices.device_os_accounts
WHERE deviceId = '{{ deviceId }}' -- required
AND osAccountId = '{{ osAccountId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND expand = '{{ expand }}'
;

list_device_osaccounts

Lists all OS accounts for a device by deviceId

SELECT
*
FROM okta.devices.device_os_accounts
WHERE deviceId = '{{ deviceId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND expand = '{{ expand }}'
;