org.openapitools.client.api

Class DeviceApi

java.lang.Object

org.openapitools.client.api.DeviceApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-07-14T23:40:43.026Z[Etc/UTC]")
public class DeviceApi
extends Object

Constructor Summary

Constructors

Constructor and Description
DeviceApi()
DeviceApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	activateDevice(String deviceId) Activate a Device Activates a Device by setting its status to ACTIVE by `deviceId`.
void	activateDevice(String deviceId, Map<String,String> additionalHeaders) Activate a Device Activates a Device by setting its status to ACTIVE by `deviceId`.
void	deactivateDevice(String deviceId) Deactivate a Device Deactivates a Device by setting its status to DEACTIVATED by `deviceId`.
void	deactivateDevice(String deviceId, Map<String,String> additionalHeaders) Deactivate a Device Deactivates a Device by setting its status to DEACTIVATED by `deviceId`.
void	deleteDevice(String deviceId) Delete a Device Deletes (permanently) a device by `deviceId` if it has a status of `DEACTIVATED`.
void	deleteDevice(String deviceId, Map<String,String> additionalHeaders) Delete a Device Deletes (permanently) a device by `deviceId` if it has a status of `DEACTIVATED`.
ApiClient	getApiClient()
Device	getDevice(String deviceId) Retrieve a Device Retrieves a device by `deviceId`
Device	getDevice(String deviceId, Map<String,String> additionalHeaders) Retrieve a Device Retrieves a device by `deviceId`
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<Device>	listDevices(String after, Integer limit, String search, String expand) List all Devices Lists all devices with pagination support.
List<Device>	listDevices(String after, Integer limit, String search, String expand, Map<String,String> additionalHeaders) List all Devices Lists all devices with pagination support.
List<DeviceUser>	listDeviceUsers(String deviceId) List all Users for a Device Lists all Users for a Device by `deviceId`
List<DeviceUser>	listDeviceUsers(String deviceId, Map<String,String> additionalHeaders) List all Users for a Device Lists all Users for a Device by `deviceId`
void	setApiClient(ApiClient apiClient)
void	suspendDevice(String deviceId) Suspend a Device Suspends a Device by setting its status to ACTIVE.
void	suspendDevice(String deviceId, Map<String,String> additionalHeaders) Suspend a Device Suspends a Device by setting its status to ACTIVE.
void	unsuspendDevice(String deviceId) Unsuspend a Device Unsuspends a Device by returning its `status` to ACTIVE.
void	unsuspendDevice(String deviceId, Map<String,String> additionalHeaders) Unsuspend a Device Unsuspends a Device by returning its `status` to ACTIVE.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeviceApi

public DeviceApi()

DeviceApi

public DeviceApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activateDevice

public void activateDevice(String deviceId)
                    throws ApiException

Activate a Device Activates a Device by setting its status to ACTIVE by `deviceId`. Activated devices are used to create and delete Device user links.

Parameters:

deviceId - `id` of the device (required)

Throws:

ApiException - if fails to make API call

activateDevice

public void activateDevice(String deviceId,
                           Map<String,String> additionalHeaders)
                    throws ApiException

Activate a Device Activates a Device by setting its status to ACTIVE by `deviceId`. Activated devices are used to create and delete Device user links.

Parameters:

