Class SeamHttpAcsAccessGroups

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsAccessGroups

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

unmanaged

• get unmanaged(): SeamHttpAcsAccessGroupsUnmanaged

  Returns SeamHttpAcsAccessGroupsUnmanaged

addUser

• addUser(
      parameters: {
          acs_access_group_id: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsAccessGroupsAddUserOptions,
  ): AcsAccessGroupsAddUserRequest

  Parameters

  • parameters: { acs_access_group_id: string; acs_user_id?: string; user_identity_id?: string }

    • acs_access_group_id: string

      ID of the access group to which you want to add an access system user.

    • Optionalacs_user_id?: string

      ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.

    • Optionaluser_identity_id?: string

      ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same email_address or phone_number as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.

  • options: AcsAccessGroupsAddUserOptions = {}

  Returns AcsAccessGroupsAddUserRequest

createPaginator

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

  Type Parameters

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

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

delete

• delete(
      parameters: { acs_access_group_id: string },
      options?: AcsAccessGroupsDeleteOptions,
  ): AcsAccessGroupsDeleteRequest

  Parameters

  • parameters: { acs_access_group_id: string }

    • acs_access_group_id: string

      ID of the access group that you want to delete.

  • options: AcsAccessGroupsDeleteOptions = {}

  Returns AcsAccessGroupsDeleteRequest

get

• get(
      parameters: { acs_access_group_id: string },
      options?: AcsAccessGroupsGetOptions,
  ): AcsAccessGroupsGetRequest

  Parameters

  • parameters: { acs_access_group_id: string }

    • acs_access_group_id: string

      ID of the access group that you want to get.

  • options: AcsAccessGroupsGetOptions = {}

  Returns AcsAccessGroupsGetRequest

list

• list(
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          search?: string;
          user_identity_id?: string;
      },
      options?: AcsAccessGroupsListOptions,
  ): AcsAccessGroupsListRequest

  Parameters

  • Optionalparameters: {
        acs_system_id?: string;
        acs_user_id?: string;
        search?: string;
        user_identity_id?: string;
    }

    • Optionalacs_system_id?: string

      ID of the access system for which you want to retrieve all access groups.

    • Optionalacs_user_id?: string

      ID of the access system user for which you want to retrieve all access groups.

    • Optionalsearch?: string

      String for which to search. Filters returned access groups to include all records that satisfy a partial match using name or acs_access_group_id.

    • Optionaluser_identity_id?: string

      ID of the user identity for which you want to retrieve all access groups.

  • options: AcsAccessGroupsListOptions = {}

  Returns AcsAccessGroupsListRequest

listAccessibleEntrances

• listAccessibleEntrances(
      parameters: { acs_access_group_id: string },
      options?: AcsAccessGroupsListAccessibleEntrancesOptions,
  ): AcsAccessGroupsListAccessibleEntrancesRequest

  Parameters

  • parameters: { acs_access_group_id: string }

    • acs_access_group_id: string

      ID of the access group for which you want to retrieve all accessible entrances.

  • options: AcsAccessGroupsListAccessibleEntrancesOptions = {}

  Returns AcsAccessGroupsListAccessibleEntrancesRequest

listUsers

• listUsers(
      parameters: { acs_access_group_id: string },
      options?: AcsAccessGroupsListUsersOptions,
  ): AcsAccessGroupsListUsersRequest

  Parameters

  • parameters: { acs_access_group_id: string }

    • acs_access_group_id: string

      ID of the access group for which you want to retrieve all access system users.

  • options: AcsAccessGroupsListUsersOptions = {}

  Returns AcsAccessGroupsListUsersRequest

removeUser

• removeUser(
      parameters: {
          acs_access_group_id: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsAccessGroupsRemoveUserOptions,
  ): AcsAccessGroupsRemoveUserRequest

  Parameters

  • parameters: { acs_access_group_id: string; acs_user_id?: string; user_identity_id?: string }

    • acs_access_group_id: string

      ID of the access group from which you want to remove an access system user.

    • Optionalacs_user_id?: string

      ID of the access system user that you want to remove from an access group.

    • Optionaluser_identity_id?: string

      ID of the user identity associated with the user that you want to remove from an access group.

  • options: AcsAccessGroupsRemoveUserOptions = {}

  Returns AcsAccessGroupsRemoveUserRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpAcsAccessGroups

StaticfromClient

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

  Parameters

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

  Returns SeamHttpAcsAccessGroups

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpAcsAccessGroups

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpAcsAccessGroups

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpAcsAccessGroups

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpAcsAccessGroups>