The Client object tracks sessions, as well as the state of any sign in and sign up attempts, for a given device.
Returns a list of all clients. The clients are returned sorted by creation date, with the newest clients appearing first.
Success
Request was not successful
Authentication invalid
Invalid request parameters
[- {
- "object": "client",
- "id": "string",
- "session_ids": [
- "string"
], - "sessions": [
- {
- "object": "session",
- "id": "string",
- "user_id": "string",
- "client_id": "string",
- "actor": { },
- "status": "active",
- "last_active_organization_id": "string",
- "last_active_at": 0,
- "expire_at": 0,
- "abandon_at": 0,
- "updated_at": 0,
- "created_at": 0
}
], - "sign_in_id": "string",
- "sign_up_id": "string",
- "last_active_session_id": "string",
- "updated_at": 0,
- "created_at": 0
}
]
Verifies the client in the provided token
Success
Request was not successful
Authentication invalid
Resource not found
{- "token": "string"
}
{- "object": "client",
- "id": "string",
- "session_ids": [
- "string"
], - "sessions": [
- {
- "object": "session",
- "id": "string",
- "user_id": "string",
- "client_id": "string",
- "actor": { },
- "status": "active",
- "last_active_organization_id": "string",
- "last_active_at": 0,
- "expire_at": 0,
- "abandon_at": 0,
- "updated_at": 0,
- "created_at": 0
}
], - "sign_in_id": "string",
- "sign_up_id": "string",
- "last_active_session_id": "string",
- "updated_at": 0,
- "created_at": 0
}
Returns the details of a client.
Success
Request was not successful
Authentication invalid
Resource not found
{- "object": "client",
- "id": "string",
- "session_ids": [
- "string"
], - "sessions": [
- {
- "object": "session",
- "id": "string",
- "user_id": "string",
- "client_id": "string",
- "actor": { },
- "status": "active",
- "last_active_organization_id": "string",
- "last_active_at": 0,
- "expire_at": 0,
- "abandon_at": 0,
- "updated_at": 0,
- "created_at": 0
}
], - "sign_in_id": "string",
- "sign_up_id": "string",
- "last_active_session_id": "string",
- "updated_at": 0,
- "created_at": 0
}
Returns the details of the last active session of a client.
Success
Request was not successful
Authentication invalid
Resource not found
{- "object": "session",
- "id": "string",
- "user_id": "string",
- "client_id": "string",
- "actor": { },
- "status": "active",
- "last_active_organization_id": "string",
- "last_active_at": 0,
- "expire_at": 0,
- "abandon_at": 0,
- "updated_at": 0,
- "created_at": 0
}