AWS Wickr Admin API

Retrieves the OpenTDF integration configuration for a Wickr network.

See also: AWS API Documentation

Request Syntax

client.get_opentdf_config(
    networkId='string'
)

type networkId:

string

param networkId:

[REQUIRED]

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

rtype:

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.

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

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

type networkId:

string

param networkId:

[REQUIRED]

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

type clientId:

string

param clientId:

[REQUIRED]

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

type clientSecret:

string

param clientSecret:

[REQUIRED]

The OIDC client secret used for authenticating with the OpenTDF provider

type domain:

string

param domain:

[REQUIRED]

The domain of the OpenTDF server.

type provider:

string

param provider:

[REQUIRED]

The provider of the OpenTDF platform.

type dryRun:

boolean

param dryRun:

Perform dry-run test connection of OpenTDF configuration (optional).

rtype:

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.

{'settings': {'enableTrustedDataFormat': 'boolean'}}

Updates network-level settings for a Wickr network. You can modify settings such as client metrics, data retention, and other network-wide options.

See also: AWS API Documentation

Request Syntax

client.update_network_settings(
    networkId='string',
    settings={
        'enableClientMetrics': True|False,
        'readReceiptConfig': {
            'status': 'DISABLED'|'ENABLED'|'FORCE_ENABLED'
        },
        'dataRetention': True|False,
        'enableTrustedDataFormat': True|False
    }
)

type networkId:

string

param networkId:

[REQUIRED]

The ID of the Wickr network whose settings will be updated.

type settings:

dict

param settings:

[REQUIRED]

A map of setting names to their new values. Each setting should be provided with its appropriate type (boolean, string, number, etc.).

• enableClientMetrics (boolean) --

  Allows Wickr clients to send anonymized performance and usage metrics to the Wickr backend server for service improvement and troubleshooting.

• readReceiptConfig (dict) --

  Configuration for read receipts at the network level, controlling the default behavior for whether senders can see when their messages have been read.

  • status (string) --

    The read receipt status mode for the network.

• dataRetention (boolean) --

  Indicates whether the data retention feature is enabled for the network. When true, messages are captured by the data retention bot for compliance and archiving purposes.

• enableTrustedDataFormat (boolean) --

  Configuration for OpenTDF integration at the network level, enforcing ABAC decision making when operating in TDF enabled rooms.

rtype:

dict

returns:

Response Syntax

{
    'settings': [
        {
            'optionName': 'string',
            'value': 'string',
            'type': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • settings (list) --

    A list of the updated network settings, showing the new values for each modified setting.

    • (dict) --

      Represents a single network-level configuration setting with its name, value, and data type. Settings control network-wide behaviors and features.

      • optionName (string) --

        The name of the network setting (e.g., 'enableClientMetrics', 'dataRetention').

      • value (string) --

        The current value of the setting as a string. Boolean values are represented as 'true' or 'false'.

      • type (string) --

        The data type of the setting value (e.g., 'boolean', 'string', 'number').