Class SeamHttpAcsUsers

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsUsers

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

unmanaged

• get unmanaged(): SeamHttpAcsUsersUnmanaged

  Returns SeamHttpAcsUsersUnmanaged

addToAccessGroup

• addToAccessGroup(
      parameters?: { acs_access_group_id: string; acs_user_id: string },
      options?: AcsUsersAddToAccessGroupOptions,
  ): AcsUsersAddToAccessGroupRequest

  Parameters

  • Optionalparameters: { acs_access_group_id: string; acs_user_id: string }

    • acs_access_group_id: string

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

    • acs_user_id: string

      ID of the access system user that you want to add to an access group.
  • options: AcsUsersAddToAccessGroupOptions = {}

  Returns AcsUsersAddToAccessGroupRequest

create

• create(
      parameters?: {
          access_schedule?: { ends_at?: null | string; starts_at?: string };
          acs_access_group_ids?: string[];
          acs_system_id: string;
          email?: string;
          email_address?: string;
          full_name: string;
          phone_number?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersCreateOptions,
  ): AcsUsersCreateRequest

  Parameters

  • Optionalparameters: {
        access_schedule?: { ends_at?: null | string; starts_at?: string };
        acs_access_group_ids?: string[];
        acs_system_id: string;
        email?: string;
        email_address?: string;
        full_name: string;
        phone_number?: string;
        user_identity_id?: string;
    }

    • Optionalaccess_schedule?: { ends_at?: null | string; starts_at?: string }

      starts_at and ends_at timestamps for the new access system user's access. If you specify an access_schedule, you may include both starts_at and ends_at. If you omit starts_at, it defaults to the current time. ends_at is optional and must be a time in the future and after starts_at.

      • Optionalends_at?: null | string

        Ending timestamp for the new access system user's access.

      • Optionalstarts_at?: string

        Starting timestamp for the new access system user's access.

    • Optionalacs_access_group_ids?: string[]

      Array of access group IDs to indicate the access groups to which you want to add the new access system user.

    • acs_system_id: string

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

    • Optionalemail?: string

      Deprecated

      use email_address.

    • Optionalemail_address?: string

      Email address of the access system user.

    • full_name: string

      Full name of the new access system user.

    • Optionalphone_number?: string

      Phone number of the access system user in E.164 format (for example, +15555550100).

    • Optionaluser_identity_id?: string

      ID of the user identity with which you want to associate the new access system user.
  • options: AcsUsersCreateOptions = {}

  Returns AcsUsersCreateRequest

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_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersDeleteOptions,
  ): AcsUsersDeleteRequest

  Parameters

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

    • Optionalacs_system_id?: string

      ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id.

    • Optionalacs_user_id?: string

      ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id

    • Optionaluser_identity_id?: string

      ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.
  • options: AcsUsersDeleteOptions = {}

  Returns AcsUsersDeleteRequest

get

• get(
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersGetOptions,
  ): AcsUsersGetRequest

  Parameters

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

    • Optionalacs_system_id?: string

      ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id.

    • Optionalacs_user_id?: string

      ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id.

    • Optionaluser_identity_id?: string

      ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.
  • options: AcsUsersGetOptions = {}

  Returns AcsUsersGetRequest

list

• list(
      parameters?: {
          acs_system_id?: string;
          created_before?: Date;
          limit?: number;
          page_cursor?: null | string;
          search?: string;
          user_identity_email_address?: string;
          user_identity_id?: string;
          user_identity_phone_number?: string;
      },
      options?: AcsUsersListOptions,
  ): AcsUsersListRequest

  Parameters

  • Optionalparameters: {
        acs_system_id?: string;
        created_before?: Date;
        limit?: number;
        page_cursor?: null | string;
        search?: string;
        user_identity_email_address?: string;
        user_identity_id?: string;
        user_identity_phone_number?: string;
    }

    • Optionalacs_system_id?: string

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

    • Optionalcreated_before?: Date

      Timestamp by which to limit returned access system users. Returns users created before this timestamp.

    • Optionallimit?: number

      Maximum number of records to return per page.

    • Optionalpage_cursor?: null | string

      Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

    • Optionalsearch?: string

      String for which to search. Filters returned access system users to include all records that satisfy a partial match using full_name, phone_number, email_address, acs_user_id, user_identity_id, user_identity_full_name or user_identity_phone_number.

    • Optionaluser_identity_email_address?: string

      Email address of the user identity for which you want to retrieve all access system users.

    • Optionaluser_identity_id?: string

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

    • Optionaluser_identity_phone_number?: string

      Phone number of the user identity for which you want to retrieve all access system users, in E.164 format (for example, +15555550100).
  • options: AcsUsersListOptions = {}

  Returns AcsUsersListRequest

