Skip to content

RegisterOpentdfConfigRequest

Source code in docs_src/capo_wickr/types/register_opentdf_config_request.py
class RegisterOpentdfConfigRequest(TypedDict, closed=True):
    network_id: "capo_wickr.types.network_id.NetworkId"
    """<p>The ID of the Wickr network for which OpenTDF integration will be configured.</p>"""
    client_id: "capo_wickr.types.generic_string.GenericString"
    """<p>The OIDC client ID used for authenticating with the OpenTDF provider.</p>"""
    client_secret: "capo_wickr.types.sensitive_string.SensitiveString"
    """<p>The OIDC client secret used for authenticating with the OpenTDF provider</p>"""
    domain: "capo_wickr.types.generic_string.GenericString"
    """<p>The domain of the OpenTDF server.</p>"""
    provider: "capo_wickr.types.generic_string.GenericString"
    """<p>The provider of the OpenTDF platform.</p> <note> <p>Currently only Virtru is supported as the OpenTDF provider.</p> </note>"""
    dry_run: NotRequired["bool"]
    """<p>Perform dry-run test connection of OpenTDF configuration (optional).</p>"""

client_id instance-attribute

client_id: GenericString

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

client_secret instance-attribute

client_secret: SensitiveString

The OIDC client secret used for authenticating with the OpenTDF provider

domain instance-attribute

domain: GenericString

The domain of the OpenTDF server.

dry_run instance-attribute

dry_run: NotRequired[bool]

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

network_id instance-attribute

network_id: NetworkId

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

provider instance-attribute

provider: GenericString

The provider of the OpenTDF platform.

Currently only Virtru is supported as the OpenTDF provider.