Users

Create User

Create user for an application. Must provide an email of phone number identifier.

POSThttps://api.passage.id/v1/apps/{app_id}/users

Authorization

bearerAuth

Path parameters

app_id*string

App ID

Body

application/json

email, phone, user_metadata

emailstring

Email of the new user. Either this or phone is required; both may be provided.

phonestring

Phone number of the new user. Either this or email is required; both may be provided.

user_metadataobject

Response

201400401404500

Created

Body

application/json

user*UserInfo (object)

Request

JavaScriptCurl

const response = await fetch('https://api.passage.id/v1/apps/{app_id}/users', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "user": {
    "created_at": "2024-05-19T23:04:27.829Z",
    "email": "text",
    "email_verified": false,
    "external_id": "text",
    "id": "text",
    "last_login_at": "2024-05-19T23:04:27.829Z",
    "phone": "text",
    "phone_verified": false,
    "recent_events": [
      {
        "created_at": "2024-05-19T23:04:27.829Z",
        "completed_at": "2024-05-19T23:04:27.829Z",
        "id": "text",
        "ip_addr": "text",
        "status": "complete",
        "type": "text",
        "user_agent": "text"
      }
    ],
    "social_connections": {
      "apple": {
        "provider_id": "text",
        "created_at": "2024-05-19T23:04:27.829Z",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "provider_identifier": "text"
      },
      "github": {
        "provider_id": "text",
        "created_at": "2024-05-19T23:04:27.829Z",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "provider_identifier": "text"
      },
      "google": {
        "provider_id": "text",
        "created_at": "2024-05-19T23:04:27.829Z",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "provider_identifier": "text"
      }
    },
    "status": "active",
    "updated_at": "2024-05-19T23:04:27.829Z",
    "user_metadata": {},
    "webauthn": false,
    "webauthn_devices": [
      {
        "created_at": "2024-05-19T23:04:27.829Z",
        "cred_id": "text",
        "friendly_name": "text",
        "id": "text",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "type": "passkey",
        "updated_at": "2024-05-19T23:04:27.829Z",
        "icons": {
          "light": "text",
          "dark": "text"
        }
      }
    ],
    "webauthn_types": [
      "passkey"
    ]
  }
}

Update User

Update a user's information.

PATCHhttps://api.passage.id/v1/apps/{app_id}/users/{user_id}

Authorization

bearerAuth

Path parameters

app_id*string

App ID

user_id*string

User ID

Body

application/json

user settings

emailstring

phonestring

user_metadataobject

Response

200400401404500

OK

Body

application/json

user*UserInfo (object)

Request

JavaScriptCurl

const response = await fetch('https://api.passage.id/v1/apps/{app_id}/users/{user_id}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "user": {
    "created_at": "2024-05-19T23:04:27.829Z",
    "email": "text",
    "email_verified": false,
    "external_id": "text",
    "id": "text",
    "last_login_at": "2024-05-19T23:04:27.829Z",
    "phone": "text",
    "phone_verified": false,
    "recent_events": [
      {
        "created_at": "2024-05-19T23:04:27.829Z",
        "completed_at": "2024-05-19T23:04:27.829Z",
        "id": "text",
        "ip_addr": "text",
        "status": "complete",
        "type": "text",
        "user_agent": "text"
      }
    ],
    "social_connections": {
      "apple": {
        "provider_id": "text",
        "created_at": "2024-05-19T23:04:27.829Z",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "provider_identifier": "text"
      },
      "github": {
        "provider_id": "text",
        "created_at": "2024-05-19T23:04:27.829Z",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "provider_identifier": "text"
      },
      "google": {
        "provider_id": "text",
        "created_at": "2024-05-19T23:04:27.829Z",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "provider_identifier": "text"
      }
    },
    "status": "active",
    "updated_at": "2024-05-19T23:04:27.829Z",
    "user_metadata": {},
    "webauthn": false,
    "webauthn_devices": [
      {
        "created_at": "2024-05-19T23:04:27.829Z",
        "cred_id": "text",
        "friendly_name": "text",
        "id": "text",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "type": "passkey",
        "updated_at": "2024-05-19T23:04:27.829Z",
        "icons": {
          "light": "text",
          "dark": "text"
        }
      }
    ],
    "webauthn_types": [
      "passkey"
    ]
  }
}

Get User

Get information about a user.

GEThttps://api.passage.id/v1/apps/{app_id}/users/{user_id}

Authorization

bearerAuth

Path parameters

app_id*string

App ID

user_id*string

User ID

Response

200401404500

OK

Body

application/json

user*UserInfo (object)

Request

JavaScriptCurl

