Class SeamHttpAccessGrantsUnmanaged

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAccessGrantsUnmanaged

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?: { access_grant_id: string },
      options?: AccessGrantsUnmanagedGetOptions,
  ): AccessGrantsUnmanagedGetRequest

  Parameters

  • Optionalparameters: { access_grant_id: string }

    • access_grant_id: string

      ID of unmanaged Access Grant to get.
  • options: AccessGrantsUnmanagedGetOptions = {}

  Returns AccessGrantsUnmanagedGetRequest

list

• list(
      parameters?: {
          acs_entrance_id?: string;
          acs_system_id?: string;
          reservation_key?: string;
          user_identity_id?: string;
      },
      options?: AccessGrantsUnmanagedListOptions,
  ): AccessGrantsUnmanagedListRequest

  Parameters

  • Optionalparameters: {
        acs_entrance_id?: string;
        acs_system_id?: string;
        reservation_key?: string;
        user_identity_id?: string;
    }

    • Optionalacs_entrance_id?: string

      ID of the entrance by which you want to filter the list of unmanaged Access Grants.

    • Optionalacs_system_id?: string

      ID of the access system by which you want to filter the list of unmanaged Access Grants.

    • Optionalreservation_key?: string

      Filter unmanaged Access Grants by reservation_key.

    • Optionaluser_identity_id?: string

      ID of user identity by which you want to filter the list of unmanaged Access Grants.
  • options: AccessGrantsUnmanagedListOptions = {}

  Returns AccessGrantsUnmanagedListRequest

update

• update(
      parameters?: {
          access_grant_id: string;
          access_grant_key?: string;
          is_managed: true;
      },
      options?: AccessGrantsUnmanagedUpdateOptions,
  ): AccessGrantsUnmanagedUpdateRequest

  Parameters

  • Optionalparameters: { access_grant_id: string; access_grant_key?: string; is_managed: true }

    • access_grant_id: string

      ID of the unmanaged Access Grant to update.

    • Optionalaccess_grant_key?: string

      Unique key for the access grant. If not provided, the existing key will be preserved.

    • is_managed: true

      Must be set to true to convert the unmanaged access grant to managed.
  • options: AccessGrantsUnmanagedUpdateOptions = {}

  Returns AccessGrantsUnmanagedUpdateRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpAccessGrantsUnmanaged

StaticfromClient

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

  Parameters

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

  Returns SeamHttpAccessGrantsUnmanaged

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpAccessGrantsUnmanaged

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpAccessGrantsUnmanaged

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpAccessGrantsUnmanaged

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpAccessGrantsUnmanaged>