Class PropelAuthClient

Index

Constructors

constructor

Methods

createOrg fetchOrgByQuery fetchUserMetadataByUserId fetchUsersInOrg searchOrgs searchOrgUsers

Constructors

constructor

new PropelAuthClient(
__namedParameters: { apiKey: string; authUrl: string },
): PropelAuthClient
Parameters
- __namedParameters: { apiKey: string; authUrl: string }
Returns PropelAuthClient
- Defined in packages/clients/src/propelauth/PropelAuthClient.ts:272

Methods

createOrg

createOrg(
    __namedParameters: {
        customRoleMappingName?: string;
        domain?: string;
        enableAutoJoiningByDomain?: boolean;
        legacyOrgId?: string;
        maxUsers?: number;
        membersMustHaveMatchingDomain?: boolean;
        name: string;
    },
): Promise<CreatedOrg>
Creates an organization.

name may only contain alphanumeric characters, spaces and underscores — callers are expected to sanitize before calling.
Parameters
- __namedParameters: {
      customRoleMappingName?: string;
      domain?: string;
      enableAutoJoiningByDomain?: boolean;
      legacyOrgId?: string;
      maxUsers?: number;
      membersMustHaveMatchingDomain?: boolean;
      name: string;
  }
Returns Promise<CreatedOrg>
- Defined in packages/clients/src/propelauth/PropelAuthClient.ts:514

fetchOrgByQuery

fetchOrgByQuery(
    __namedParameters?: {
        domain?: string;
        legacyOrgId?: string;
        name?: string;
        orderBy?: "CREATED_AT_ASC" | "CREATED_AT_DESC" | "NAME";
        pageNumber?: number;
        pageSize?: number;
    },
): Promise<OrgQueryResponse>
Queries organizations. domain matches an org's configured domain, which is how onboarding decides whether a workspace already exists.

This is a POST despite being a read — that is PropelAuth's contract, not a mistake.
Parameters
- __namedParameters: {
      domain?: string;
      legacyOrgId?: string;
      name?: string;
      orderBy?: "CREATED_AT_ASC" | "CREATED_AT_DESC" | "NAME";
      pageNumber?: number;
      pageSize?: number;
  } = {}
Returns Promise<OrgQueryResponse>
- Defined in packages/clients/src/propelauth/PropelAuthClient.ts:438

fetchUserMetadataByUserId

fetchUserMetadataByUserId(
userId: string,
includeOrgs?: boolean,
): Promise<UserMetadata | null>
Fetches a single user.

Returns null when PropelAuth has no such user — callers already branch on that, so it stays a value rather than an exception.
Parameters
- userId: string
- includeOrgs: boolean = false
  populates orgIdToOrgInfo with per-org roles and permissions. Off by default; the payload is meaningfully larger with it on.
Returns Promise<UserMetadata | null>
- Defined in packages/clients/src/propelauth/PropelAuthClient.ts:332

fetchUsersInOrg

fetchUsersInOrg(
    __namedParameters: {
        includeOrgs?: boolean;
        orgId: string;
        pageNumber?: number;
        pageSize?: number;
        role?: string;
    },
): Promise<UsersInOrgPagedResponse>
Fetches one page of an organization's members.
Parameters
- __namedParameters: {
      includeOrgs?: boolean;
      orgId: string;
      pageNumber?: number;
      pageSize?: number;
      role?: string;
  }
Returns Promise<UsersInOrgPagedResponse>
- Defined in packages/clients/src/propelauth/PropelAuthClient.ts:351

searchOrgs

searchOrgs(
    query?: {
        domain?: string;
        name?: string;
        orderBy?: "CREATED_AT_ASC" | "CREATED_AT_DESC" | "NAME";
    },
): AsyncGenerator<PropelAuthOrg>
Yields every organization, paging transparently.
Parameters
- query: {
      domain?: string;
      name?: string;
      orderBy?: "CREATED_AT_ASC" | "CREATED_AT_DESC" | "NAME";
  } = {}
Returns AsyncGenerator<PropelAuthOrg>
- Defined in packages/clients/src/propelauth/PropelAuthClient.ts:482

searchOrgUsers

searchOrgUsers(
__namedParameters: { includeOrgs?: boolean; orgId: string },
): AsyncGenerator<UserInOrgMetadata>
Yields every user in a PropelAuth organization, paging transparently.
Parameters
- __namedParameters: { includeOrgs?: boolean; orgId: string }
Returns AsyncGenerator<UserInOrgMetadata>
Example
```
for await (const user of propelAuthClient.searchOrgUsers({ orgId })) {
  ...
}
```
- Defined in packages/clients/src/propelauth/PropelAuthClient.ts:404

Class PropelAuthClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns PropelAuthClient

Methods

createOrg

Parameters

Returns Promise<CreatedOrg>

fetchOrgByQuery

Parameters

Returns Promise<OrgQueryResponse>

fetchUserMetadataByUserId

Parameters

Returns Promise<UserMetadata | null>

fetchUsersInOrg

Parameters

Returns Promise<UsersInOrgPagedResponse>

searchOrgs

Parameters

Returns AsyncGenerator<PropelAuthOrg>

searchOrgUsers

Parameters

Returns AsyncGenerator<UserInOrgMetadata>

Example

Settings

On This Page