...
SSO process will create a user record on VSee side when you first call this API and will map to and return existing user record for further requests.
GET parameters
Use POST /users/sso?fields=vsee parameter to include the following object as part of the response. This may be used for Browser Call SDK workflow.
Code Block |
---|
"vsee": {
"id": "ccpreview+606ce3e353c8411a8e7b52c664457b1f",
"token": "78fc497ff743d2b51050d9102acabe63"
} |
Parameters
Parameter | Type | Description |
---|
first_name
| String
| Required
|
last_name
| String
| Required
|
dob
| String
| Optional
|
type
| Integer
| 200 : Member, 400 : Provider, 600 : Guest User
|
code
| String
| Required if type is 200 or 400 / Max length: 128 character
code is a unique user identifier on your end. VSee will store the code for this user record and next time you call SSO, we will return you the same existing user.
|
email
| String
| Optional
|
username
| String
| Optional - system will generate one as fallback
|
disable_emails
| Integer
| Optional - set to 1 - if you want user to disable all email notification
|
...