Update a device posture integration

Updates a configured device posture integration.

/accounts/{identifier}/devices/posture/integration/{uuid}

patch

Device Posture Integrations

device-posture-integrations-update-device-posture-integration

Debug "planAvailability"

null

Debug "tokenPermissions"

null

Debug "parameters"

[
  {
    "in": "path",
    "name": "uuid",
    "required": true,
    "schema": {
      "description": "API UUID.",
      "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "maxLength": 36,
      "type": "string"
    }
  },
  {
    "in": "path",
    "name": "identifier",
    "required": true,
    "schema": {
      "example": "699d98642c564d2e855e9661899b7252"
    }
  }
]

Debug "requestBody"

{
  "content": {
    "application/json": {
      "schema": {
        "properties": {
          "config": {
            "description": "The configuration object containing third-party integration information.",
            "example": {
              "api_url": "https://as123.awmdm.com/API",
              "auth_url": "https://na.uemauth.vmwservices.com/connect/token",
              "client_id": "example client id",
              "client_secret": "example client secret"
            },
            "oneOf": [
              {
                "properties": {
                  "api_url": {
                    "description": "The Workspace One API URL provided in the Workspace One Admin Dashboard.",
                    "example": "https://as123.awmdm.com/API",
                    "type": "string"
                  },
                  "auth_url": {
                    "description": "The Workspace One Authorization URL depending on your region.",
                    "example": "https://na.uemauth.vmwservices.com/connect/token",
                    "type": "string"
                  },
                  "client_id": {
                    "description": "The Workspace One client ID provided in the Workspace One Admin Dashboard.",
                    "example": "example client id",
                    "type": "string"
                  },
                  "client_secret": {
                    "description": "The Workspace One client secret provided in the Workspace One Admin Dashboard.",
                    "example": "example client secret",
                    "type": "string"
                  }
                },
                "required": [
                  "api_url",
                  "auth_url",
                  "client_id",
                  "client_secret"
                ],
                "title": "Workspace One Config",
                "type": "object"
              },
              {
                "properties": {
                  "api_url": {
                    "description": "The Crowdstrike API URL.",
                    "example": "https://api.us-2.crowdstrike.com",
                    "type": "string"
                  },
                  "client_id": {
                    "description": "The Crowdstrike client ID.",
                    "example": "example client id",
                    "type": "string"
                  },
                  "client_secret": {
                    "description": "The Crowdstrike client secret.",
                    "example": "example client secret",
                    "type": "string"
                  },
                  "customer_id": {
                    "description": "The Crowdstrike customer ID.",
                    "example": "example customer id",
                    "type": "string"
                  }
                },
                "required": [
                  "api_url",
                  "customer_id",
                  "client_id",
                  "client_secret"
                ],
                "title": "Crowdstrike Config",
                "type": "object"
              },
              {
                "properties": {
                  "api_url": {
                    "description": "The Uptycs API URL.",
                    "example": "rnd.uptycs.io",
                    "type": "string"
                  },
                  "client_key": {
                    "description": "The Uptycs client secret.",
                    "example": "example client key",
                    "type": "string"
                  },
                  "client_secret": {
                    "description": "The Uptycs client secret.",
                    "example": "example client secret",
                    "type": "string"
                  },
                  "customer_id": {
                    "description": "The Uptycs customer ID.",
                    "example": "example customer id",
                    "type": "string"
                  }
                },
                "required": [
                  "api_url",
                  "client_key",
                  "customer_id",
                  "client_secret"
                ],
                "title": "Uptycs Config",
                "type": "object"
              },
              {
                "properties": {
                  "client_id": {
                    "description": "The Intune client ID.",
                    "example": "example client id",
                    "type": "string"
                  },
                  "client_secret": {
                    "description": "The Intune client secret.",
                    "example": "example client secret",
                    "type": "string"
                  },
                  "customer_id": {
                    "description": "The Intune customer ID.",
                    "example": "example customer id",
                    "type": "string"
                  }
                },
                "required": [
                  "customer_id",
                  "client_id",
                  "client_secret"
                ],
                "title": "Intune Config",
                "type": "object"
              },
              {
                "properties": {
                  "client_id": {
                    "description": "The Kolide client ID.",
                    "example": "example client id",
                    "type": "string"
                  },
                  "client_secret": {
                    "description": "The Kolide client secret.",
                    "example": "example client secret",
                    "type": "string"
                  }
                },
                "required": [
                  "client_id",
                  "client_secret"
                ],
                "title": "Kolide Config",
                "type": "object"
              },
              {
                "properties": {
                  "access_client_id": {
                    "description": "If present, this id will be passed in the `CF-Access-Client-ID` header when hitting the `api_url`",
                    "example": "88bf3b6d86161464f6509f7219099e57.access",
                    "type": "string"
                  },
                  "access_client_secret": {
                    "description": "If present, this secret will be passed in the `CF-Access-Client-Secret` header when hitting the `api_url`",
                    "example": "bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5",
                    "type": "string"
                  },
                  "api_url": {
                    "description": "The Tanium API URL.",
                    "example": "https://dummy-tanium-api.cloudflare.com/plugin/products/gateway/graphql",
                    "type": "string"
                  },
                  "client_secret": {
                    "description": "The Tanium client secret.",
                    "example": "example client secret",
                    "type": "string"
                  }
                },
                "required": [
                  "api_url",
                  "client_secret"
                ],
                "title": "Tanium Config",
                "type": "object"
              },
              {
                "properties": {
                  "api_url": {
                    "description": "The SentinelOne S2S API URL.",
                    "example": "https://example.sentinelone.net",
                    "type": "string"
                  },
                  "client_secret": {
                    "description": "The SentinelOne S2S client secret.",
                    "example": "example client secret",
                    "type": "string"
                  }
                },
                "required": [
                  "api_url",
                  "client_secret"
                ],
                "title": "SentinelOne S2S Config",
                "type": "object"
              }
            ],
            "type": "object"
          },
          "interval": {
            "description": "The interval between each posture check with the third-party API. Use `m` for minutes (e.g. `5m`) and `h` for hours (e.g. `12h`).",
            "example": "10m",
            "type": "string"
          },
          "name": {
            "description": "The name of the device posture integration.",
            "example": "My Workspace One Integration",
            "type": "string"
          },
          "type": {
            "description": "The type of device posture integration.",
            "enum": [
              "workspace_one",
              "crowdstrike_s2s",
              "uptycs",
              "intune",
              "kolide",
              "tanium",
              "sentinelone_s2s"
            ],
            "example": "workspace_one",
            "type": "string"
          }
        }
      }
    }
  },
  "required": true
}

