Class SeamHttpUserIdentitiesEnrollmentAutomations

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpUserIdentitiesEnrollmentAutomations

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>

delete

• delete(
      parameters: { enrollment_automation_id: string },
      options?: UserIdentitiesEnrollmentAutomationsDeleteOptions,
  ): UserIdentitiesEnrollmentAutomationsDeleteRequest

  Parameters

  • parameters: { enrollment_automation_id: string }

    • enrollment_automation_id: string

      ID of the enrollment automation that you want to delete.

  • options: UserIdentitiesEnrollmentAutomationsDeleteOptions = {}

  Returns UserIdentitiesEnrollmentAutomationsDeleteRequest

get

• get(
      parameters: { enrollment_automation_id: string },
      options?: UserIdentitiesEnrollmentAutomationsGetOptions,
  ): UserIdentitiesEnrollmentAutomationsGetRequest

  Parameters

  • parameters: { enrollment_automation_id: string }

    • enrollment_automation_id: string

      ID of the enrollment automation that you want to get.

  • options: UserIdentitiesEnrollmentAutomationsGetOptions = {}

  Returns UserIdentitiesEnrollmentAutomationsGetRequest

launch

• launch(
      parameters: {
          acs_credential_pool_id?: string;
          create_credential_manager_user?: boolean;
          credential_manager_acs_system_id: string;
          credential_manager_acs_user_id?: string;
          user_identity_id: string;
      },
      options?: UserIdentitiesEnrollmentAutomationsLaunchOptions,
  ): UserIdentitiesEnrollmentAutomationsLaunchRequest

  Parameters

  • parameters: {
        acs_credential_pool_id?: string;
        create_credential_manager_user?: boolean;
        credential_manager_acs_system_id: string;
        credential_manager_acs_user_id?: string;
        user_identity_id: string;
    }

    • Optionalacs_credential_pool_id?: string

      ID of the credential pool from which to obtain credentials for the user identity.

    • Optionalcreate_credential_manager_user?: boolean

      Indicates whether to create an associated credential manager user. If you set create_credential_manager_user to true, you cannot specify a credential_manager_acs_user_id.

    • credential_manager_acs_system_id: string

      ID of the desired access system that serves as the credential manager for the enrollment automation.

    • Optionalcredential_manager_acs_user_id?: string

      ID of the associated access system user within the credential manager. If you specify a credential_manager_acs_user_id, you cannot set create_credential_manager_user to true.

    • user_identity_id: string

      ID of the user identity for which you want to launch an enrollment automation.

  • options: UserIdentitiesEnrollmentAutomationsLaunchOptions = {}

  Returns UserIdentitiesEnrollmentAutomationsLaunchRequest

list

• list(
      parameters: { user_identity_id: string },
      options?: UserIdentitiesEnrollmentAutomationsListOptions,
  ): UserIdentitiesEnrollmentAutomationsListRequest

  Parameters

  • parameters: { user_identity_id: string }

    • user_identity_id: string

      ID of the user identity for which you want to retrieve enrollment automations.

  • options: UserIdentitiesEnrollmentAutomationsListOptions = {}

  Returns UserIdentitiesEnrollmentAutomationsListRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpUserIdentitiesEnrollmentAutomations

StaticfromClient

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

  Parameters

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

  Returns SeamHttpUserIdentitiesEnrollmentAutomations

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpUserIdentitiesEnrollmentAutomations

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpUserIdentitiesEnrollmentAutomations

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpUserIdentitiesEnrollmentAutomations

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpUserIdentitiesEnrollmentAutomations>