OrganizationsModule

Defined in: auth-client/src/core/modules/organizations.module.ts:24

Constructors

Constructor

new OrganizationsModule(ctx): OrganizationsModule

Defined in: auth-client/src/core/modules/organizations.module.ts:25

Parameters

ctx

ModuleContext

Returns

OrganizationsModule

Methods

addMember()

addMember(orgId, userId, roleIds?): Promise<void>

Defined in: auth-client/src/core/modules/organizations.module.ts:87

POST /admin/organizations/{orgId}/members — add an existing user.

Parameters

orgId

string

userId

string

roleIds?

string[] = []

Returns

Promise<void>

adminGet()

adminGet(orgId): Promise<Organization>

Defined in: auth-client/src/core/modules/organizations.module.ts:63

GET /admin/organizations/{orgId}. system_admin only. Use this in back-office UIs when the operator may not be a member of the org.

Parameters

orgId

string

Returns

Promise<Organization>

adminListMembers()

adminListMembers(orgId): Promise<OrgMemberRecord[]>

Defined in: auth-client/src/core/modules/organizations.module.ts:81

GET /admin/organizations/{orgId}/members. system_admin only.

Parameters

orgId

string

Returns

Promise<OrgMemberRecord[]>

adminRemoveMember()

adminRemoveMember(orgId, userId): Promise<void>

Defined in: auth-client/src/core/modules/organizations.module.ts:99

DELETE /admin/organizations/{orgId}/members/{userId} — remove a member (admin path).

Parameters

orgId

string

userId

string

Returns

Promise<void>

adminUpdate()

adminUpdate(orgId, body): Promise<Organization>

Defined in: auth-client/src/core/modules/organizations.module.ts:69

PUT /admin/organizations/{orgId}. system_admin only.

Parameters

orgId

string

body

UpdateOrgRequest

Returns

Promise<Organization>

create()

create(body): Promise<Organization>

Defined in: auth-client/src/core/modules/organizations.module.ts:50

POST /admin/organizations — create. Admin only.

Parameters

body

CreateOrgRequest

Returns

Promise<Organization>

createInvitation()

createInvitation(orgId, body): Promise<InvitationRecord>

Defined in: auth-client/src/core/modules/organizations.module.ts:155

POST /orgs/{orgId}/invitations — invite by email.

Parameters

orgId

string

body

CreateInvitationRequest

Returns

Promise<InvitationRecord>

createRole()

createRole(orgId, body): Promise<OrgRoleRecord>

Defined in: auth-client/src/core/modules/organizations.module.ts:131

POST /orgs/{orgId}/roles — create a custom role.

Parameters

orgId

string

body

CreateOrgRoleRequest

Returns

Promise<OrgRoleRecord>

delete()

delete(orgId): Promise<void>

Defined in: auth-client/src/core/modules/organizations.module.ts:56

DELETE /admin/organizations/{orgId}. Admin only.

Parameters

orgId

string

Returns

Promise<void>

deleteRole()

deleteRole(orgId, roleId): Promise<void>

Defined in: auth-client/src/core/modules/organizations.module.ts:143

DELETE /orgs/{orgId}/roles/{roleId}.

Parameters

orgId

string

roleId

string

Returns

Promise<void>

get()

get(orgId): Promise<Organization>

Defined in: auth-client/src/core/modules/organizations.module.ts:28

GET /orgs/{orgId} — read settings. Requires org:read.

Parameters

orgId

string

Returns

Promise<Organization>

getRole()

getRole(orgId, roleId): Promise<OrgRoleRecord>

Defined in: auth-client/src/core/modules/organizations.module.ts:125

GET /orgs/{orgId}/roles/{roleId}.

Parameters

orgId

string

roleId

string

Returns

Promise<OrgRoleRecord>

list()

list(): Promise<Organization[]>

Defined in: auth-client/src/core/modules/organizations.module.ts:38

GET /admin/organizations — list every org. adminChain (system_admin OR super_admin). For back-office UIs that need a full picker (filter dropdowns, admin tables).

Returns

Promise<Organization[]>

listAssignablePermissions()

listAssignablePermissions(orgId): Promise<AssignablePermissionRecord[]>

Defined in: auth-client/src/core/modules/organizations.module.ts:149

GET /orgs/{orgId}/permissions/assignable — for the role-editor picker.

Parameters

orgId

string

Returns

Promise<AssignablePermissionRecord[]>

listInvitations()

listInvitations(orgId): Promise<InvitationRecord[]>

Defined in: auth-client/src/core/modules/organizations.module.ts:161

GET /orgs/{orgId}/invitations — list pending org-side.

Parameters

orgId

string

Returns

Promise<InvitationRecord[]>

listMembers()

listMembers(orgId): Promise<OrgMemberRecord[]>

Defined in: auth-client/src/core/modules/organizations.module.ts:75

GET /orgs/{orgId}/members. Requires org:members:read.

Parameters

orgId

string

Returns

Promise<OrgMemberRecord[]>

listRoles()

listRoles(orgId): Promise<OrgRoleRecord[]>

Defined in: auth-client/src/core/modules/organizations.module.ts:119

GET /orgs/{orgId}/roles. Requires org:roles:read.

Parameters

orgId

string

Returns

Promise<OrgRoleRecord[]>

removeMember()

removeMember(orgId, userId): Promise<void>

Defined in: auth-client/src/core/modules/organizations.module.ts:93

DELETE /orgs/{orgId}/members/{userId}. Requires org:members:remove.

Parameters

orgId

string

userId

string

Returns

Promise<void>

revokeInvitation()

revokeInvitation(orgId, invitationId): Promise<void>

Defined in: auth-client/src/core/modules/organizations.module.ts:167

DELETE /orgs/{orgId}/invitations/{id} — revoke.

Parameters

orgId

string

invitationId

string

Returns

Promise<void>

setMemberRoles()

setMemberRoles(orgId, userId, roleCodes): Promise<OrgMemberRecord>

Defined in: auth-client/src/core/modules/organizations.module.ts:113

PUT /admin/organizations/{orgId}/members/{userId}/roles — replace a member’s org-role set (set semantics; org-scoped codes only). system_admin only. Backs org-admin reassignment.