Class SeamHttpAcsUsers

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsUsers

client

Readonlydefaults

addToAccessGroup

• addToAccessGroup(
      parameters: AcsUsersAddToAccessGroupParameters,
      options?: AcsUsersAddToAccessGroupOptions,
  ): AcsUsersAddToAccessGroupRequest

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

  Parameters

  • parameters: AcsUsersAddToAccessGroupParameters
  • options: AcsUsersAddToAccessGroupOptions = {}

  Returns AcsUsersAddToAccessGroupRequest

create

• create(
      parameters: AcsUsersCreateParameters,
      options?: AcsUsersCreateOptions,
  ): AcsUsersCreateRequest

  Creates a new access system user.

  Parameters

  • parameters: AcsUsersCreateParameters
  • options: AcsUsersCreateOptions = {}

  Returns AcsUsersCreateRequest

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: AcsUsersDeleteParameters,
      options?: AcsUsersDeleteOptions,
  ): AcsUsersDeleteRequest

  Deletes a specified access system user and invalidates the access system user's credentials.

  Parameters

  • parameters: AcsUsersDeleteParameters
  • options: AcsUsersDeleteOptions = {}

  Returns AcsUsersDeleteRequest

get

• get(
      parameters: AcsUsersGetParameters,
      options?: AcsUsersGetOptions,
  ): AcsUsersGetRequest

  Returns a specified access system user.

  Parameters

  • parameters: AcsUsersGetParameters
  • options: AcsUsersGetOptions = {}

  Returns AcsUsersGetRequest

list

• list(
      parameters?: AcsUsersListParameters,
      options?: AcsUsersListOptions,
  ): AcsUsersListRequest

  Returns a list of all access system users.

  Parameters

  • Optionalparameters: AcsUsersListParameters
  • options: AcsUsersListOptions = {}

  Returns AcsUsersListRequest

listAccessibleEntrances

• listAccessibleEntrances(
      parameters: AcsUsersListAccessibleEntrancesParameters,
      options?: AcsUsersListAccessibleEntrancesOptions,
  ): AcsUsersListAccessibleEntrancesRequest

  Lists the entrances to which a specified access system user has access.

  Parameters

  • parameters: AcsUsersListAccessibleEntrancesParameters
  • options: AcsUsersListAccessibleEntrancesOptions = {}

  Returns AcsUsersListAccessibleEntrancesRequest

removeFromAccessGroup

• removeFromAccessGroup(
      parameters: AcsUsersRemoveFromAccessGroupParameters,
      options?: AcsUsersRemoveFromAccessGroupOptions,
  ): AcsUsersRemoveFromAccessGroupRequest

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

  Parameters

  • parameters: AcsUsersRemoveFromAccessGroupParameters
  • options: AcsUsersRemoveFromAccessGroupOptions = {}

  Returns AcsUsersRemoveFromAccessGroupRequest

revokeAccessToAllEntrances

• revokeAccessToAllEntrances(
      parameters: AcsUsersRevokeAccessToAllEntrancesParameters,
      options?: AcsUsersRevokeAccessToAllEntrancesOptions,
  ): AcsUsersRevokeAccessToAllEntrancesRequest

  Revokes access to all entrances for a specified access system user.

  Parameters

  • parameters: AcsUsersRevokeAccessToAllEntrancesParameters
  • options: AcsUsersRevokeAccessToAllEntrancesOptions = {}

  Returns AcsUsersRevokeAccessToAllEntrancesRequest

suspend

• suspend(
      parameters: AcsUsersSuspendParameters,
      options?: AcsUsersSuspendOptions,
  ): AcsUsersSuspendRequest

  Suspends a specified access system user. Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can unsuspend them.

  Parameters

  • parameters: AcsUsersSuspendParameters
  • options: AcsUsersSuspendOptions = {}

  Returns AcsUsersSuspendRequest

unsuspend

• unsuspend(
      parameters: AcsUsersUnsuspendParameters,
      options?: AcsUsersUnsuspendOptions,
  ): AcsUsersUnsuspendRequest

  Unsuspends a specified suspended access system user. While suspending an access system user revokes their access temporarily, unsuspending the access system user restores their access.

  Parameters

  • parameters: AcsUsersUnsuspendParameters
  • options: AcsUsersUnsuspendOptions = {}

  Returns AcsUsersUnsuspendRequest

update

• update(
      parameters: AcsUsersUpdateParameters,
      options?: AcsUsersUpdateOptions,
  ): AcsUsersUpdateRequest

  Updates the properties of a specified access system user.

  Parameters

  • parameters: AcsUsersUpdateParameters
  • options: AcsUsersUpdateOptions = {}

  Returns AcsUsersUpdateRequest

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">,
  ): SeamHttpAcsUsers

  Creates a new SeamHttpAcsUsers authenticated with an API key.

  Parameters

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

  Returns SeamHttpAcsUsers

StaticfromClient

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

  Creates a new SeamHttpAcsUsers from an existing HTTP client.

  Parameters

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

  Returns SeamHttpAcsUsers

StaticfromClientSessionToken

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

  Creates a new SeamHttpAcsUsers authenticated with a client session token.

  Parameters

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

  Returns SeamHttpAcsUsers

StaticfromConsoleSessionToken

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

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

  Parameters

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

  Returns SeamHttpAcsUsers

StaticfromPersonalAccessToken

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

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

  Parameters

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

  Returns SeamHttpAcsUsers

StaticfromPublishableKey

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

  Creates a new SeamHttpAcsUsers 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<SeamHttpAcsUsers>