@reactor/auth — orgsclient
@reactor/auth / OrgsClient
Class: OrgsClient
Section titled “Class: OrgsClient”Defined in: orgs.ts:25
Organizations client for managing organizations, members, and invitations.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new OrgsClient(
ctx):OrgsClient
Defined in: orgs.ts:26
Parameters
Section titled “Parameters”RequestContext
Returns
Section titled “Returns”OrgsClient
Accessors
Section titled “Accessors”invitations
Section titled “invitations”Get Signature
Section titled “Get Signature”get invitations():
InvitationsClient
Defined in: orgs.ts:84
Get the invitations client.
Returns
Section titled “Returns”Methods
Section titled “Methods”create()
Section titled “create()”create(
params):Promise<Result<Organization>>
Defined in: orgs.ts:52
Create a new organization.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<Result<Organization>>
delete()
Section titled “delete()”delete(
idOrSlug):Promise<Result<void>>
Defined in: orgs.ts:70
Delete an organization.
Parameters
Section titled “Parameters”idOrSlug
Section titled “idOrSlug”string
Returns
Section titled “Returns”Promise<Result<void>>
get(
idOrSlug):Promise<Result<Organization>>
Defined in: orgs.ts:45
Get an organization by ID or slug.
Parameters
Section titled “Parameters”idOrSlug
Section titled “idOrSlug”string
Returns
Section titled “Returns”Promise<Result<Organization>>
list()
Section titled “list()”list(
params?):Promise<Result<Organization[]>>
Defined in: orgs.ts:31
List organizations the current user belongs to.
Parameters
Section titled “Parameters”params?
Section titled “params?”any
Returns
Section titled “Returns”Promise<Result<Organization[]>>
listRoles()
Section titled “listRoles()”listRoles():
Promise<Result<Role[]>>
Defined in: orgs.ts:91
List available roles.
Returns
Section titled “Returns”Promise<Result<Role[]>>
members()
Section titled “members()”members(
orgId):MembersClient
Defined in: orgs.ts:77
Get a members client scoped to an organization.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”update()
Section titled “update()”update(
idOrSlug,params):Promise<Result<Organization>>
Defined in: orgs.ts:59
Update an organization.
Parameters
Section titled “Parameters”idOrSlug
Section titled “idOrSlug”string
params
Section titled “params”Returns
Section titled “Returns”Promise<Result<Organization>>