Authentication applications API (deprecated)
Deprecated since version 7.0, Use Device API
The authentication applications API provides authentication application management options.
Via this API the user can manage application instances used for authentication. An application can be a web client or a group of dynamic clients that use the same configuration (e.g. the instances that are installed on a tablet and on a mobile phone are separate dynamic clients but refer to the same application).
Overview of authentication applications
Endpoint: GET /oauth/api/v1/users/{userId}/authentication/apps
Parameter | Description |
---|---|
userId | identifier of the user |
When no applications are found because the user does not exist or the user does not have any authentication applications, a 404 NOT FOUND will be returned. When the user does have authentication applications an array with one or more applications is returned. Each object has the following attributes:
Attribute | Description |
---|---|
id | UUID identifying the authentication application instance |
device_id | UUID identifying the device, currently device_id equals client_id |
device_name | The name of the device the application instance is installed on |
platform | The platform the application instance is installed on |
Example result
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache
{
"authentication_app_instances": [
{
"id": "77cea55b-c82f-448f-b0a1-6cd4c07bdb54",
"device_id": "fc4ef972-7167-4421-aa89-f109be79d7c2"
"device_name": "My device",
"platform": "ANDROID"
}
]
}
Example error response
{
"error": "No authentication apps found"
}
Delete authentication application instances
By deleting an authentication application instance the application instance can not be used for mobile authentication anymore until enrolled again.
Endpoint: DELETE /oauth/api/v1/users/{userId}/authentication/apps/{applicationInstanceId}
Parameter | Description |
---|---|
userId | Identifier of the user |
applicationInstanceId | UUID identifying the application instance |