device_assurance_policies

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

Overview

Name	device_assurance_policies
Type	Resource
Id	okta.device_assurances.device_assurance_policies

Fields

The following fields are returned by SELECT queries:

list_device_assurance_policies

Name	Datatype	Description
id	string
name	string	Display name of the device assurance policy
_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.
createdBy	string
createdDate	string
devicePostureChecks	object	<x-lifecycle-container><x-lifecycle class="ea"></x-lifecycle></x-lifecycle-container>Represents the Device Posture Checks configuration for the device assurance policy
displayRemediationMode	string	<x-lifecycle-container><x-lifecycle class="ea"></x-lifecycle></x-lifecycle-container>Represents the remediation mode of this device assurance policy when users are denied access due to device noncompliance (example: SHOW)
gracePeriod	object	<x-lifecycle-container><x-lifecycle class="ea"></x-lifecycle></x-lifecycle-container>Represents the Grace Period configuration for the device assurance policy
lastUpdate	string
lastUpdatedBy	string
platform	string

get_device_assurance_policy

Name	Datatype	Description
id	string
name	string	Display name of the device assurance policy
_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.
createdBy	string
createdDate	string
devicePostureChecks	object	<x-lifecycle-container><x-lifecycle class="ea"></x-lifecycle></x-lifecycle-container>Represents the Device Posture Checks configuration for the device assurance policy
displayRemediationMode	string	<x-lifecycle-container><x-lifecycle class="ea"></x-lifecycle></x-lifecycle-container>Represents the remediation mode of this device assurance policy when users are denied access due to device noncompliance (example: SHOW)
gracePeriod	object	<x-lifecycle-container><x-lifecycle class="ea"></x-lifecycle></x-lifecycle-container>Represents the Grace Period configuration for the device assurance policy
lastUpdate	string
lastUpdatedBy	string
platform	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_device_assurance_policies	select	subdomain		Lists all device assurance policies
get_device_assurance_policy	select	subdomain		Retrieves a device assurance policy by deviceAssuranceId
create_device_assurance_policy	insert	subdomain		Creates a new device assurance policy
replace_device_assurance_policy	replace	subdomain		Replaces a device assurance policy by deviceAssuranceId
delete_device_assurance_policy	delete	subdomain		Deletes a device assurance policy by deviceAssuranceId. If the device assurance policy is currently being used in the org Authentication Policies, the delete will not be allowed.

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
subdomain	string	The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains. (default: my-org)

SELECT examples

list_device_assurance_policies

Lists all device assurance policies

SELECT
id,
name,
_links,
createdBy,
createdDate,
devicePostureChecks,
displayRemediationMode,
gracePeriod,
lastUpdate,
lastUpdatedBy,
platform
FROM okta.device_assurances.device_assurance_policies
WHERE subdomain = '{{ subdomain }}' -- required;

get_device_assurance_policy

Retrieves a device assurance policy by deviceAssuranceId

SELECT
id,
name,
_links,
createdBy,
createdDate,
devicePostureChecks,
displayRemediationMode,
gracePeriod,
lastUpdate,
lastUpdatedBy,
platform
FROM okta.device_assurances.device_assurance_policies
WHERE subdomain = '{{ subdomain }}' -- required;

INSERT examples

create_device_assurance_policy

Creates a new device assurance policy

INSERT INTO okta.device_assurances.device_assurance_policies (
data__devicePostureChecks,
data__displayRemediationMode,
data__gracePeriod,
data__name,
data__platform,
subdomain
)
SELECT 
'{{ devicePostureChecks }}',
'{{ displayRemediationMode }}',
'{{ gracePeriod }}',
'{{ name }}',
'{{ platform }}',
'{{ subdomain }}'
RETURNING
id,
name,
_links,
createdBy,
createdDate,
devicePostureChecks,
displayRemediationMode,
gracePeriod,
lastUpdate,
lastUpdatedBy,
platform
;

Manifest

# Description fields are for documentation purposes
- name: device_assurance_policies
  props:
    - name: subdomain
      value: string
      description: Required parameter for the device_assurance_policies resource.
    - name: devicePostureChecks
      value: object
      description: >
        <x-lifecycle-container><x-lifecycle class="ea"></x-lifecycle></x-lifecycle-container>Represents the Device Posture Checks configuration for the device assurance policy
        
    - name: displayRemediationMode
      value: string
      description: >
        <x-lifecycle-container><x-lifecycle class="ea"></x-lifecycle></x-lifecycle-container>Represents the remediation mode of this device assurance policy when users are denied access due to device noncompliance
        
      valid_values: ['HIDE', 'SHOW']
    - name: gracePeriod
      value: object
      description: >
        <x-lifecycle-container><x-lifecycle class="ea"></x-lifecycle></x-lifecycle-container>Represents the Grace Period configuration for the device assurance policy
        
    - name: name
      value: string
      description: >
        Display name of the device assurance policy
        
    - name: platform
      value: string
      valid_values: ['ANDROID', 'CHROMEOS', 'IOS', 'MACOS', 'WINDOWS']

REPLACE examples

replace_device_assurance_policy

Replaces a device assurance policy by deviceAssuranceId

REPLACE okta.device_assurances.device_assurance_policies
SET 
data__devicePostureChecks = '{{ devicePostureChecks }}',
data__displayRemediationMode = '{{ displayRemediationMode }}',
data__gracePeriod = '{{ gracePeriod }}',
data__name = '{{ name }}',
data__platform = '{{ platform }}'
WHERE 
subdomain = '{{ subdomain }}' --required
RETURNING
id,
name,
_links,
createdBy,
createdDate,
devicePostureChecks,
displayRemediationMode,
gracePeriod,
lastUpdate,
lastUpdatedBy,
platform;

DELETE examples

delete_device_assurance_policy

Deletes a device assurance policy by deviceAssuranceId. If the device assurance policy is currently being used in the org Authentication Policies, the delete will not be allowed.

DELETE FROM okta.device_assurances.device_assurance_policies
WHERE subdomain = '{{ subdomain }}' --required;