WickrAdminAPI / Client / register_opentdf_config

register_opentdf_config

WickrAdminAPI.Client.register_opentdf_config(**kwargs)

Registers and saves OpenTDF configuration for a Wickr network, enabling attribute-based access control for Wickr through an OpenTDF provider.

See also: AWS API Documentation

Request Syntax

response = client.register_opentdf_config(
    networkId='string',
    clientId='string',
    clientSecret='string',
    domain='string',
    provider='string',
    dryRun=True|False
)
Parameters:

  • networkId (string) –

    [REQUIRED]

    The ID of the Wickr network for which OpenTDF integration will be configured.

  • clientId (string) –

    [REQUIRED]

    The OIDC client ID used for authenticating with the OpenTDF provider.

  • clientSecret (string) –

    [REQUIRED]

    The OIDC client secret used for authenticating with the OpenTDF provider

  • domain (string) –

    [REQUIRED]

    The domain of the OpenTDF server.

  • provider (string) –

    [REQUIRED]

    The provider of the OpenTDF platform.

    Note

    Currently only Virtru is supported as the OpenTDF provider.

  • dryRun (boolean) – Perform dry-run test connection of OpenTDF configuration (optional).

Return type:

dict

Returns:

Response Syntax

{
    'clientId': 'string',
    'domain': 'string',
    'clientSecret': 'string',
    'provider': 'string'
}

Response Structure

  • (dict) –

    • clientId (string) –

      The OIDC client ID used for authenticating with the OpenTDF provider.

    • domain (string) –

      The domain of the OpenTDF server.

    • clientSecret (string) –

      The OIDC client secret used for authenticating with the OpenTDF provider.

    • provider (string) –

      The provider of the OpenTDF platform.

Exceptions