Sessions

Manage user sessions that are created upon successful 'frontend' authentication. This does not apply to the methods implemented via a backend-to-backend integration (under 'Backend Authentication').

Download OpenAPI description

sessions.openapi.json

sessions.openapi.yaml

Servers

Sandbox environment

https://api.sbx.transmitsecurity.io/cis/

Production environment (US)

https://api.transmitsecurity.io/cis/

Production environment (EU)

https://api.eu.transmitsecurity.io/cis/

Production environment (CA)

https://api.ca.transmitsecurity.io/cis/

Production environment (AU)

https://api.au.transmitsecurity.io/cis/

Get user sessions

Request

Retrieves all active sessions for a specified user.

Required permissions: apps:read, [appId]:read, sessions:read.

Security

ClientAccessToken

Path

user_idstringrequired

ID of the user to get active sessions for

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/sessions/{user_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [

user_idstringrequired

User ID

session_idstringrequired

Session ID

client_idstringrequired

Client ID

start_timestring(date-time)required

Session creation time

expiration_timestring(date-time)required

Session expiration time

]

Response

application/json

[
  {
    "user_id": "string",
    "session_id": "string",
    "client_id": "string",
    "start_time": "2019-08-24T14:15:22Z",
    "expiration_time": "2019-08-24T14:15:22Z"
  }
]

Revoke sessions

Request

Revokes all refresh tokens and logs out of all sessions for a specified user.

Required permissions: apps:delete, [appId]:delete, sessions:delete.

Security

ClientAccessToken

Path

user_idstringrequired

ID of the user to revoke sessions for

curl -i -X DELETE \
  'https://api.sbx.transmitsecurity.io/cis/v1/sessions/{user_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultobjectrequired

result.deleted_countnumberrequired

Number of sessions that were deleted

Response

application/json

{
  "result": {
    "deleted_count": 0
  }
}