Class SeamHttpAcsUsersUnmanaged

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsUsersUnmanaged

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

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>

get

• get(
      parameters?: { acs_user_id: string },
      options?: AcsUsersUnmanagedGetOptions,
  ): AcsUsersUnmanagedGetRequest

  Parameters

  • Optionalparameters: { acs_user_id: string }

    • acs_user_id: string

      ID of the unmanaged access system user that you want to get.

  • options: AcsUsersUnmanagedGetOptions = {}

  Returns AcsUsersUnmanagedGetRequest

list

• list(
      parameters?: {
          acs_system_id?: string;
          limit?: number;
          search?: string;
          user_identity_email_address?: string;
          user_identity_id?: string;
          user_identity_phone_number?: string;
      },
      options?: AcsUsersUnmanagedListOptions,
  ): AcsUsersUnmanagedListRequest

  Parameters

  • Optionalparameters: {
        acs_system_id?: string;
        limit?: number;
        search?: string;
        user_identity_email_address?: string;
        user_identity_id?: string;
        user_identity_phone_number?: string;
    }

    • Optionalacs_system_id?: string

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

    • Optionallimit?: number

      Number of unmanaged access system users to return.

    • 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 unmanaged access system users.

    • Optionaluser_identity_id?: string

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

    • Optionaluser_identity_phone_number?: string

      Phone number of the user identity for which you want to retrieve all unmanaged access system users.

  • options: AcsUsersUnmanagedListOptions = {}

  Returns AcsUsersUnmanagedListRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpAcsUsersUnmanaged

StaticfromClient

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

  Parameters

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

  Returns SeamHttpAcsUsersUnmanaged

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpAcsUsersUnmanaged

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpAcsUsersUnmanaged

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpAcsUsersUnmanaged

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpAcsUsersUnmanaged>