@reactor/auth — membersclient
@reactor/auth / MembersClient
Class: MembersClient
Section titled “Class: MembersClient”Defined in: orgs.ts:99
Members client for managing organization members.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new MembersClient(
ctx,orgId):MembersClient
Defined in: orgs.ts:100
Parameters
Section titled “Parameters”RequestContext
string
Returns
Section titled “Returns”MembersClient
Methods
Section titled “Methods”get(
userId):Promise<Result<Member>>
Defined in: orgs.ts:122
Get a specific member.
Parameters
Section titled “Parameters”userId
Section titled “userId”string
Returns
Section titled “Returns”Promise<Result<Member>>
invite()
Section titled “invite()”invite(
params):Promise<Result<Invitation>>
Defined in: orgs.ts:132
Invite a user to the organization.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<Result<Invitation>>
list()
Section titled “list()”list(
params?):Promise<Result<Member[]>>
Defined in: orgs.ts:108
List members of the organization.
Parameters
Section titled “Parameters”params?
Section titled “params?”any
Returns
Section titled “Returns”Promise<Result<Member[]>>
remove()
Section titled “remove()”remove(
userId):Promise<Result<void>>
Defined in: orgs.ts:154
Remove a member from the organization.
Parameters
Section titled “Parameters”userId
Section titled “userId”string
Returns
Section titled “Returns”Promise<Result<void>>
updateRole()
Section titled “updateRole()”updateRole(
userId,params):Promise<Result<Member>>
Defined in: orgs.ts:143
Update a member’s role.
Parameters
Section titled “Parameters”userId
Section titled “userId”string
params
Section titled “params”Returns
Section titled “Returns”Promise<Result<Member>>