const response = await fetch('https://api.passage.id/v1/apps/{app_id}/users/{user_id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "user": {
    "created_at": "2024-05-19T23:04:27.829Z",
    "email": "text",
    "email_verified": false,
    "external_id": "text",
    "id": "text",
    "last_login_at": "2024-05-19T23:04:27.829Z",
    "phone": "text",
    "phone_verified": false,
    "recent_events": [
      {
        "created_at": "2024-05-19T23:04:27.829Z",
        "completed_at": "2024-05-19T23:04:27.829Z",
        "id": "text",
        "ip_addr": "text",
        "status": "complete",
        "type": "text",
        "user_agent": "text"
      }
    ],
    "social_connections": {
      "apple": {
        "provider_id": "text",
        "created_at": "2024-05-19T23:04:27.829Z",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "provider_identifier": "text"
      },
      "github": {
        "provider_id": "text",
        "created_at": "2024-05-19T23:04:27.829Z",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "provider_identifier": "text"
      },
      "google": {
        "provider_id": "text",
        "created_at": "2024-05-19T23:04:27.829Z",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "provider_identifier": "text"
      }
    },
    "status": "active",
    "updated_at": "2024-05-19T23:04:27.829Z",
    "user_metadata": {},
    "webauthn": false,
    "webauthn_devices": [
      {
        "created_at": "2024-05-19T23:04:27.829Z",
        "cred_id": "text",
        "friendly_name": "text",
        "id": "text",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "type": "passkey",
        "updated_at": "2024-05-19T23:04:27.829Z",
        "icons": {
          "light": "text",
          "dark": "text"
        }
      }
    ],
    "webauthn_types": [
      "passkey"
    ]
  }
}

Delete User

Delete a user.

DELETEhttps://api.passage.id/v1/apps/{app_id}/users/{user_id}

Authorization

bearerAuth

Path parameters

app_id*string

App ID

user_id*string

User ID

Response

200401404500

OK

Request

JavaScriptCurl

