PUT /api/v1/device-posture-checks/{postureCheckId}
Replaces a device posture check by postureCheckId
Servers
- https://{yourOktaDomain}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
postureCheckId |
String | Yes |
ID of the device posture check |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
mappingType |
String | No |
Represents how the device posture check is rendered in device assurance policies Valid values:
|
description |
String | No |
Description of the device posture check |
lastUpdatedBy |
String | No |
User who updated the device posture check |
createdDate |
String | No |
Time the device posture check was created |
id |
String | No |
The ID of the device posture check |
_links |
Object | No |
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. |
query |
String | No |
OSQuery for the device posture check |
name |
String | No |
Display name of the device posture check |
remediationSettings |
Object | No |
Represents the remediation instructions shown to the end user when the device posture check fails |
remediationSettings.message |
Object | No | |
remediationSettings.message.customText |
String | No |
Custom text for the message |
remediationSettings.message.defaultI18nKey |
String | No |
Default i18n key for the message. This property is only relevant if type is set to |
remediationSettings.link |
Object | No | |
remediationSettings.link.defaultUrl |
String | No |
Default URL for the link. This property is only relevant if type is set to |
remediationSettings.link.customUrl |
String | No |
Custom URL for the link |
platform |
String | No |
Valid values:
|
variableName |
String | No |
Unique name of the device posture check |
type |
String | No |
Valid values:
|
lastUpdate |
String | No |
Time the device posture check was updated |
createdBy |
String | No |
User who created the device posture check |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.