Class SeamHttpAcsUsersUnmanaged

constructor

• new SeamHttpAcsUsersUnmanaged(apiKeyOrOptions?): SeamHttpAcsUsersUnmanaged

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsUsersUnmanaged

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

createPaginator

• createPaginator<const TResponse, const TResponseKey>(request): 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?, options?): 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?, options?): AcsUsersUnmanagedListRequest

• Parameters

  • Optionalparameters: {
        acs_system_id?: string;
        limit?: number;
        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.

    • 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): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpAcsUsersUnmanaged

• Parameters

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

  Returns SeamHttpAcsUsersUnmanaged

StaticfromClient

• fromClient(client, options?): SeamHttpAcsUsersUnmanaged

• Parameters

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

  Returns SeamHttpAcsUsersUnmanaged

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpAcsUsersUnmanaged

• Parameters

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

  Returns SeamHttpAcsUsersUnmanaged

StaticfromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpAcsUsersUnmanaged

• Parameters

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

  Returns SeamHttpAcsUsersUnmanaged

StaticfromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpAcsUsersUnmanaged

• Parameters

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

  Returns SeamHttpAcsUsersUnmanaged

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpAcsUsersUnmanaged>