Skip to content
Authrim

List user device secrets

GET
/api/admin/users/{userId}/device-secrets
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/users/example/device-secrets?include_revoked=false&limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

Returns device secret metadata for a user. The actual device secret values are never returned.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
userId
required
string

Query Parameters

Section titled “Query Parameters ”
include_revoked
boolean

Include revoked device secrets.

limit
integer
default: 50 >= 1 <= 100

Maximum items to return.

offset
integer
0

Pagination offset.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Device secret metadata for a user. Secrets are never returned.

Media type application/json
object
items
required
Array<object>
object
id
required
string
user_id
required
string
session_id
required
string
device_name
string
device_platform
string
created_at
required
string format: date-time
expires_at
required
string format: date-time
last_used_at
string format: date-time
use_count
required
integer
is_active
required
boolean
revoked_at
string format: date-time
revoke_reason
string
key
additional properties
pagination
required
object
total
required
integer
limit
required
integer
offset
required
integer
has_more
required
boolean
key
additional properties
summary
required
object
total
required
integer
active
required
integer
revoked
required
integer
expired
required
integer
key
additional properties
key
additional properties
Example 
{
  "items": [
    {
      "id": "ds_123",
      "tenant_id": "tenant_123",
      "user_id": "user_123",
      "device_id": "device_abc",
      "device_name": "MacBook Pro",
      "device_type": "desktop",
      "is_active": {},
      "created_at": 1770000000000,
      "expires_at": 1770604800000,
      "last_used_at": 1770000500000,
      "revoked_at": null
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 50,
    "offset": 0,
    "has_more": false
  },
  "summary": {
    "total": 1,
    "active": 1,
    "revoked": 0,
    "expired": 0
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}