Class AdminClient

Index

Constructors

Methods

addAllowedOrigins addRole deactivateProfile getProfile listAllowedOrigins listProfiles removeAllowedOrigins removeRole setAllowedOrigins updateProfile

Constructors

constructor

new AdminClient(config: AdminConfig): AdminClient
Parameters
- config: AdminConfig
Returns AdminClient
- Defined in admin.ts:27

Methods

addAllowedOrigins

addAllowedOrigins(
orgId: string,
origins: string[],
): Promise<AllowedOriginsResponse>
Add origin(s) to the allowed list for an organization.
Parameters
- orgId: string
  Organization ID
- origins: string[]
  Origins to add
Returns Promise<AllowedOriginsResponse>
- Defined in admin.ts:304

addRole

addRole(
    profileId: string,
    role: string,
    brandOrgId?: string,
): Promise<UserProfile>
Add a role to a user profile. Idempotent — if the role is already present, the profile is returned unchanged without an update call. Preserves all other roles.
Parameters
- profileId: string
  Profile ID
- role: string
  Role string to add (e.g. 'public-files')
- OptionalbrandOrgId: string
  Organization ID. If omitted, defaults to the org associated with the API key.
Returns Promise<UserProfile>
The updated profile (or the original, unchanged, if the role was already present).

Remarks
Implemented as read-modify-write against the underlying profile endpoint, which is not atomic. Concurrent addRole/removeRole calls on the same profile can race and lose updates. Callers should serialize role mutations per profile (typical sign-up / admin flows already do this naturally).
- Defined in admin.ts:200

deactivateProfile

deactivateProfile(
profileId: string,
brandOrgId?: string,
): Promise<{ message: string; profile: UserProfile }>
Deactivate (soft-delete) a user profile.
Parameters
- profileId: string
  Profile ID
- OptionalbrandOrgId: string
  Organization ID. If omitted, defaults to the org associated with the API key.
Returns Promise<{ message: string; profile: UserProfile }>
- Defined in admin.ts:256

getProfile

getProfile(profileId: string, brandOrgId?: string): Promise<UserProfile>
Get a single user profile by ID.
Parameters
- profileId: string
  Profile ID
- OptionalbrandOrgId: string
  Organization ID. If omitted, defaults to the org associated with the API key.
Returns Promise<UserProfile>
- Defined in admin.ts:132

listAllowedOrigins

listAllowedOrigins(orgId: string): Promise<AllowedOriginsResponse>
List allowed origins for an organization.
Parameters
- orgId: string
  Organization ID
Returns Promise<AllowedOriginsResponse>
- Defined in admin.ts:277

listProfiles

listProfiles(
brandOrgId?: string,
options?: ListProfilesOptions,
): Promise<PaginatedResponse<UserProfile>>
List user profiles for an organization.
Parameters
- OptionalbrandOrgId: string
  Organization ID. If omitted, defaults to the org associated with the API key.
- options: ListProfilesOptions = {}
Returns Promise<PaginatedResponse<UserProfile>>
- Defined in admin.ts:109

removeAllowedOrigins

removeAllowedOrigins(
orgId: string,
origins: string[],
): Promise<AllowedOriginsResponse>
Remove origin(s) from the allowed list for an organization.
Parameters
- orgId: string
  Organization ID
- origins: string[]
  Origins to remove
Returns Promise<AllowedOriginsResponse>
- Defined in admin.ts:318

removeRole

removeRole(
    profileId: string,
    role: string,
    brandOrgId?: string,
): Promise<UserProfile>
Remove a role from a user profile. Idempotent — if the role is not present, the profile is returned unchanged without an update call. Preserves all other roles.
Parameters
- profileId: string
  Profile ID
- role: string
  Role string to remove
- OptionalbrandOrgId: string
  Organization ID. If omitted, defaults to the org associated with the API key.
Returns Promise<UserProfile>
The updated profile (or the original, unchanged, if the role was absent).

Remarks
Implemented as read-modify-write against the underlying profile endpoint, which is not atomic. Concurrent addRole/removeRole calls on the same profile can race and lose updates. Callers should serialize role mutations per profile.
- Defined in admin.ts:233

setAllowedOrigins

setAllowedOrigins(
orgId: string,
origins: string[],
): Promise<AllowedOriginsResponse>
Replace all allowed origins for an organization.
Parameters
- orgId: string
  Organization ID
- origins: string[]
  Complete list of allowed origins (replaces existing)
Returns Promise<AllowedOriginsResponse>
- Defined in admin.ts:290

updateProfile

updateProfile(
    profileId: string,
    updates: UpdateProfileData,
    brandOrgId?: string,
): Promise<UserProfile>
Update a user profile's core fields.

Roles are stripped defensively — they cannot be set via this method. Use addRole / removeRole for role changes.
Parameters
- profileId: string
  Profile ID
- updates: UpdateProfileData
  Fields to update
- OptionalbrandOrgId: string
  Organization ID. If omitted, defaults to the org associated with the API key.
Returns Promise<UserProfile>
- Defined in admin.ts:152

Class AdminClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AdminClient

Methods

addAllowedOrigins

Parameters

Returns Promise<AllowedOriginsResponse>

addRole

Parameters

Returns Promise<UserProfile>

Remarks

deactivateProfile

Parameters

Returns Promise<{ message: string; profile: UserProfile }>

getProfile

Parameters

Returns Promise<UserProfile>

listAllowedOrigins

Parameters

Returns Promise<AllowedOriginsResponse>

listProfiles

Parameters

Returns Promise<PaginatedResponse<UserProfile>>

removeAllowedOrigins

Parameters

Returns Promise<AllowedOriginsResponse>

removeRole

Parameters

Returns Promise<UserProfile>

Remarks

setAllowedOrigins

Parameters

Returns Promise<AllowedOriginsResponse>

updateProfile

Parameters

Returns Promise<UserProfile>

Settings

On This Page