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

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.operations.GetEmbedAccessTokenRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.GetEmbedAccessTokenResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        GetEmbedAccessTokenRequest req = GetEmbedAccessTokenRequest.builder()
                .build();

        GetEmbedAccessTokenResponse res = sdk.embeds().getEmbedAccessToken()
                .request(req)
                .call();

        if (res.embedAccessTokenResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

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

Response

GetEmbedAccessTokenResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

getValidEmbedAccessTokens

Get all valid embed access tokens for the current workspace.

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.operations.GetValidEmbedAccessTokensResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        GetValidEmbedAccessTokensResponse res = sdk.embeds().getValidEmbedAccessTokens()
                .call();

        if (res.embedTokens().isPresent()) {
            // handle response
        }
    }
}

Response

GetValidEmbedAccessTokensResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

revokeEmbedAccessToken

Revoke an embed access EmbedToken.

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.operations.RevokeEmbedAccessTokenRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.RevokeEmbedAccessTokenResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        RevokeEmbedAccessTokenRequest req = RevokeEmbedAccessTokenRequest.builder()
                .tokenID("<id>")
                .build();

        RevokeEmbedAccessTokenResponse res = sdk.embeds().revokeEmbedAccessToken()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

RevokeEmbedAccessTokenResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*