User SDK

A person who interacts with the system, performs tasks, makes decisions, and owns or operates businesses.

Import

import { $ } from 'sdk.do'

Operations

create

Create a new user account with profile information.

const result = await $.User.create({
  // parameters
})

update

Modify user profile, settings, or permissions.

const result = await $.User.update({
  // parameters
})

delete

Permanently remove the user account.

const result = await $.User.delete({
  // parameters
})

authenticate

Verify user identity and credentials.

const result = await $.User.authenticate({
  // parameters
})

authorize

Check if user has permission for a specific action.

const result = await $.User.authorize({
  // parameters
})

suspend

Temporarily disable the user account.

const result = await $.User.suspend({
  // parameters
})

activate

Enable a suspended or inactive user account.

const result = await $.User.activate({
  // parameters
})

invite

Send invitation to join the system or organization.

const result = await $.User.invite({
  // parameters
})

assign

Assign user to a role, team, or business.

const result = await $.User.assign({
  // parameters
})

Events

created

Triggered when a new user account is created.

import { on, send } from 'sdk.do'

// Subscribe to event
on.User.created(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.User.created({ /* data */ })

updated

Triggered when user profile or settings are modified.

import { on, send } from 'sdk.do'

// Subscribe to event
on.User.updated(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.User.updated({ /* data */ })

deleted

Triggered when a user account is removed.

import { on, send } from 'sdk.do'

// Subscribe to event
on.User.deleted(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.User.deleted({ /* data */ })

authenticated

Triggered when user successfully logs in.

import { on, send } from 'sdk.do'

// Subscribe to event
on.User.authenticated(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.User.authenticated({ /* data */ })

authorized

Triggered when user permission check is performed.

import { on, send } from 'sdk.do'

// Subscribe to event
on.User.authorized(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.User.authorized({ /* data */ })

suspended

Triggered when user account is temporarily disabled.

import { on, send } from 'sdk.do'

// Subscribe to event
on.User.suspended(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.User.suspended({ /* data */ })

activated

Triggered when suspended account is re-enabled.

import { on, send } from 'sdk.do'

// Subscribe to event
on.User.activated(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.User.activated({ /* data */ })

invited

Triggered when invitation is sent to user.

import { on, send } from 'sdk.do'

// Subscribe to event
on.User.invited(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.User.invited({ /* data */ })

assigned

Triggered when user is assigned to role or team.

import { on, send } from 'sdk.do'

// Subscribe to event
on.User.assigned(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.User.assigned({ /* data */ })

User SDK

On this page