GuidesAPI Reference
API Reference

Delete Devices

delete
https://Use API Lookup for a base URL/devices

Delete a Device by its Identity Provider and ExternalId.
Deleting multiple Devices at a time is not currently supported.


Access Control:

  • The calling principal must have "manageDevices" action permission for the resource "{realm}" in
    the "account" service. The realm is realm of the device.
  • The calling principal MUST NOT include a project scope.
Query Params
string
required

HRN identifying the IdentityProvider.

string
required

External identifier for the Device under a third-party Identity Provider.
If OpenID Connect Token Exchange was used to create this Device identity, the
ExternalId matches the value of the "sub" claim in the OP's access tokens.
External IDs are considered unique for a given an Identity Provider.

Headers
string

The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services.

string

Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response.

Responses

Updated 4 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json

Updated 4 months ago