Class OrganizationMembersService

Manage organization members from the API.

Hierarchy

Service<OrganizationsManagingMembersApi>
- OrganizationMembersService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OrganizationMembersService(environment: Environment, log?: Logger): OrganizationMembersService

Inherited from Service<OrganizationsManagingMembersApi>.constructor
- Defined in packages/sdk/src/services/service.ts:48
Parameters
- environment: Environment
- log: Logger = ...
Returns OrganizationMembersService

Properties

Protected environment

environment: Environment

Protected keystoreAPIFactory

keystoreAPIFactory: KeystoreAPIFactory

Protected logger

logger: IFullLogger

Protected vaultAPIFactory

vaultAPIFactory: VaultAPIFactory

Methods

createInvite

createInvite(credentials: IVaultToken, organizationAgentPublicKey: string, role?: OrganizationMemberRoles): Promise<Invitation>

- Defined in packages/sdk/src/services/organization-members-service.ts:23
Invite a Vault user to become an Organization member.

Parameters
- credentials: IVaultToken
- organizationAgentPublicKey: string
- role: OrganizationMemberRoles = ...
  
  Role of the new member
Returns Promise<Invitation>

getAPI

getAPI(token: IVaultToken): OrganizationsManagingMembersApi

Overrides Service.getAPI
- Defined in packages/sdk/src/services/organization-members-service.ts:14
Parameters
- token: IVaultToken
Returns OrganizationsManagingMembersApi

list

list(credentials: IVaultToken, organizationId: string, options?: IPageOptions): Promise<ListOrganizationMemberResponse>

- Defined in packages/sdk/src/services/organization-members-service.ts:61
Parameters
- credentials: IVaultToken
- organizationId: string
- Optional options: IPageOptions
Returns Promise<ListOrganizationMemberResponse>

listAll

listAll(credentials: IVaultToken, organizationId: string): Promise<ListOrganizationMemberResponse>

- Defined in packages/sdk/src/services/organization-members-service.ts:75
Parameters
- credentials: IVaultToken
- organizationId: string
Returns Promise<ListOrganizationMemberResponse>

setLogger

setLogger(logger: Logger): void

Inherited from Service.setLogger
- Defined in packages/sdk/src/services/service.ts:56
Parameters
- logger: Logger
Returns void

updateMemberRole

updateMemberRole(credentials: IVaultToken, organizationId: string, userId: string, newRole: OrganizationMemberRoles): Promise<void>

- Defined in packages/sdk/src/services/organization-members-service.ts:42
Parameters
- credentials: IVaultToken
- organizationId: string
- userId: string
- newRole: OrganizationMemberRoles
Returns Promise<void>

Generated using TypeDoc