Embeds

(embeds)

Overview

REST APIs for managing embeds

Available Operations

• getEmbedAccessToken - Get an embed access token for the current workspace.
• getValidEmbedAccessTokens - Get all valid embed access tokens for the current workspace.
• revokeEmbedAccessToken - Revoke an embed access EmbedToken.

getEmbedAccessToken

Returns an embed access token for the current workspace. This can be used to authenticate access to externally embedded content. Filters can be applied allowing views to be filtered to things like particular customerIds.

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
import { GetEmbedAccessTokenResponse } from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/operations";

const sdk = new Speakeasy({
  security: {
    apiKey: "",
  },
});

sdk.embeds.getEmbedAccessToken({
  description: "Versatile asynchronous leverage",
  duration: 554373,
  filters: {
    filters: [
      {
        key: "<key>",
        operator: "Account",
        value: "unless to frame",
      },
    ],
    limit: 792058,
    offset: 425010,
    operator: "kilogram innovative Virginia",
  },
}).then((res: GetEmbedAccessTokenResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter	Type	Required	Description
request	operations.GetEmbedAccessTokenRequest	✔️	The request object to use for the request.
config	AxiosRequestConfig	➖	Available config options for making requests.

Response

Promise<operations.GetEmbedAccessTokenResponse>

getValidEmbedAccessTokens

Get all valid embed access tokens for the current workspace.

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
import { GetValidEmbedAccessTokensResponse } from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/operations";

const sdk = new Speakeasy({
  security: {
    apiKey: "",
  },
});

sdk.embeds.getValidEmbedAccessTokens().then((res: GetValidEmbedAccessTokensResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter	Type	Required	Description
config	AxiosRequestConfig	➖	Available config options for making requests.

Response

Promise<operations.GetValidEmbedAccessTokensResponse>

revokeEmbedAccessToken

Revoke an embed access EmbedToken.

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
import { RevokeEmbedAccessTokenResponse } from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/operations";

const sdk = new Speakeasy({
  security: {
    apiKey: "",
  },
});

sdk.embeds.revokeEmbedAccessToken({
  tokenID: "Small",
}).then((res: RevokeEmbedAccessTokenResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter	Type	Required	Description
request	operations.RevokeEmbedAccessTokenRequest	✔️	The request object to use for the request.
config	AxiosRequestConfig	➖	Available config options for making requests.

Response

Promise<operations.RevokeEmbedAccessTokenResponse>