Authentication

mobile mfa

Download Spec

get/auth/api/v1/users/{user_id}/devices

Returns a list of paired devices for a user

user_idstring

required

User id

Format: uuid

Responses

Response examples

Successful response

{
  "count": 1,
  "items": [
    {
      "id": "mobile-sha256-sdHe7CJqHwCY4WePe-BgYNGF8sd6fe8ier2Buemz4xM=",
      "os": "iOS",
      "name": "iPhone 6",
      "activated": "2023-06-07T17:32:28Z",
      "updated": "2023-06-07T17:32:28Z",
      "lastUsed": "2023-06-07T17:32:28Z"
    }
  ]
}

get/auth/api/v1/users/current/devices

Returns a list of paired devices for current user

OAuth2 oauth

Required Scopes:

user

Returns a list of paired devices for current user

All Scopes

admin · Admin scope - used for built-in SSH PrivX admin account
service · Microservice scope - used for communication between SSH PrivX microservices
user · Normal users
usersManage · Clients with users-manage scope
usersView · Clients with users-view scope

Flow Type:: authorization_code

Auth URL:: https://api.x.com/v1/auth/auth

Token URL:: https://api.x.com/v1/auth/auth

Responses

Response examples

Successful response

{
  "count": 1,
  "items": [
    {
      "id": "mobile-sha256-sdHe7CJqHwCY4WePe-BgYNGF8sd6fe8ier2Buemz4xM=",
      "os": "iOS",
      "name": "iPhone 6",
      "activated": "2023-06-07T17:32:28Z",
      "updated": "2023-06-07T17:32:28Z",
      "lastUsed": "2023-06-07T17:32:28Z"
    }
  ]
}

delete/auth/api/v1/users/{user_id}/devices/{device_id}

Unpair a device from a user's device list

user_idstring

required

User id

Format: uuid

device_idstring

required

Device id

Example: "mobile-sha256-sdHe7CJqHwCY4WePe-BgYNGF8sd6fe8ier2Buemz4xM="

Responses

Response examples

Successful response

Empty response

delete/auth/api/v1/users/current/devices/{device_id}

Unpair a device from the current user's device list

device_idstring

required

Device id

Example: "mobile-sha256-sdHe7CJqHwCY4WePe-BgYNGF8sd6fe8ier2Buemz4xM="

Responses

Response examples

Successful response

Empty response

Was this page helpful?