Class SeamHttpAcsAccessGroups

constructor

• new SeamHttpAcsAccessGroups(
      apiKeyOrOptions?: string | SeamHttpOptions,
  ): SeamHttpAcsAccessGroups

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsAccessGroups

client

Readonlydefaults

addUser

• addUser(
      parameters: AcsAccessGroupsAddUserParameters,
      options?: AcsAccessGroupsAddUserOptions,
  ): AcsAccessGroupsAddUserRequest

  Adds a specified access system user to a specified access group.

  Parameters

  • parameters: AcsAccessGroupsAddUserParameters
  • options: AcsAccessGroupsAddUserOptions = {}

  Returns AcsAccessGroupsAddUserRequest

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Creates a new SeamPaginator to iterate over the paginated results of the request.

  Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

delete

• delete(
      parameters: AcsAccessGroupsDeleteParameters,
      options?: AcsAccessGroupsDeleteOptions,
  ): AcsAccessGroupsDeleteRequest

  Deletes a specified access group.

  Parameters

  • parameters: AcsAccessGroupsDeleteParameters
  • options: AcsAccessGroupsDeleteOptions = {}

  Returns AcsAccessGroupsDeleteRequest

get

• get(
      parameters: AcsAccessGroupsGetParameters,
      options?: AcsAccessGroupsGetOptions,
  ): AcsAccessGroupsGetRequest

  Returns a specified access group.

  Parameters

  • parameters: AcsAccessGroupsGetParameters
  • options: AcsAccessGroupsGetOptions = {}

  Returns AcsAccessGroupsGetRequest

list

• list(
      parameters?: AcsAccessGroupsListParameters,
      options?: AcsAccessGroupsListOptions,
  ): AcsAccessGroupsListRequest

  Returns a list of all access groups.

  Parameters

  • Optionalparameters: AcsAccessGroupsListParameters
  • options: AcsAccessGroupsListOptions = {}

  Returns AcsAccessGroupsListRequest

listAccessibleEntrances

• listAccessibleEntrances(
      parameters: AcsAccessGroupsListAccessibleEntrancesParameters,
      options?: AcsAccessGroupsListAccessibleEntrancesOptions,
  ): AcsAccessGroupsListAccessibleEntrancesRequest

  Returns a list of all accessible entrances for a specified access group.

  Parameters

  • parameters: AcsAccessGroupsListAccessibleEntrancesParameters
  • options: AcsAccessGroupsListAccessibleEntrancesOptions = {}

  Returns AcsAccessGroupsListAccessibleEntrancesRequest

listUsers

• listUsers(
      parameters: AcsAccessGroupsListUsersParameters,
      options?: AcsAccessGroupsListUsersOptions,
  ): AcsAccessGroupsListUsersRequest

  Returns a list of all access system users in an access group.

  Parameters

  • parameters: AcsAccessGroupsListUsersParameters
  • options: AcsAccessGroupsListUsersOptions = {}

  Returns AcsAccessGroupsListUsersRequest

removeUser

• removeUser(
      parameters: AcsAccessGroupsRemoveUserParameters,
      options?: AcsAccessGroupsRemoveUserOptions,
  ): AcsAccessGroupsRemoveUserRequest

  Removes a specified access system user from a specified access group.

  Parameters

  • parameters: AcsAccessGroupsRemoveUserParameters
  • options: AcsAccessGroupsRemoveUserOptions = {}

  Returns AcsAccessGroupsRemoveUserRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken: string): Promise<void>

  Updates the client session token used by this client for authentication.

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

  Throws

  If this client was not created with a client session token.

StaticfromApiKey

• fromApiKey(
      apiKey: string,
      options?: Omit<SeamHttpOptionsWithApiKey, "apiKey">,
  ): SeamHttpAcsAccessGroups

  Creates a new SeamHttpAcsAccessGroups authenticated with an API key.

  Parameters

  • apiKey: string
  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpAcsAccessGroups

StaticfromClient

• fromClient(
      client: AxiosInstance,
      options?: Omit<SeamHttpOptionsWithClient, "client">,
  ): SeamHttpAcsAccessGroups

  Creates a new SeamHttpAcsAccessGroups from an existing HTTP client.

  Parameters

  • client: AxiosInstance
  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpAcsAccessGroups

StaticfromClientSessionToken

• fromClientSessionToken(
      clientSessionToken: string,
      options?: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken">,
  ): SeamHttpAcsAccessGroups

  Creates a new SeamHttpAcsAccessGroups authenticated with a client session token.

  Parameters

  • clientSessionToken: string
  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpAcsAccessGroups

StaticfromConsoleSessionToken

• fromConsoleSessionToken(
      consoleSessionToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithConsoleSessionToken,
          "consoleSessionToken"
          | "workspaceId",
      >,
  ): SeamHttpAcsAccessGroups

  Creates a new SeamHttpAcsAccessGroups authenticated with a console session token and scoped to a workspace.

  Parameters

  • consoleSessionToken: string
  • workspaceId: string
  • options: Omit<
        SeamHttpOptionsWithConsoleSessionToken,
        "consoleSessionToken"
        | "workspaceId",
    > = {}

  Returns SeamHttpAcsAccessGroups

StaticfromPersonalAccessToken

• fromPersonalAccessToken(
      personalAccessToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithPersonalAccessToken,
          "personalAccessToken"
          | "workspaceId",
      >,
  ): SeamHttpAcsAccessGroups

  Creates a new SeamHttpAcsAccessGroups authenticated with a personal access token and scoped to a workspace.

  Parameters

  • personalAccessToken: string
  • workspaceId: string
  • options: Omit<
        SeamHttpOptionsWithPersonalAccessToken,
        "personalAccessToken"
        | "workspaceId",
    > = {}

  Returns SeamHttpAcsAccessGroups

StaticfromPublishableKey

• fromPublishableKey(
      publishableKey: string,
      userIdentifierKey: string,
      options?: SeamHttpFromPublishableKeyOptions,
  ): Promise<SeamHttpAcsAccessGroups>

  Creates a new SeamHttpAcsAccessGroups authenticated with a client session token for the user identified by the user identifier key. The client session is created with the publishable key if it does not exist.

  Parameters

  • publishableKey: string
  • userIdentifierKey: string
  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpAcsAccessGroups>