Class SeamHttpAccessGrantsUnmanaged

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAccessGrantsUnmanaged

client

Readonlydefaults

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Creates a new SeamPaginator to iterate over the paginated results of the request.

  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>

  Updates the client session token used by this client for authentication.

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

  Throws

  If this client was not created with a client session token.

StaticfromApiKey

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

  Creates a new SeamHttpAccessGrantsUnmanaged authenticated with an API key.

  Parameters

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

  Returns SeamHttpAccessGrantsUnmanaged

StaticfromClient

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

  Creates a new SeamHttpAccessGrantsUnmanaged from an existing HTTP client.

  Parameters

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

  Returns SeamHttpAccessGrantsUnmanaged

StaticfromClientSessionToken

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

  Creates a new SeamHttpAccessGrantsUnmanaged authenticated with a client session token.

  Parameters

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

  Returns SeamHttpAccessGrantsUnmanaged

StaticfromConsoleSessionToken

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

  Creates a new SeamHttpAccessGrantsUnmanaged authenticated with a console session token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpAccessGrantsUnmanaged

StaticfromPersonalAccessToken

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

  Creates a new SeamHttpAccessGrantsUnmanaged authenticated with a personal access token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpAccessGrantsUnmanaged

StaticfromPublishableKey

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

  Creates a new SeamHttpAccessGrantsUnmanaged authenticated with a client session token for the user identified by the user identifier key. The client session is created with the publishable key if it does not exist.

  Parameters

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

  Returns Promise<SeamHttpAccessGrantsUnmanaged>