Debug "responses"

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "allOf": [
            {
              "allOf": [
                {
                  "properties": {
                    "errors": {
                      "example": [],
                      "items": {
                        "properties": {
                          "code": {
                            "minimum": 1000,
                            "type": "integer"
                          },
                          "message": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "code",
                          "message"
                        ],
                        "type": "object",
                        "uniqueItems": true
                      },
                      "type": "array"
                    },
                    "messages": {
                      "example": [],
                      "items": {
                        "properties": {
                          "code": {
                            "minimum": 1000,
                            "type": "integer"
                          },
                          "message": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "code",
                          "message"
                        ],
                        "type": "object",
                        "uniqueItems": true
                      },
                      "type": "array"
                    },
                    "result": {
                      "anyOf": [
                        {
                          "type": "object"
                        },
                        {
                          "items": {},
                          "type": "array"
                        },
                        {
                          "type": "string"
                        }
                      ]
                    },
                    "success": {
                      "description": "Whether the API call was successful.",
                      "enum": [
                        true
                      ],
                      "example": true,
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "success",
                    "errors",
                    "messages",
                    "result"
                  ],
                  "type": "object"
                },
                {
                  "properties": {
                    "result": {
                      "anyOf": [
                        {
                          "type": "object"
                        },
                        {
                          "type": "string"
                        }
                      ],
                      "nullable": true,
                      "type": "object"
                    }
                  }
                }
              ],
              "type": "object"
            },
            {
              "properties": {
                "result": {
                  "properties": {
                    "config": {
                      "description": "The configuration object containing third-party integration information.",
                      "example": {
                        "api_url": "https://as123.awmdm.com/API",
                        "auth_url": "https://na.uemauth.vmwservices.com/connect/token",
                        "client_id": "example client id"
                      },
                      "oneOf": [
                        {
                          "description": "The Workspace One Config Response.",
                          "properties": {
                            "api_url": {
                              "description": "The Workspace One API URL provided in the Workspace One Admin Dashboard.",
                              "example": "https://as123.awmdm.com/API",
                              "type": "string"
                            },
                            "auth_url": {
                              "description": "The Workspace One Authorization URL depending on your region.",
                              "example": "https://na.uemauth.vmwservices.com/connect/token",
                              "type": "string"
                            },
                            "client_id": {
                              "description": "The Workspace One client ID provided in the Workspace One Admin Dashboard.",
                              "example": "example client id",
                              "type": "string"
                            }
                          },
                          "required": [
                            "api_url",
                            "auth_url",
                            "client_id"
                          ],
                          "type": "object"
                        }
                      ],
                      "type": "object"
                    },
                    "id": {
                      "description": "API UUID.",
                      "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
                      "maxLength": 36,
                      "type": "string"
                    },
                    "interval": {
                      "description": "The interval between each posture check with the third-party API. Use `m` for minutes (e.g. `5m`) and `h` for hours (e.g. `12h`).",
                      "example": "10m",
                      "type": "string"
                    },
                    "name": {
                      "description": "The name of the device posture integration.",
                      "example": "My Workspace One Integration",
                      "type": "string"
                    },
                    "type": {
                      "description": "The type of device posture integration.",
                      "enum": [
                        "workspace_one",
                        "crowdstrike_s2s",
                        "uptycs",
                        "intune",
                        "kolide",
                        "tanium",
                        "sentinelone_s2s"
                      ],
                      "example": "workspace_one",
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              }
            }
          ]
        }
      }
    },
    "description": "Update a device posture integration response"
  },
  "4XX": {
    "content": {
      "application/json": {
        "schema": {
          "allOf": [
            {
              "allOf": [
                {
                  "allOf": [
                    {
                      "properties": {
                        "errors": {
                          "example": [],
                          "items": {
                            "properties": {
                              "code": {
                                "minimum": 1000,
                                "type": "integer"
                              },
                              "message": {
                                "type": "string"
                              }
                            },
                            "required": [
                              "code",
                              "message"
                            ],
                            "type": "object",
                            "uniqueItems": true
                          },
                          "type": "array"
                        },
                        "messages": {
                          "example": [],
                          "items": {
                            "properties": {
                              "code": {
                                "minimum": 1000,
                                "type": "integer"
                              },
                              "message": {
                                "type": "string"
                              }
                            },
                            "required": [
                              "code",
                              "message"
                            ],
                            "type": "object",
                            "uniqueItems": true
                          },
                          "type": "array"
                        },
                        "result": {
                          "anyOf": [
                            {
                              "type": "object"
                            },
                            {
                              "items": {},
                              "type": "array"
                            },
                            {
                              "type": "string"
                            }
                          ]
                        },
                        "success": {
                          "description": "Whether the API call was successful.",
                          "enum": [
                            true
                          ],
                          "example": true,
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "success",
                        "errors",
                        "messages",
                        "result"
                      ],
                      "type": "object"
                    },
                    {
                      "properties": {
                        "result": {
                          "anyOf": [
                            {
                              "type": "object"
                            },
                            {
                              "type": "string"
                            }
                          ],
                          "nullable": true,
                          "type": "object"
                        }
                      }
                    }
                  ],
                  "type": "object"
                },
                {
                  "properties": {
                    "result": {
                      "properties": {
                        "config": {
                          "description": "The configuration object containing third-party integration information.",
                          "example": {
                            "api_url": "https://as123.awmdm.com/API",
                            "auth_url": "https://na.uemauth.vmwservices.com/connect/token",
                            "client_id": "example client id"
                          },
                          "oneOf": [
                            {
                              "description": "The Workspace One Config Response.",
                              "properties": {
                                "api_url": {
                                  "description": "The Workspace One API URL provided in the Workspace One Admin Dashboard.",
                                  "example": "https://as123.awmdm.com/API",
                                  "type": "string"
                                },
                                "auth_url": {
                                  "description": "The Workspace One Authorization URL depending on your region.",
                                  "example": "https://na.uemauth.vmwservices.com/connect/token",
                                  "type": "string"
                                },
                                "client_id": {
                                  "description": "The Workspace One client ID provided in the Workspace One Admin Dashboard.",
                                  "example": "example client id",
                                  "type": "string"
                                }
                              },
                              "required": [
                                "api_url",
                                "auth_url",
                                "client_id"
                              ],
                              "type": "object"
                            }
                          ],
                          "type": "object"
                        },
                        "id": {
                          "description": "API UUID.",
                          "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
                          "maxLength": 36,
                          "type": "string"
                        },
                        "interval": {
                          "description": "The interval between each posture check with the third-party API. Use `m` for minutes (e.g. `5m`) and `h` for hours (e.g. `12h`).",
                          "example": "10m",
                          "type": "string"
                        },
                        "name": {
                          "description": "The name of the device posture integration.",
                          "example": "My Workspace One Integration",
                          "type": "string"
                        },
                        "type": {
                          "description": "The type of device posture integration.",
                          "enum": [
                            "workspace_one",
                            "crowdstrike_s2s",
                            "uptycs",
                            "intune",
                            "kolide",
                            "tanium",
                            "sentinelone_s2s"
                          ],
                          "example": "workspace_one",
                          "type": "string"
                        }
                      },
                      "type": "object"
                    }
                  }
                }
              ]
            },
            {
              "properties": {
                "errors": {
                  "allOf": [
                    {
                      "example": [],
                      "items": {
                        "properties": {
                          "code": {
                            "minimum": 1000,
                            "type": "integer"
                          },
                          "message": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "code",
                          "message"
                        ],
                        "type": "object",
                        "uniqueItems": true
                      },
                      "type": "array"
                    }
                  ],
                  "example": [
                    {
                      "code": 7003,
                      "message": "No route for the URI"
                    }
                  ],
                  "minLength": 1
                },
                "messages": {
                  "allOf": [
                    {
                      "example": [],
                      "items": {
                        "properties": {
                          "code": {
                            "minimum": 1000,
                            "type": "integer"
                          },
                          "message": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "code",
                          "message"
                        ],
                        "type": "object",
                        "uniqueItems": true
                      },
                      "type": "array"
                    }
                  ],
                  "example": []
                },
                "result": {
                  "enum": [
                    null
                  ],
                  "nullable": true,
                  "type": "object"
                },
                "success": {
                  "description": "Whether the API call was successful",
                  "enum": [
                    false
                  ],
                  "example": false,
                  "type": "boolean"
                }
              },
              "required": [
                "success",
                "errors",
                "messages",
                "result"
              ],
              "type": "object"
            }
          ]
        }
      }
    },
    "description": "Update a device posture integration response failure"
  }
}

Debug "security"

[
  {
    "api_email": [],
    "api_key": []
  }
]