const response = await fetch('https://api.passage.id/v1/apps/{app_id}/users/{user_id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

List Users

List users for an app.

GEThttps://api.passage.id/v1/apps/{app_id}/users

Authorization

bearerAuth

Path parameters

app_id*string

App ID

Query parameters

Response

200400401404500

OK

Body

application/json

_links*PaginatedLinks (object)

created_before*integer (int64)

time anchor (Unix timestamp) --> all users returned created before this timestamp

limit*integer

page*integer

total_users*integer (int64)

total number of users for a particular query

users*array of ListPaginatedUsersItem (object)

Request

JavaScriptCurl

const response = await fetch('https://api.passage.id/v1/apps/{app_id}/users', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "_links": {
    "first": {
      "href": "text"
    },
    "last": {
      "href": "text"
    },
    "next": {
      "href": "text"
    },
    "previous": {
      "href": "text"
    },
    "self": {
      "href": "text"
    }
  },
  "users": [
    {
      "created_at": "2024-05-19T23:04:27.829Z",
      "email": "text",
      "email_verified": false,
      "external_id": "text",
      "id": "text",
      "last_login_at": "2024-05-19T23:04:27.829Z",
      "phone": "text",
      "phone_verified": false,
      "status": "active",
      "updated_at": "2024-05-19T23:04:27.829Z",
      "user_metadata": {}
    }
  ]
}

Activate User

Activate a user. They will now be able to login.

PATCHhttps://api.passage.id/v1/apps/{app_id}/users/{user_id}/activate

Authorization

bearerAuth

Path parameters

app_id*string

App ID

user_id*string

User ID

Response

200401404500

OK

Body

application/json

user*UserInfo (object)

Request

JavaScriptCurl

const response = await fetch('https://api.passage.id/v1/apps/{app_id}/users/{user_id}/activate', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "user": {
    "created_at": "2024-05-19T23:04:27.829Z",
    "email": "text",
    "email_verified": false,
    "external_id": "text",
    "id": "text",
    "last_login_at": "2024-05-19T23:04:27.829Z",
    "phone": "text",
    "phone_verified": false,
    "recent_events": [
      {
        "created_at": "2024-05-19T23:04:27.829Z",
        "completed_at": "2024-05-19T23:04:27.829Z",
        "id": "text",
        "ip_addr": "text",
        "status": "complete",
        "type": "text",
        "user_agent": "text"
      }
    ],
    "social_connections": {
      "apple": {
        "provider_id": "text",
        "created_at": "2024-05-19T23:04:27.829Z",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "provider_identifier": "text"
      },
      "github": {
        "provider_id": "text",
        "created_at": "2024-05-19T23:04:27.829Z",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "provider_identifier": "text"
      },
      "google": {
        "provider_id": "text",
        "created_at": "2024-05-19T23:04:27.829Z",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "provider_identifier": "text"
      }
    },
    "status": "active",
    "updated_at": "2024-05-19T23:04:27.829Z",
    "user_metadata": {},
    "webauthn": false,
    "webauthn_devices": [
      {
        "created_at": "2024-05-19T23:04:27.829Z",
        "cred_id": "text",
        "friendly_name": "text",
        "id": "text",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "type": "passkey",
        "updated_at": "2024-05-19T23:04:27.829Z",
        "icons": {
          "light": "text",
          "dark": "text"
        }
      }
    ],
    "webauthn_types": [
      "passkey"
    ]
  }
}

Deactivate User

Deactivate a user. Their account will still exist, but they will not be able to login.

PATCHhttps://api.passage.id/v1/apps/{app_id}/users/{user_id}/deactivate

Authorization

bearerAuth

Path parameters

app_id*string

App ID

user_id*string

User ID

Response

200401404500

OK

Body

application/json

user*UserInfo (object)

Request

JavaScriptCurl

const response = await fetch('https://api.passage.id/v1/apps/{app_id}/users/{user_id}/deactivate', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "user": {
    "created_at": "2024-05-19T23:04:27.829Z",
    "email": "text",
    "email_verified": false,
    "external_id": "text",
    "id": "text",
    "last_login_at": "2024-05-19T23:04:27.829Z",
    "phone": "text",
    "phone_verified": false,
    "recent_events": [
      {
        "created_at": "2024-05-19T23:04:27.829Z",
        "completed_at": "2024-05-19T23:04:27.829Z",
        "id": "text",
        "ip_addr": "text",
        "status": "complete",
        "type": "text",
        "user_agent": "text"
      }
    ],
    "social_connections": {
      "apple": {
        "provider_id": "text",
        "created_at": "2024-05-19T23:04:27.829Z",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "provider_identifier": "text"
      },
      "github": {
        "provider_id": "text",
        "created_at": "2024-05-19T23:04:27.829Z",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "provider_identifier": "text"
      },
      "google": {
        "provider_id": "text",
        "created_at": "2024-05-19T23:04:27.829Z",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "provider_identifier": "text"
      }
    },
    "status": "active",
    "updated_at": "2024-05-19T23:04:27.829Z",
    "user_metadata": {},
    "webauthn": false,
    "webauthn_devices": [
      {
        "created_at": "2024-05-19T23:04:27.829Z",
        "cred_id": "text",
        "friendly_name": "text",
        "id": "text",
        "last_login_at": "2024-05-19T23:04:27.829Z",
        "type": "passkey",
        "updated_at": "2024-05-19T23:04:27.829Z",
        "icons": {
          "light": "text",
          "dark": "text"
        }
      }
    ],
    "webauthn_types": [
      "passkey"
    ]
  }
}

List User Devices

List user devices.

GEThttps://api.passage.id/v1/apps/{app_id}/users/{user_id}/devices

Authorization

bearerAuth

Path parameters

app_id*string

App ID

user_id*string

User ID

Response

200401404500

OK

Body

application/json

devices*array of WebAuthnDevices (object)

Request

JavaScriptCurl

const response = await fetch('https://api.passage.id/v1/apps/{app_id}/users/{user_id}/devices', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "devices": [
    {
      "created_at": "2024-05-19T23:04:27.829Z",
      "cred_id": "text",
      "friendly_name": "text",
      "id": "text",
      "last_login_at": "2024-05-19T23:04:27.829Z",
      "type": "passkey",
      "updated_at": "2024-05-19T23:04:27.829Z",
      "icons": {
        "light": "text",
        "dark": "text"
      }
    }
  ]
}

Delete a device for a user

Delete a device for a user.

DELETEhttps://api.passage.id/v1/apps/{app_id}/users/{user_id}/devices/{device_id}

Authorization

bearerAuth

Path parameters

app_id*string

App ID

user_id*string

User ID

device_id*string

Device ID

Response

200401404500

OK

Request

JavaScriptCurl

const response = await fetch('https://api.passage.id/v1/apps/{app_id}/users/{user_id}/devices/{device_id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Revokes refresh tokens

Revokes all refresh tokens for a user

DELETEhttps://api.passage.id/v1/apps/{app_id}/users/{user_id}/tokens

Authorization

bearerAuth

Path parameters

app_id*string

App ID

user_id*string

User ID

Response

200401403404500

OK

Request

JavaScriptCurl

const response = await fetch('https://api.passage.id/v1/apps/{app_id}/users/{user_id}/tokens', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();