Skip to content

Get a device secret.

GET
/api/admin/device-secrets/{id}
Code sample: Shell / cURL
curl --request GET \
--url https://auth.example.com/api/admin/device-secrets/example \
--header 'Authorization: Bearer <token>'

Returns non-secret metadata for one OIDC Native SSO device secret. The actual secret and hash are never exposed.

id
required
string

Device secret identifier.

Device secret metadata response.

Media type application/json
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
Example generated
{
"id": "example",
"user_id": "example",
"session_id": "example",
"device_name": "example",
"device_platform": "example",
"created_at": "2026-04-15T12:00:00Z",
"expires_at": "2026-04-15T12:00:00Z",
"last_used_at": "2026-04-15T12:00:00Z",
"use_count": 1,
"is_active": true,
"revoked_at": "2026-04-15T12:00:00Z",
"revoke_reason": "example"
}

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"
}

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"
}

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"
}

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"
}

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"
}