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: AccessGrantsUnmanagedGetParameters,
      options?: AccessGrantsUnmanagedGetOptions,
  ): AccessGrantsUnmanagedGetRequest

  Get an unmanaged Access Grant (where is_managed = false).

  Parameters

  • parameters: AccessGrantsUnmanagedGetParameters
  • options: AccessGrantsUnmanagedGetOptions = {}

  Returns AccessGrantsUnmanagedGetRequest

list

• list(
      parameters?: AccessGrantsUnmanagedListParameters,
      options?: AccessGrantsUnmanagedListOptions,
  ): AccessGrantsUnmanagedListRequest

  Gets unmanaged Access Grants (where is_managed = false).

  Parameters

  • Optionalparameters: AccessGrantsUnmanagedListParameters
  • options: AccessGrantsUnmanagedListOptions = {}

  Returns AccessGrantsUnmanagedListRequest

update

• update(
      parameters: AccessGrantsUnmanagedUpdateParameters,
      options?: AccessGrantsUnmanagedUpdateOptions,
  ): AccessGrantsUnmanagedUpdateRequest

  Updates an unmanaged Access Grant to make it managed.

  This endpoint can only be used to convert unmanaged access grants to managed ones by setting is_managed to true. It cannot be used to convert managed access grants back to unmanaged.

  When converting an unmanaged access grant to managed, all associated access methods will also be converted to managed.

  Parameters

  • parameters: AccessGrantsUnmanagedUpdateParameters
  • 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>