Class Organizations

constructor

• new Organizations(api: Api): Organizations

• Parameters

  • api: Api

  Returns Organizations

api

addToOrganization

• addToOrganization(
      organization: string,
      uids: string[],
      type?: MembersType,
  ): Promise<ApiResponse<unknown, unknown>>

• Parameters

  • organization: string
  • uids: string[]
  • type: MembersType = 'users'

  Returns Promise<ApiResponse<unknown, unknown>>

addToSecurityGroup

• addToSecurityGroup(
      securityGroup: string,
      uids: string[],
  ): Promise<ApiResponse<unknown, unknown>>

• Parameters

  • securityGroup: string
  • uids: string[]

  Returns Promise<ApiResponse<unknown, unknown>>

change

• change(id: string): Promise<ApiResponse<unknown, unknown>>

• Parameters

  • id: string

  Returns Promise<ApiResponse<unknown, unknown>>

createOrganization

• createOrganization(
      data: OrganizationRequestData,
  ): Promise<ApiResponse<OrganizationData, OrganizationData>>

• Parameters

  • data: OrganizationRequestData

  Returns Promise<ApiResponse<OrganizationData, OrganizationData>>

get

• get(): Promise<ApiResponse<{ data: Organization[] }, { data: Organization[] }>>

• Returns Promise<ApiResponse<{ data: Organization[] }, { data: Organization[] }>>

getAdminOrganizations

• getAdminOrganizations(): Promise<
      ApiResponse<
          UserAdminOrganizationsResponse,
          UserAdminOrganizationsResponse,
      >,
  >

• Returns Promise<
      ApiResponse<
          UserAdminOrganizationsResponse,
          UserAdminOrganizationsResponse,
      >,
  >

getOrganizationMembers

• getOrganizationMembers(organizationId: string): Promise<User[]>

• Parameters

  • organizationId: string

  Returns Promise<User[]>