deviceId - `id` of the device (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deactivateDevice

public void deactivateDevice(String deviceId)
                      throws ApiException

Deactivate a Device Deactivates a Device by setting its status to DEACTIVATED by `deviceId`. Deactivation causes a Device to lose all device user links. Set the Device status to DEACTIVATED before deleting it. > **Note:** When deactivating a Device, keep in mind the following: - Device deactivation is a destructive operation for device factors and client certificates. Device reenrollment using Okta Verify allows end users to set up new factors on the device. - Device deletion removes the device record from Okta. Reenrollment creates a new device record.

Parameters:

deviceId - `id` of the device (required)

Throws:

ApiException - if fails to make API call

deactivateDevice

public void deactivateDevice(String deviceId,
                             Map<String,String> additionalHeaders)
                      throws ApiException

Deactivate a Device Deactivates a Device by setting its status to DEACTIVATED by `deviceId`. Deactivation causes a Device to lose all device user links. Set the Device status to DEACTIVATED before deleting it. > **Note:** When deactivating a Device, keep in mind the following: - Device deactivation is a destructive operation for device factors and client certificates. Device reenrollment using Okta Verify allows end users to set up new factors on the device. - Device deletion removes the device record from Okta. Reenrollment creates a new device record.

Parameters:

deviceId - `id` of the device (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deleteDevice

public void deleteDevice(String deviceId)
                  throws ApiException

Delete a Device Deletes (permanently) a device by `deviceId` if it has a status of `DEACTIVATED`. You can transition the device to `DEACTIVATED` status using the [Deactivate a Device](#tag/Device/operation/deactivateDevice) endpoint. This request is destructive and deletes all of the profile data related to the device. Once deleted, device data can't be recovered. However, reenrollment creates a new device record. > **Note:** Attempts to delete a device that isn't in a `DEACTIVATED` state raise an error.

Parameters:

deviceId - `id` of the device (required)

Throws:

ApiException - if fails to make API call

deleteDevice

public void deleteDevice(String deviceId,
                         Map<String,String> additionalHeaders)
                  throws ApiException

Delete a Device Deletes (permanently) a device by `deviceId` if it has a status of `DEACTIVATED`. You can transition the device to `DEACTIVATED` status using the [Deactivate a Device](#tag/Device/operation/deactivateDevice) endpoint. This request is destructive and deletes all of the profile data related to the device. Once deleted, device data can't be recovered. However, reenrollment creates a new device record. > **Note:** Attempts to delete a device that isn't in a `DEACTIVATED` state raise an error.

Parameters:

deviceId - `id` of the device (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getDevice

public Device getDevice(String deviceId)
                 throws ApiException

Retrieve a Device Retrieves a device by `deviceId`

Parameters:

deviceId - `id` of the device (required)

Returns:

Device

Throws:

ApiException - if fails to make API call

getDevice

public Device getDevice(String deviceId,
                        Map<String,String> additionalHeaders)
                 throws ApiException

Retrieve a Device Retrieves a device by `deviceId`

Parameters:

deviceId - `id` of the device (required)

additionalHeaders - additionalHeaders for this call

Returns:

Device

Throws:

ApiException - if fails to make API call

listDeviceUsers

public List<DeviceUser> listDeviceUsers(String deviceId)
                                 throws ApiException

List all Users for a Device Lists all Users for a Device by `deviceId`

Parameters:

deviceId - `id` of the device (required)

Returns:

List<DeviceUser>

Throws:

ApiException - if fails to make API call

listDeviceUsers

public List<DeviceUser> listDeviceUsers(String deviceId,
                                        Map<String,String> additionalHeaders)
                                 throws ApiException

List all Users for a Device Lists all Users for a Device by `deviceId`

Parameters:

deviceId - `id` of the device (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<DeviceUser>

Throws:

ApiException - if fails to make API call

listDevices

public List<Device> listDevices(String after,
                                Integer limit,
                                String search,
                                String expand)
                         throws ApiException

List all Devices Lists all devices with pagination support. You can return a subset of Devices that match a supported search criteria using the `search` query parameter. Searches for devices based on the properties specified in the `search` parameter conforming SCIM filter specifications (case-insensitive). This data is eventually consistent. The API returns different results depending on specified queries in the request. Empty list is returned if no objects match `search` request. > **Note:** Listing devices with `search` should not be used as a part of any critical flows—such as authentication or updates—to prevent potential data loss. `search` results may not reflect the latest information, as this endpoint uses a search index which may not be up-to-date with recent updates to the object. <br> Don't use search results directly for record updates, as the data might be stale and therefore overwrite newer data, resulting in data loss. <br> Use an `id` lookup for records that you update to ensure your results contain the latest data. This operation requires [URL encoding](https://www.w3.org/TR/html4/interact/forms.html#h-17.13.4.1). For example, `search=profile.displayName eq \"Bob\"` is encoded as `search=profile.displayName%20eq%20%22Bob%22`.

Parameters:

after - 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](/#pagination) for more information. (optional)

limit - A limit on the number of objects to return (recommend `20`) (optional, default to 200)

search - A SCIM filter expression that filters the results. Searches include all Device `profile` properties and the Device `id`, `status`, and `lastUpdated` properties. (optional)

expand - Lists associated users for the device in `_embedded` element (optional)

Returns:

List<Device>

Throws:

ApiException - if fails to make API call

listDevices

public List<Device> listDevices(String after,
                                Integer limit,
                                String search,
                                String expand,
                                Map<String,String> additionalHeaders)
                         throws ApiException

List all Devices Lists all devices with pagination support. You can return a subset of Devices that match a supported search criteria using the `search` query parameter. Searches for devices based on the properties specified in the `search` parameter conforming SCIM filter specifications (case-insensitive). This data is eventually consistent. The API returns different results depending on specified queries in the request. Empty list is returned if no objects match `search` request. > **Note:** Listing devices with `search` should not be used as a part of any critical flows—such as authentication or updates—to prevent potential data loss. `search` results may not reflect the latest information, as this endpoint uses a search index which may not be up-to-date with recent updates to the object. <br> Don't use search results directly for record updates, as the data might be stale and therefore overwrite newer data, resulting in data loss. <br> Use an `id` lookup for records that you update to ensure your results contain the latest data. This operation requires [URL encoding](https://www.w3.org/TR/html4/interact/forms.html#h-17.13.4.1). For example, `search=profile.displayName eq \"Bob\"` is encoded as `search=profile.displayName%20eq%20%22Bob%22`.

Parameters:

after - 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](/#pagination) for more information. (optional)

limit - A limit on the number of objects to return (recommend `20`) (optional, default to 200)

search - A SCIM filter expression that filters the results. Searches include all Device `profile` properties and the Device `id`, `status`, and `lastUpdated` properties. (optional)

expand - Lists associated users for the device in `_embedded` element (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<Device>

Throws:

ApiException - if fails to make API call

suspendDevice

public void suspendDevice(String deviceId)
                   throws ApiException

Suspend a Device Suspends a Device by setting its status to ACTIVE. Use suspended devices to create and delete device user links. You can only unsuspend or deactivate suspended devices. > **Note:** SUSPENDED status is meant to be temporary, so it isn't destructive.

Parameters:

deviceId - `id` of the device (required)

Throws:

ApiException - if fails to make API call

suspendDevice

public void suspendDevice(String deviceId,
                          Map<String,String> additionalHeaders)
                   throws ApiException

Suspend a Device Suspends a Device by setting its status to ACTIVE. Use suspended devices to create and delete device user links. You can only unsuspend or deactivate suspended devices. > **Note:** SUSPENDED status is meant to be temporary, so it isn't destructive.

Parameters:

deviceId - `id` of the device (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

unsuspendDevice

public void unsuspendDevice(String deviceId)
                     throws ApiException

Unsuspend a Device Unsuspends a Device by returning its `status` to ACTIVE. >**Note:** Only devices with a SUSPENDED status can be unsuspended.

Parameters:

deviceId - `id` of the device (required)

Throws:

ApiException - if fails to make API call

unsuspendDevice

public void unsuspendDevice(String deviceId,
                            Map<String,String> additionalHeaders)
                     throws ApiException

Unsuspend a Device Unsuspends a Device by returning its `status` to ACTIVE. >**Note:** Only devices with a SUSPENDED status can be unsuspended.

Parameters:

deviceId - `id` of the device (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()