List the user's devices

get https://{hostname}/amfa/v1/users/{userId}/devices

List all the user's authentication devices.

Recipes

Open Recipe

Responses

Response body

object

devices

array of objects

required

length ≥ 0

Authentication devices the user enrolled in Akamai MFA.

devices*

object

createdDate

date-time

required

ISO 8601 timestamp marking when the device was created.

deviceId

string

required

length ≥ 1

Uniquely identifies the authentication device enrolled by the user.

deviceName

string

length ≥ 1

A user-friendly name to identify the authentication device.

deviceType

string

required

A user's type of authentication device. Refer to API concepts to learn about device types.

PUSH PHONE_ONLY SECURITY_KEY TOTP HARDWARE_TOKEN

isDeviceEnabled

boolean

Whether the authentication device is enabled in Akamai MFA. You can disable a user's device that remains inactive or poses a threat to your data. Users can't use a deactivated device to confirm their identity. Disabling a device is reversible, and isn't the same as permanently deleting a device. See Enable a device and Disable a device for details on how to manage user devices.

modifiedDate

date-time

ISO 8601 timestamp marking when the device was last modified, or when it was last used since then.

platform

string

required

length ≥ 1

The platform of the authentication device.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/amfa/v1/users/userId/devices \
3
     --header 'accept: application/json'


xxxxxxxxxx
20
 
1
{
2
  "devices": [
3
    {
4
      "createdDate": "2021-02-26T08:32:36.149+00:00",
5
      "deviceId": "device_5Vv4g1iex1ntW5L1bQbcaG",
6
      "deviceName": "iPhone",
7
      "deviceType": "PUSH",
8
      "modifiedDate": "2021-03-04T17:15:11.719+00:00",
9
      "platform": "ios"
10
    },
11
    {
12
      "createdDate": "2021-02-26T08:33:38.521+00:00",
13
      "deviceId": "device_7HKbbp6wDRqHiYJW8d2lpY",
14
      "deviceName": "Security Key",
15
      "deviceType": "SECURITY_KEY",
16
      "modifiedDate": "2021-02-26T08:33:38.521+00:00",
17
      "platform": "fido2"
18
    }
19
  ]
20
}

200The response provides a list of the user's devices.

401Unauthorized.

404Not found.

500Internal server error.