Delete Devices

delete

https://account.api.here.com/authentication/v1.1/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

identityProvider

string

required

HRN identifying the IdentityProvider.

externalId

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

X-Request-ID

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.

X-Correlation-ID

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

204No Content

400Bad Request. E110000 - Missing required field, etc.

401Missing Authorization header.

403An error has occurred. E110000 - Subject does not have the required "readDevices" access to the Realm.

404An error has occurred. E110000 - The requested Identity Provider, or Device with specified Identity Provider and ExternalId, does not exist.