Class UsersClient

User account CRUD and the user→organizations read.

Index

Constructors

Methods

create delete get getSignupChallenge listOrganizations update

Constructors

constructor

new UsersClient(call: Caller, callPublic: Caller): UsersClient
Parameters
- call: Caller
  authed Caller for the user-scoped endpoints.
- callPublic: Caller
  auth-less Caller for the public signup endpoints (create, getSignupChallenge) — a brand-new user has no credentials yet, so registration must not run credential resolution.
Returns UsersClient
- Defined in src/resources/users.ts:71

Methods

create

create(req: CreateUserRequest, opts?: RequestOptions): Promise<UserRegistration>
Register a user. Public route — sent without authentication.
Parameters
- req: CreateUserRequest
- Optionalopts: RequestOptions
Returns Promise<UserRegistration>
- Defined in src/resources/users.ts:121

delete

delete(req: DeleteUserRequest, opts?: RequestOptions): Promise<void>
Delete a user account.
Parameters
- req: DeleteUserRequest
- Optionalopts: RequestOptions
Returns Promise<void>
Throws
NotFoundError if the user does not exist.
- Defined in src/resources/users.ts:159

get

get(email: string, opts?: RequestOptions): Promise<UserData>
Fetch a user by email.
Parameters
- email: string
- Optionalopts: RequestOptions
Returns Promise<UserData>
Throws
NotFoundError if the user does not exist.
- Defined in src/resources/users.ts:138

getSignupChallenge

getSignupChallenge(opts?: RequestOptions): Promise<SignupChallengeResponse>
Fetch the proof-of-work signup challenge a visitor must solve before calling UsersClient.create. Public route — sent without authentication, since the caller is a pre-signup visitor with no credentials.

The result is discriminated on enabled: when the backend stage has no challenge secret configured the mechanism is entirely off and the caller proceeds straight to create with no challenge fields.
Parameters
- Optionalopts: RequestOptions
Returns Promise<SignupChallengeResponse>
Example
```
const res = await client.users.getSignupChallenge();
if (res.enabled) {
  const solution = solve(res.challenge); // caller-side proof of work
  await client.users.create({
    email, termsAccepted: true,
    challengeToken: res.challenge.token,
    challengeSolution: solution,
    hpWebsite: '',
  });
} else {
  await client.users.create({ email, termsAccepted: true });
}
```
Throws
ServerError if the route reports the challenge enabled but omits the challenge body — an unusable response, never silently downgraded to the disabled arm.
- Defined in src/resources/users.ts:106

listOrganizations

listOrganizations(
params: { email: string },
opts?: RequestOptions,
): Promise<OrganizationData[]>
List the organizations the user is a member of.
Parameters
- params: { email: string }
- Optionalopts: RequestOptions
Returns Promise<OrganizationData[]>
- Defined in src/resources/users.ts:167

update

update(req: UpdateUserRequest, opts?: RequestOptions): Promise<UserData>
Update a user; returns the updated row.
Parameters
- req: UpdateUserRequest
- Optionalopts: RequestOptions
Returns Promise<UserData>
Throws
NotFoundError if the user does not exist.
- Defined in src/resources/users.ts:147