Class SeamHttpUserIdentitiesUnmanaged

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpUserIdentitiesUnmanaged

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?: { user_identity_id: string },
      options?: UserIdentitiesUnmanagedGetOptions,
  ): UserIdentitiesUnmanagedGetRequest

  Parameters

  • Optionalparameters: { user_identity_id: string }

    • user_identity_id: string

      ID of the unmanaged user identity that you want to get.
  • options: UserIdentitiesUnmanagedGetOptions = {}

  Returns UserIdentitiesUnmanagedGetRequest

list

• list(
      parameters?: {
          created_before?: Date;
          limit?: number;
          page_cursor?: null | string;
          search?: string;
      },
      options?: UserIdentitiesUnmanagedListOptions,
  ): UserIdentitiesUnmanagedListRequest

  Parameters

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

    • Optionalcreated_before?: Date

      Timestamp by which to limit returned unmanaged user identities. Returns user identities 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 unmanaged user identities to include all records that satisfy a partial match using full_name, phone_number, email_address, user_identity_id or acs_system_id.
  • options: UserIdentitiesUnmanagedListOptions = {}

  Returns UserIdentitiesUnmanagedListRequest

update

• update(
      parameters?: {
          is_managed: true;
          user_identity_id: string;
          user_identity_key?: string;
      },
      options?: UserIdentitiesUnmanagedUpdateOptions,
  ): UserIdentitiesUnmanagedUpdateRequest

  Parameters

  • Optionalparameters: { is_managed: true; user_identity_id: string; user_identity_key?: string }

    • is_managed: true

      Must be set to true to convert the unmanaged user identity to managed.

    • user_identity_id: string

      ID of the unmanaged user identity that you want to update.

    • Optionaluser_identity_key?: string

      Unique key for the user identity. If not provided, the existing key will be preserved.
  • options: UserIdentitiesUnmanagedUpdateOptions = {}

  Returns UserIdentitiesUnmanagedUpdateRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpUserIdentitiesUnmanaged

StaticfromClient

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

  Parameters

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

  Returns SeamHttpUserIdentitiesUnmanaged

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpUserIdentitiesUnmanaged

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpUserIdentitiesUnmanaged

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpUserIdentitiesUnmanaged

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpUserIdentitiesUnmanaged>