Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel7

User Object

Type

Value

Meaning

Description

100

Admin

Admin user

110

Cronjob

For system use

140

System

For system use

150

Common Admin

Admin user

160

API

For system use

200

Member

A registered patient

300

Company

400

Provider

Provider: Physician or CSR

600

Guest

Guest one-time user

700

Phone Bridge

User joined by dial-in

500

Kiosk

deprecated

Response

GET /users

Filter Parameters

...

  1. user_type will be member(200), provider(400), …, etc

  2. There is 2 methods for log in

    1. active user

      1. use username and password field

    2. inactive user

      1. user email and email token sent to their email

      2. only after user update their password via API, their status will change to active and can log in via active user log in method above.

Parameters

Parameter

Type

Description

username

String

(for active user only)

password

String

(for active user only)

email

String

(for non-active user who has not set the password yet)

email_token

String

(for non-active user who has not set the password yet)

Response

Note: you can use the token.token return here to redirect user from your portal to VSee Clinic portal, please see Section Web log in using SSO Token.

...