put https://{baseurl}/apdu/api/v1/users//devices/organizations//manageDevice
This API endpoint allows you to manage device lifecycle actions such as activate, suspend, revoke, report incident, and reactivate.
Headers
- Authentication: Bearer <JWT>
- Accept: application/json
- Content-Type: application/json
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| organizationName | string | Denotes the name of the organization. |
| userId | string | Denotes the unique id of the user that is assigned. |
| device | object | Denotes the object containing the device metadata. |
Device Object
| Parameter | Type | Description |
|---|---|---|
| id | Long (Optional) | The ID number of the allowed identity. |
| friendlyName | String (Required) | The friendly name given to the device. |
| uniqueIdentifier | String (Required) | The unique ID number of the device. |
| operatingSystem | String (Required) | The operating system of the device. |
| osVersion | String (Required) | The version of the operating system (E.g.: Android 12.0/iOS 15.0). |
| appVersion | String (Required) | The version of the app (ID Wallet). |
| deviceModelName | String (Required) | The model name of the device. |
| deviceManufacturerName | String (Required) | The name of the device manufacturer. |
| devProfName | String (Required) | The name of the device profile. |
| devProfId | Long (Required) | The unique ID for a device profile. |
| userID | String (Required) | The ID number of the user. |
| deviceIssuedName | String (Required) | The name of the device issued. |
| appName | String (Required) | The name of the app (ID Wallet). |
| appRegID | String (Required) | The registered ID of the app (ID Wallet). |
| osApiVersion | String (Required) | The API version of the operating system. This field is specific for Android devices only (E.g.: API level 31). |
| userDevices | User Devices Object (Optional) | The object that captures the details of the user's issued devices. |
| mobileCredentials | Mobile Credential Object (Optional) | The object that captures the details of the mobile credentials. |
| actionType | String (Required) | The type of action performed. |
| reason | Long (Required) | The reason for performing a lifecycle action on the device. |
| cardType | String (Required) | The type of the card. |
| reasonComment | String (Required) | The reason for performing a lifecycle action on the device. |
| roleDeviceActions | Role Device Action Object (Optional) | The object that captures the details of device actions permitted based on the role. |
| deviceConnectedActions | String Array (Required) | The list of device connected actions. |
| deviceNotConnectedActions | String Array (Required) | The list of device not connected actions. |
| status | String (Required) | The status of the device. |
| uimsId | String (Required) | The unique ID of the device. |
| productName | String (Required) | The name of the product. |
| actionOnSecondaryCred | Boolean (Required) | Indicates if the action on secondary credential is enabled or not. Possible Values: true, false. |