Skip to content
rw3iss Auth

AppsModule

AppsModule

Defined in: auth-client/src/core/modules/apps.module.ts:13

Constructors

Constructor

new AppsModule(ctx): AppsModule

Defined in: auth-client/src/core/modules/apps.module.ts:14

Parameters

ctx

ModuleContext

Returns

AppsModule

Methods

create()

create(body): Promise<AppRecord>

Defined in: auth-client/src/core/modules/apps.module.ts:29

POST /admin/apps — register a new app. systemAdminChain.

Parameters

body

CreateAppRequest

Returns

Promise<AppRecord>


delete()

delete(appId): Promise<void>

Defined in: auth-client/src/core/modules/apps.module.ts:41

DELETE /admin/apps/{appId} — soft-delete. systemAdminChain.

Parameters

appId

string

Returns

Promise<void>


get()

get(appId): Promise<AppRecord>

Defined in: auth-client/src/core/modules/apps.module.ts:23

GET /admin/apps/{appId} — one app row. adminChain.

Parameters

appId

string

Returns

Promise<AppRecord>


getRegistrationPolicy()

getRegistrationPolicy(appCode?): Promise<RegistrationPolicy>

Defined in: auth-client/src/core/modules/apps.module.ts:57

Fetch the public registration policy for an app. Anonymous — no token required. Useful for rendering the login / register UI BEFORE the user submits: pre-filter SSO buttons against allowed_auth_methods, show a domain hint from allowed_email_domains. Server still enforces on the actual register/login call. Migration 013.

If appCode is omitted, defaults to the AuthClient’s configured appCode (set on construction). Throws if neither is set.

Parameters

appCode?

string

Returns

Promise<RegistrationPolicy>


grantUser()

grantUser(userId, appId): Promise<void>

Defined in: auth-client/src/core/modules/apps.module.ts:68

POST /admin/users/{id}/apps/{appId} — grant app access.

Parameters

userId

string

appId

string

Returns

Promise<void>


list()

list(): Promise<AppRecord[]>

Defined in: auth-client/src/core/modules/apps.module.ts:17

GET /admin/apps — list every registered app. adminChain.

Returns

Promise<AppRecord[]>


listForUser()

listForUser(userId): Promise<AppRecord[]>

Defined in: auth-client/src/core/modules/apps.module.ts:62

GET /admin/users/{id}/apps — a user’s active app memberships.

Parameters

userId

string

Returns

Promise<AppRecord[]>


revokeUser()

revokeUser(userId, appId): Promise<void>

Defined in: auth-client/src/core/modules/apps.module.ts:74

DELETE /admin/users/{id}/apps/{appId} — revoke app access.

Parameters

userId

string

appId

string

Returns

Promise<void>


update()

update(appId, body): Promise<AppRecord>

Defined in: auth-client/src/core/modules/apps.module.ts:35

PATCH /admin/apps/{appId} — partial update. systemAdminChain.

Parameters

appId

string

body

UpdateAppRequest

Returns

Promise<AppRecord>