UsersApi

All URIs are relative to http://localhost

Method	HTTP request	Description
backupDisable2FA	POST /account/2fa/backup_disable	Disable choosen 2FA provider or disable completely using backup code and user primary ID
confirm2FA	POST /account/2fa/confirm	Confirm two factor authentication update
createUser	POST /users	Register a User
deleteUser	DELETE /users/{id}	Delete a user
disable2FA	POST /account/2fa/disable	Disable choosen 2FA provider or disable completely
enable2FA	POST /account/2fa/enable	Enables two factor authentication method
getAccount	GET /account	Current user account
getAllUsers	GET /users	List users
load	GET /account/load	Load user data for a session
send2FASms	POST /account/2fa/sms_code	Send SMS 2FA code
showUser	GET /users/{id}	Show users
updateAccount	PATCH /account	Update the currently logged in user
updateUserByAdmin	PATCH /users/{id}	Update a user as an admin

backupDisable2FA

/*** @returns SuccessResponse**/async function backupDisable2FA(body: BackupDisableBody)

Disable choosen 2FA provider or disable completely using backup code and user primary ID

Example

const yat = require('yatjs');const api = new yat.YatJs();

let body = new YatJs.BackupDisableBody(); // BackupDisableBody // populate body...
try {  let res = await api.users().backupDisable2FA(body);  // res is of type SuccessResponse  console.log('API called successfully. Result: ', res);} catch (error) {  console.error(error);}

Parameters

Name	Type	Description	Notes
body	BackupDisableBody

Return type

SuccessResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: /

confirm2FA

/*** @returns SuccessResponse**/async function confirm2FA(body: Confirm2FaUpdate)

Confirm two factor authentication update

Notes:

Match 2FA code and commit two factor authentication setting for user account

Example

const yat = require('yatjs');const api = new yat.YatJs();
await api.login("[email protected]", "your_password");
let body = new YatJs.Confirm2FaUpdate(); // Confirm2FaUpdate // populate body...
try {  let res = await api.users().confirm2FA(body);  // res is of type SuccessResponse  console.log('API called successfully. Result: ', res);} catch (error) {  console.error(error);}

Parameters

Name	Type	Description	Notes
body	Confirm2FaUpdate

Return type

SuccessResponse

Authorization

two_factor

HTTP request headers

• Content-Type: Not defined
• Accept: /

createUser

/*** @returns TokenResponse**/async function createUser(body: RegisterUserParameters)

Register a User

Notes:

Create a user and a custodial wallet

Example

const yat = require('yatjs');const api = new yat.YatJs();

let body = new YatJs.RegisterUserParameters(); // RegisterUserParameters // populate body...
try {  let res = await api.users().createUser(body);  // res is of type TokenResponse  console.log('API called successfully. Result: ', res);} catch (error) {  console.error(error);}

Parameters

Name	Type	Description	Notes
body	RegisterUserParameters

Return type

TokenResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: /

deleteUser

/*** @returns DisplayUser**/async function deleteUser(id: String)

Delete a user

Notes:

NOTE: user should have scope UserDeleteSelf if deleting themselves, UserDelete is needed for other users

Example

const yat = require('yatjs');const api = new yat.YatJs();
await api.login("[email protected]", "your_password");
let id = null; // String // populate id...
try {  let res = await api.users().deleteUser(id);  // res is of type DisplayUser  console.log('API called successfully. Result: ', res);} catch (error) {  console.error(error);}

Parameters

Name	Type	Description	Notes
id	String

Return type

DisplayUser

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: /

disable2FA

/*** @returns SuccessResponse**/async function disable2FA(body: Disable2FABody)

Disable choosen 2FA provider or disable completely

Example

const yat = require('yatjs');const api = new yat.YatJs();
await api.login("[email protected]", "your_password");
let body = new YatJs.Disable2FABody(); // Disable2FABody // populate body...
try {  let res = await api.users().disable2FA(body);  // res is of type SuccessResponse  console.log('API called successfully. Result: ', res);} catch (error) {  console.error(error);}

Parameters

Name	Type	Description	Notes
body	Disable2FABody

Return type

SuccessResponse

Authorization

two_factor

HTTP request headers

• Content-Type: Not defined
• Accept: /

enable2FA

/*** @returns Enable2FAResponse**/async function enable2FA(body: Enable2FABody)

Enables two factor authentication method

Notes:

Returning parameters necessary for client to store the code NOTE: This call does not take effect until code is confirmed via POST /account/2fa/confirm except for backup codes type which is confirmed immediately

Example

const yat = require('yatjs');const api = new yat.YatJs();
await api.login("[email protected]", "your_password");
let body = new YatJs.Enable2FABody(); // Enable2FABody // populate body...
try {  let res = await api.users().enable2FA(body);  // res is of type Enable2FAResponse  console.log('API called successfully. Result: ', res);} catch (error) {  console.error(error);}

Parameters

Name	Type	Description	Notes
body	Enable2FABody

Return type

Enable2FAResponse

Authorization

two_factor

HTTP request headers

• Content-Type: Not defined
• Accept: /

getAccount

/*** @returns CurrentUser**/async function getAccount()

Current user account

Notes:

Displays the currently logged in user account details.

Example

const yat = require('yatjs');const api = new yat.YatJs();
await api.login("[email protected]", "your_password");
try {  let res = await api.users().getAccount();  // res is of type CurrentUser  console.log('API called successfully. Result: ', res);} catch (error) {  console.error(error);}

Parameters

This endpoint does not have any parameters.

Return type

CurrentUser

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: /

getAllUsers

/*** @returns ListOfDisplayUserExtended**/async function getAllUsers(opts)

List users

Notes:

NOTE: user should have scope UserList

Example

const yat = require('yatjs');const api = new yat.YatJs();
await api.login("[email protected]", "your_password");
let opts = {  'dir': "dir_example", // String |   'limit': 56, // Number |   'page': 56, // Number |   'sort': "sort_example" // String | };try {  let res = await api.users().getAllUsers(opts);  // res is of type ListOfDisplayUserExtended  console.log('API called successfully. Result: ', res);} catch (error) {  console.error(error);}

Parameters

Name	Type	Description	Notes
dir	String		[optional]
limit	Number		[optional]
page	Number		[optional]
sort	String		[optional]

Return type

ListOfDisplayUserExtended

Authorization

two_factor

HTTP request headers

• Content-Type: Not defined
• Accept: /

load

/*** @returns LoadUser**/async function load(opts)

Load user data for a session

Notes:

Aggregates all the required data a user requires to start a web session

Example

const yat = require('yatjs');const api = new yat.YatJs();
await api.login("[email protected]", "your_password");
let opts = {  'organizationId': null, // String | Lookup emojis owned by `organization_id`,  requires organization power user role  'userId': null // String | Lookup emojis owned by `user_id`,  requires Admin role};try {  let res = await api.users().load(opts);  // res is of type LoadUser  console.log('API called successfully. Result: ', res);} catch (error) {  console.error(error);}

Parameters

Name	Type	Description	Notes
organizationId	String
Lookup emojis owned by `organization_id`, requires organization power user role	[optional]
userId	String
Lookup emojis owned by `user_id`, requires Admin role	[optional]

Return type

LoadUser

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: /

send2FASms

/*** @returns SuccessResponse2FA**/async function send2FASms()

Send SMS 2FA code

Notes:

If user has setup 2FA authentication via SMS this will trigger SMS with 2fa code

Example

const yat = require('yatjs');const api = new yat.YatJs();

try {  let res = await api.users().send2FASms();  // res is of type SuccessResponse2FA  console.log('API called successfully. Result: ', res);} catch (error) {  console.error(error);}

Parameters

This endpoint does not have any parameters.

Return type

SuccessResponse2FA

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: /

showUser

/*** @returns DisplayUserExtended**/async function showUser(id: String)

Show users

Notes:

NOTE: user should have scope UserShow

Example

const yat = require('yatjs');const api = new yat.YatJs();
await api.login("[email protected]", "your_password");
let id = null; // String // populate id...
try {  let res = await api.users().showUser(id);  // res is of type DisplayUserExtended  console.log('API called successfully. Result: ', res);} catch (error) {  console.error(error);}

Parameters

Name	Type	Description	Notes
id	String

Return type

DisplayUserExtended

Authorization

two_factor

HTTP request headers

• Content-Type: Not defined
• Accept: /

updateAccount

/*** @returns UpdateAccountResponse**/async function updateAccount(body: UpdateUserParameters)

Update the currently logged in user

Notes:

NOTE: user should have scope UserWriteSelf

Example

const yat = require('yatjs');const api = new yat.YatJs();
await api.login("[email protected]", "your_password");
let body = new YatJs.UpdateUserParameters(); // UpdateUserParameters // populate body...
try {  let res = await api.users().updateAccount(body);  // res is of type UpdateAccountResponse  console.log('API called successfully. Result: ', res);} catch (error) {  console.error(error);}

Parameters

Name	Type	Description	Notes
body	UpdateUserParameters

Return type

UpdateAccountResponse

Authorization

two_factor

HTTP request headers

• Content-Type: Not defined
• Accept: /

updateUserByAdmin

/*** @returns DisplayUser**/async function updateUserByAdmin(id: String, body: AdminUpdateUserParameters)

Update a user as an admin

Notes:

NOTE: user should have scope UserWrite

Example

const yat = require('yatjs');const api = new yat.YatJs();
await api.login("[email protected]", "your_password");
let id = null; // String // populate id...
let body = new YatJs.AdminUpdateUserParameters(); // AdminUpdateUserParameters // populate body...
try {  let res = await api.users().updateUserByAdmin(id, body);  // res is of type DisplayUser  console.log('API called successfully. Result: ', res);} catch (error) {  console.error(error);}

Parameters

Name	Type	Description	Notes
id	String
body	AdminUpdateUserParameters

Return type

DisplayUser

Authorization

two_factor

HTTP request headers

• Content-Type: Not defined
• Accept: /