WickrAdminAPI / Client / get_network

get_network

WickrAdminAPI.Client.get_network(**kwargs)

Retrieves detailed information about a specific Wickr network, including its configuration, access level, and status.

See also: AWS API Documentation

Request Syntax

response = client.get_network(
    networkId='string'
)
Parameters:

networkId (string) –

[REQUIRED]

The ID of the Wickr network to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'networkId': 'string',
    'networkName': 'string',
    'accessLevel': 'STANDARD'|'PREMIUM',
    'awsAccountId': 'string',
    'networkArn': 'string',
    'standing': 123,
    'freeTrialExpiration': 'string',
    'migrationState': 123,
    'encryptionKeyArn': 'string'
}

Response Structure

  • (dict) –

    • networkId (string) –

      The unique identifier of the network.

    • networkName (string) –

      The name of the network.

    • accessLevel (string) –

      The access level of the network (STANDARD or PREMIUM), which determines available features and capabilities.

    • awsAccountId (string) –

      The Amazon Web Services account ID that owns the network.

    • networkArn (string) –

      The Amazon Resource Name (ARN) of the network.

    • standing (integer) –

      The current standing or status of the network.

    • freeTrialExpiration (string) –

      The expiration date and time for the network’s free trial period, if applicable.

    • migrationState (integer) –

      The SSO redirect URI migration state, managed by the SSO redirect migration wizard. Values: 0 (not started), 1 (in progress), or 2 (completed).

    • encryptionKeyArn (string) –

      The ARN of the Amazon Web Services KMS customer managed key used for encrypting sensitive data in the network.

Exceptions