listAccessibleEntrances

• listAccessibleEntrances(
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersListAccessibleEntrancesOptions,
  ): AcsUsersListAccessibleEntrancesRequest

  Parameters

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

    • Optionalacs_system_id?: string

      ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id.

    • Optionalacs_user_id?: string

      ID of the access system user for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.

    • Optionaluser_identity_id?: string

      ID of the user identity for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.
  • options: AcsUsersListAccessibleEntrancesOptions = {}

  Returns AcsUsersListAccessibleEntrancesRequest

removeFromAccessGroup

• removeFromAccessGroup(
      parameters?: {
          acs_access_group_id: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersRemoveFromAccessGroupOptions,
  ): AcsUsersRemoveFromAccessGroupRequest

  Parameters

  • Optionalparameters: { 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. You can only provide acs_user_id or user_identity_id.

    • Optionaluser_identity_id?: string

      ID of the user identity that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.
  • options: AcsUsersRemoveFromAccessGroupOptions = {}

  Returns AcsUsersRemoveFromAccessGroupRequest

revokeAccessToAllEntrances

• revokeAccessToAllEntrances(
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersRevokeAccessToAllEntrancesOptions,
  ): AcsUsersRevokeAccessToAllEntrancesRequest

  Parameters

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

    • Optionalacs_system_id?: string

      ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id.

    • Optionalacs_user_id?: string

      ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.

    • Optionaluser_identity_id?: string

      ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.
  • options: AcsUsersRevokeAccessToAllEntrancesOptions = {}

  Returns AcsUsersRevokeAccessToAllEntrancesRequest

suspend

• suspend(
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersSuspendOptions,
  ): AcsUsersSuspendRequest

  Parameters

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

    • Optionalacs_system_id?: string

      ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.

    • Optionalacs_user_id?: string

      ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.

    • Optionaluser_identity_id?: string

      ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
  • options: AcsUsersSuspendOptions = {}

  Returns AcsUsersSuspendRequest

unsuspend

• unsuspend(
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersUnsuspendOptions,
  ): AcsUsersUnsuspendRequest

  Parameters

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

    • Optionalacs_system_id?: string

      ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id.

    • Optionalacs_user_id?: string

      ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.

    • Optionaluser_identity_id?: string

      ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
  • options: AcsUsersUnsuspendOptions = {}

  Returns AcsUsersUnsuspendRequest

update

• update(
      parameters?: {
          access_schedule?: null | { ends_at: string; starts_at: string };
          acs_system_id?: string;
          acs_user_id?: string;
          email?: string;
          email_address?: string;
          full_name?: string;
          hid_acs_system_id?: string;
          phone_number?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersUpdateOptions,
  ): AcsUsersUpdateRequest

  Parameters

  • Optionalparameters: {
        access_schedule?: null | { ends_at: string; starts_at: string };
        acs_system_id?: string;
        acs_user_id?: string;
        email?: string;
        email_address?: string;
        full_name?: string;
        hid_acs_system_id?: string;
        phone_number?: string;
        user_identity_id?: string;
    }

    • Optionalaccess_schedule?: null | { ends_at: string; starts_at: string }

      starts_at and ends_at timestamps for the access system user's access. If you specify an access_schedule, you may include both starts_at and ends_at. If you omit starts_at, it defaults to the current time. ends_at is optional and must be a time in the future and after starts_at.

    • Optionalacs_system_id?: string

      ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.

    • Optionalacs_user_id?: string

      ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.

    • Optionalemail?: string

      Deprecated

      use email_address.

    • Optionalemail_address?: string

      Email address of the access system user.

    • Optionalfull_name?: string

      Full name of the access system user.

    • Optionalhid_acs_system_id?: string

    • Optionalphone_number?: string

      Phone number of the access system user in E.164 format (for example, +15555550100).

    • Optionaluser_identity_id?: string

      ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.
  • options: AcsUsersUpdateOptions = {}

  Returns AcsUsersUpdateRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpAcsUsers

StaticfromClient

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

  Parameters

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

  Returns SeamHttpAcsUsers

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpAcsUsers

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpAcsUsers

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpAcsUsers

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpAcsUsers>