• Authentication

sessionstorage

User sessions

get/auth/api/v1/sessionstorage/users/{user_id}/sessions

List user sessions

Get all valid user sessions

offsetint

Collection query offset

Default
0
Min
0
limitint

Maximum number of collection items to return

Default
50
sortdirstring

Sorting direction

Default
"ASC"
Enum
  • ASC
  • DESC
sortkeystring

Sorting key

Default
"expires"
Enum
  • id
  • user_id
  • source_id
  • parent_session_id
  • domain
  • username
  • remote_address
  • type
  • created
  • updated
  • expires
  • token_expires

Responses

Response examples

Successful response, returns valid user sessions.

{
  "count": 1,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "user_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "source_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "parent_session_id": "44f2f78a-4604-4803-b2b7-61807480e5cd",
      "domain": "privx-ui",
      "username": "alice",
      "remote_addr": "127.0.0.1",
      "user_agent": "Mozilla....",
      "type": "login",
      "created": "2022-01-01T09:17:16Z",
      "updated": "2022-01-01T09:17:16Z",
      "expires": "2022-01-01T09:17:16Z",
      "token_expires": "2022-01-01T09:17:16Z",
      "logged_out": false,
      "current": false
    }
  ]
}
get/auth/api/v1/sessionstorage/users/current/sessions

List current user's sessions

Get all current users valid sessions.

offsetint

Collection query offset

Default
0
Min
0
limitint

Maximum number of collection items to return

Default
50
sortdirstring

Sorting direction

Default
"ASC"
Enum
  • ASC
  • DESC
sortkeystring

Sorting key

Default
"expires"
Enum
  • id
  • user_id
  • source_id
  • parent_session_id
  • domain
  • username
  • remote_address
  • type
  • created
  • updated
  • expires
  • token_expires

Responses

Response examples

Successful response, returns current users valid sessions.

{
  "count": 1,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "user_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "source_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "parent_session_id": "44f2f78a-4604-4803-b2b7-61807480e5cd",
      "domain": "privx-ui",
      "username": "alice",
      "remote_addr": "127.0.0.1",
      "user_agent": "Mozilla....",
      "type": "login",
      "created": "2022-01-01T09:17:16Z",
      "updated": "2022-01-01T09:17:16Z",
      "expires": "2022-01-01T09:17:16Z",
      "token_expires": "2022-01-01T09:17:16Z",
      "logged_out": false,
      "current": false
    }
  ]
}
get/auth/api/v1/sessionstorage/sources/{source_id}/sessions

List source sessions

Get all valid source sessions.

offsetint

Collection query offset

Default
0
Min
0
limitint

Maximum number of collection items to return

Default
50
sortdirstring

Sorting direction

Default
"ASC"
Enum
  • ASC
  • DESC
sortkeystring

Sorting key

Default
"expires"
Enum
  • id
  • user_id
  • source_id
  • parent_session_id
  • domain
  • username
  • remote_address
  • type
  • created
  • updated
  • expires
  • token_expires

Responses

Response examples

Successful response, returns current users valid sessions.

{
  "count": 1,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "user_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "source_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "parent_session_id": "44f2f78a-4604-4803-b2b7-61807480e5cd",
      "domain": "privx-ui",
      "username": "alice",
      "remote_addr": "127.0.0.1",
      "user_agent": "Mozilla....",
      "type": "login",
      "created": "2022-01-01T09:17:16Z",
      "updated": "2022-01-01T09:17:16Z",
      "expires": "2022-01-01T09:17:16Z",
      "token_expires": "2022-01-01T09:17:16Z",
      "logged_out": false,
      "current": false
    }
  ]
}
post/auth/api/v1/sessionstorage/sessions/search

Find sessions

Find sessions

keywordsstring

Keywords string which is separated by a comma

Example
"alice, 127.0.0.1, Mozilla/3.0"
user_idstring

The ID of the user the sessions belong to

Format
uuid
typestring

Type of session, login or sso

Example
"login"

Responses

Request examples

{
  "keywords": "alice, 127.0.0.1, Mozilla/3.0",
  "user_id": "5bf77342-221c-11ee-be56-0242ac120002",
  "type": "login"
}

Response examples

Successful response, returns valid sessions.

{
  "count": 1,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "user_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "source_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "parent_session_id": "44f2f78a-4604-4803-b2b7-61807480e5cd",
      "domain": "privx-ui",
      "username": "alice",
      "remote_addr": "127.0.0.1",
      "user_agent": "Mozilla....",
      "type": "login",
      "created": "2022-01-01T09:17:16Z",
      "updated": "2022-01-01T09:17:16Z",
      "expires": "2022-01-01T09:17:16Z",
      "token_expires": "2022-01-01T09:17:16Z",
      "logged_out": false,
      "current": false
    }
  ]
}
post/auth/api/v1/sessionstorage/sessions/{session_id}/terminate

Terminate a session

Terminate a session by ID

session_idstring

required

Session ID

Format
uuid

Responses

Response examples

Successful response.

Empty response

post/auth/api/v1/sessionstorage/users/{user_id}/sessions/terminate

Terminate user's sessions

Terminate all user sessions

user_idstring

required

User ID

Format
uuid

Responses

Response examples

Successful response.

Empty response

post/auth/api/v1/sessionstorage/users/current/sessions/{session_id}/terminate

Terminate a current user's session

Terminate current user's session by ID

session_idstring

required

Session ID

Format
uuid

Responses

Response examples

Successful response.

Empty response

post/auth/api/v1/sessionstorage/users/current/sessionpassword

Get session password

Get session password

OAuth2 oauth

Required Scopes:

user

Get session password

All Scopes

  • admin · Admin scope - used for built-in SSH PrivX admin account
  • service · Microservice scope - used for communication between PrivX microservices
  • user · Normal user
  • usersManage · User with "users-manage" permission
  • usersView · User with "users-view" permission
Flow Type:
authorization_code
Auth URL:
https://api.example.com/auth/api/v1/oauth/authorize
Token URL:
https://api.example.com/auth/api/v1/oauth/token

Responses

Response examples

Successful response.

{
  "password": "y~X4x4P%F)="
}

Was this page helpful?