Safety Net Blueprint — Client Reference: Identity Access

Users (6)

▶ listUsers() You can provide a client instance returned by `createClient()` instead of #

users.listUsers({
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})

Parameters

q search →	string	query	optional
limit	number	query	optional
offset	number	query	optional
sort	string	query	optional

▶ createUser() Create a user #

users.createUser({ body: { ... } })

Parameters

body

object

body

required

▶ getCurrentUser() Get the authenticated user #

users.getCurrentUser()

▶ deactivateUser(userId) Deactivate a user #

users.deactivateUser({ path: { userId: string } })

Parameters

userId

string

path

required

▶ getUser(userId) Get a user #

users.getUser({ path: { userId: string } })

Parameters

userId

string

path

required

▶ updateUser(userId) Update a user #

users.updateUser({ path: { userId: string }, body: { ... } })

Parameters

userId	string	path	required
body	object	body	required

Claims (1)

▶ getTokenClaims(sub) Get claims for JWT enrichment #

users.getTokenClaims({ path: { sub: string } })

Parameters

sub

string

path

required

Constants (4)

▶ Domain enum (6 values) #

'client-management'
'data-exchange'
'document-management'
'eligibility'
'intake'
'workflow'

▶ Frequency enum (7 values) #

'daily'
'weekly'
'every_two_weeks'
'twice_monthly'
'monthly'
'yearly'
'variable'

▶ Program enum (5 values) #

'snap'
'medicaid'
'chip'
'tanf'
'aca'

▶ RoleType enum (7 values) #

'applicant'
'case_worker'
'supervisor'
'county_admin'
'state_admin'
'partner_readonly'
'system'

Types (9)

▶ User 10 fields #

interface User {
  idpSubject?: string
  email?: string
  name?: string
  roles?: object
  status?: enum: "active", "inactive", "pending", "suspended"
  counties?: array[string]
  organizationId?: string
  personId?: string
  caseWorkerId?: string
  preferences?: object
}

▶ FrontendAuthContext 2 fields #

interface FrontendAuthContext {
  userId: string
  roles: object
}

▶ TokenClaims 2 fields #

interface TokenClaims {
  userId: string
  roles: object
}

▶ UserCreate 10 fields #

interface UserCreate {
  idpSubject?: string
  email?: string
  name?: string
  roles?: object
  status?: enum: "active", "inactive", "pending", "suspended"
  counties?: array[string]
  organizationId?: string
  personId?: string
  caseWorkerId?: string
  preferences?: object
}

▶ UserList 4 fields #

interface UserList {
  total: number
  limit: number
  offset: number
  hasNext?: boolean
}

▶ UserUpdate 10 fields #

interface UserUpdate {
  idpSubject?: string
  email?: string
  name?: string
  roles?: object
  status?: enum: "active", "inactive", "pending", "suspended"
  counties?: array[string]
  organizationId?: string
  personId?: string
  caseWorkerId?: string
  preferences?: object
}

▶ UserWritable 10 fields #

interface UserWritable {
  idpSubject?: string
  email?: string
  name?: string
  roles?: object
  status?: enum: "active", "inactive", "pending", "suspended"
  counties?: array[string]
  organizationId?: string
  personId?: string
  caseWorkerId?: string
  preferences?: object
}

▶ FrontendAuthContextWritable 2 fields #

interface FrontendAuthContextWritable {
  userId: string
  roles: object
}

▶ UserListWritable 4 fields #

interface UserListWritable {
  total: number
  limit: number
  offset: number
  hasNext?: boolean
}