okta.DeviceApi

All URIs are relative to https://subdomain.okta.com

Method	HTTP request	Description
activate_device	POST /api/v1/devices/{deviceId}/lifecycle/activate	Activate a Device
deactivate_device	POST /api/v1/devices/{deviceId}/lifecycle/deactivate	Deactivate a Device
delete_device	DELETE /api/v1/devices/{deviceId}	Delete a Device
get_device	GET /api/v1/devices/{deviceId}	Retrieve a Device
list_device_users	GET /api/v1/devices/{deviceId}/users	List all Users for a Device
list_devices	GET /api/v1/devices	List all Devices
suspend_device	POST /api/v1/devices/{deviceId}/lifecycle/suspend	Suspend a Device
unsuspend_device	POST /api/v1/devices/{deviceId}/lifecycle/unsuspend	Unsuspend a Device

activate_device

activate_device(device_id)

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.

Example

Api Key Authentication (apiToken):
OAuth Authentication (oauth2):

import okta
from okta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://subdomain.okta.com
# See configuration.py for a list of all supported configuration parameters.
configuration = okta.Configuration(
    host = "https://subdomain.okta.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiToken
configuration.api_key['apiToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiToken'] = 'Bearer'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with okta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = okta.DeviceApi(api_client)
    device_id = 'guo4a5u7JHHhjXrMK0g4' # str | `id` of the device

    try:
        # Activate a Device
        api_instance.activate_device(device_id)
    except Exception as e:
        print("Exception when calling DeviceApi->activate_device: %s\n" % e)

Parameters

Name	Type	Description	Notes
device_id	str	`id` of the device

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deactivate_device

deactivate_device(device_id)

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.

Example

Api Key Authentication (apiToken):
OAuth Authentication (oauth2):

import okta
from okta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://subdomain.okta.com
# See configuration.py for a list of all supported configuration parameters.
configuration = okta.Configuration(
    host = "https://subdomain.okta.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiToken
configuration.api_key['apiToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiToken'] = 'Bearer'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with okta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = okta.DeviceApi(api_client)
    device_id = 'guo4a5u7JHHhjXrMK0g4' # str | `id` of the device

    try:
        # Deactivate a Device
        api_instance.deactivate_device(device_id)
    except Exception as e:
        print("Exception when calling DeviceApi->deactivate_device: %s\n" % e)

Parameters

Name	Type	Description	Notes
device_id	str	`id` of the device

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_device

delete_device(device_id)

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 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.

Example

Api Key Authentication (apiToken):
OAuth Authentication (oauth2):

import okta
from okta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://subdomain.okta.com
# See configuration.py for a list of all supported configuration parameters.
configuration = okta.Configuration(
    host = "https://subdomain.okta.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiToken
configuration.api_key['apiToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiToken'] = 'Bearer'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with okta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = okta.DeviceApi(api_client)
    device_id = 'guo4a5u7JHHhjXrMK0g4' # str | `id` of the device

    try:
        # Delete a Device
        api_instance.delete_device(device_id)
    except Exception as e:
        print("Exception when calling DeviceApi->delete_device: %s\n" % e)

Parameters

Name	Type	Description	Notes
device_id	str	`id` of the device

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_device

Device get_device(device_id)

Retrieve a Device

Retrieves a device by deviceId

Example

Api Key Authentication (apiToken):
OAuth Authentication (oauth2):

import okta
from okta.models.device import Device
from okta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://subdomain.okta.com
# See configuration.py for a list of all supported configuration parameters.
configuration = okta.Configuration(
    host = "https://subdomain.okta.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiToken
configuration.api_key['apiToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiToken'] = 'Bearer'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with okta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = okta.DeviceApi(api_client)
    device_id = 'guo4a5u7JHHhjXrMK0g4' # str | `id` of the device

    try:
        # Retrieve a Device
        api_response = api_instance.get_device(device_id)
        print("The response of DeviceApi->get_device:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DeviceApi->get_device: %s\n" % e)

Parameters

Name	Type	Description	Notes
device_id	str	`id` of the device

Return type

Device

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_device_users

List[DeviceUser] list_device_users(device_id)

List all Users for a Device

Lists all Users for a Device by deviceId

Example

Api Key Authentication (apiToken):
OAuth Authentication (oauth2):

import okta
from okta.models.device_user import DeviceUser
from okta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://subdomain.okta.com
# See configuration.py for a list of all supported configuration parameters.
configuration = okta.Configuration(
    host = "https://subdomain.okta.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiToken
configuration.api_key['apiToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiToken'] = 'Bearer'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with okta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = okta.DeviceApi(api_client)
    device_id = 'guo4a5u7JHHhjXrMK0g4' # str | `id` of the device

    try:
        # List all Users for a Device
        api_response = api_instance.list_device_users(device_id)
        print("The response of DeviceApi->list_device_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DeviceApi->list_device_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
device_id	str	`id` of the device

Return type

List[DeviceUser]

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_devices

List[Device] list_devices(after=after, limit=limit, search=search, expand=expand)

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.
Don't use search results directly for record updates, as the data might be stale and therefore overwrite newer data, resulting in data loss.
Use an id lookup for records that you update to ensure your results contain the latest data. This operation requires URL encoding. For example, search=profile.displayName eq \"Bob\" is encoded as search=profile.displayName%20eq%20%22Bob%22.

Example

Api Key Authentication (apiToken):
OAuth Authentication (oauth2):

import okta
from okta.models.device import Device
from okta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://subdomain.okta.com
# See configuration.py for a list of all supported configuration parameters.
configuration = okta.Configuration(
    host = "https://subdomain.okta.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiToken
configuration.api_key['apiToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiToken'] = 'Bearer'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with okta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = okta.DeviceApi(api_client)
    after = 'after_example' # str | 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 = 200 # int | A limit on the number of objects to return (recommend `20`) (optional) (default to 200)
    search = 'status eq \"ACTIVE\"' # str | A SCIM filter expression that filters the results. Searches include all Device `profile` properties and the Device `id`, `status`, and `lastUpdated` properties. (optional)
    expand = 'expand_example' # str | Lists associated users for the device in `_embedded` element (optional)

    try:
        # List all Devices
        api_response = api_instance.list_devices(after=after, limit=limit, search=search, expand=expand)
        print("The response of DeviceApi->list_devices:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DeviceApi->list_devices: %s\n" % e)

Parameters

Name	Type	Description	Notes
after	str	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 for more information.	[optional]
limit	int	A limit on the number of objects to return (recommend `20`)	[optional] [default to 200]
search	str	A SCIM filter expression that filters the results. Searches include all Device `profile` properties and the Device `id`, `status`, and `lastUpdated` properties.	[optional]
expand	str	Lists associated users for the device in `_embedded` element	[optional]

Return type

List[Device]

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
403	Forbidden	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

suspend_device

suspend_device(device_id)

Suspend a Device

Suspends a Device by setting its status to SUSPENDED. 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.

Example

Api Key Authentication (apiToken):
OAuth Authentication (oauth2):

import okta
from okta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://subdomain.okta.com
# See configuration.py for a list of all supported configuration parameters.
configuration = okta.Configuration(
    host = "https://subdomain.okta.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiToken
configuration.api_key['apiToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiToken'] = 'Bearer'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with okta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = okta.DeviceApi(api_client)
    device_id = 'guo4a5u7JHHhjXrMK0g4' # str | `id` of the device

    try:
        # Suspend a Device
        api_instance.suspend_device(device_id)
    except Exception as e:
        print("Exception when calling DeviceApi->suspend_device: %s\n" % e)

Parameters

Name	Type	Description	Notes
device_id	str	`id` of the device

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unsuspend_device

unsuspend_device(device_id)

Unsuspend a Device

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

Example

Api Key Authentication (apiToken):
OAuth Authentication (oauth2):

import okta
from okta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://subdomain.okta.com
# See configuration.py for a list of all supported configuration parameters.
configuration = okta.Configuration(
    host = "https://subdomain.okta.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiToken
configuration.api_key['apiToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiToken'] = 'Bearer'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with okta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = okta.DeviceApi(api_client)
    device_id = 'guo4a5u7JHHhjXrMK0g4' # str | `id` of the device

    try:
        # Unsuspend a Device
        api_instance.unsuspend_device(device_id)
    except Exception as e:
        print("Exception when calling DeviceApi->unsuspend_device: %s\n" % e)

Parameters

Name	Type	Description	Notes
device_id	str	`id` of the device

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

DeviceApi.md

Latest commit

History

DeviceApi.md

File metadata and controls

okta.DeviceApi

activate_device

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deactivate_device

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_device

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_device

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_device_users

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_devices

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

suspend_device

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

unsuspend_device

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details