@opentdf/sdk
    Preparing search index...

    Class PlatformClient

    A client for interacting with the Platform using the Connect RPC framework.

    This client provides access to various services offered by the Platform, such as authorization, entity resolution, key access, policy management, and more. It uses the Connect RPC framework to communicate with the platform's API endpoints.

    This client supports authentication via an AuthProvider or custom interceptors, which can be used to add authentication headers or other custom logic to outgoing requests.

    import { AuthProviders, OpenTDF } from '@opentdf/sdk';
    import { PlatformClient } from '@opentdf/sdk/platform';

    const authProvider: AuthProvider = await AuthProviders.refreshAuthProvider({...});
    const platform = new PlatformClient({
      authProvider,
      platformUrl: 'https://platform.example.com',
    });

    const wellKnownResponse = await platform.v1.wellknown.getWellKnownConfiguration({});
    console.log('Well-known configuration:', wellKnownResponse.configuration);
    Index

    Constructors

    constructor

    Properties

    v1

    Constructors

    Properties

    v1: PlatformServices

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties