README.md

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

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;
using System.Collections.Generic;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

GetEmbedAccessTokenRequest req = new GetEmbedAccessTokenRequest() {};

var res = await sdk.Embeds.GetEmbedAccessTokenAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
request	GetEmbedAccessTokenRequest	✔️	The request object to use for the request.

Response

GetEmbedAccessTokenResponse

Errors

Error Object	Status Code	Content Type
SpeakeasySDK.Models.Errors.SDKException	4xx-5xx	/

GetValidEmbedAccessTokens

Get all valid embed access tokens for the current workspace.

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

var res = await sdk.Embeds.GetValidEmbedAccessTokensAsync();

// handle response

Response

GetValidEmbedAccessTokensResponse

Errors

Error Object	Status Code	Content Type
SpeakeasySDK.Models.Errors.SDKException	4xx-5xx	/

RevokeEmbedAccessToken

Revoke an embed access EmbedToken.

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

RevokeEmbedAccessTokenRequest req = new RevokeEmbedAccessTokenRequest() {
    TokenID = "<value>",
};

var res = await sdk.Embeds.RevokeEmbedAccessTokenAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
request	RevokeEmbedAccessTokenRequest	✔️	The request object to use for the request.

Response

RevokeEmbedAccessTokenResponse

Errors

Error Object	Status Code	Content Type
SpeakeasySDK.Models.Errors.SDKException	4xx-5xx	/