BatchCreateUser

$result = $client->batchCreateUser([/* ... */]);
$promise = $client->batchCreateUserAsync([/* ... */]);

Creates multiple users in a specified Wickr network. This operation allows you to provision multiple user accounts simultaneously, optionally specifying security groups, and validation requirements for each user.

Parameter Syntax

$result = $client->batchCreateUser([
    'clientToken' => '<string>',
    'networkId' => '<string>', // REQUIRED
    'users' => [ // REQUIRED
        [
            'codeValidation' => true || false,
            'firstName' => '<string>',
            'inviteCode' => '<string>',
            'inviteCodeTtl' => <integer>,
            'lastName' => '<string>',
            'securityGroupIds' => ['<string>', ...], // REQUIRED
            'username' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'failed' => [
        [
            'field' => '<string>',
            'reason' => '<string>',
            'userId' => '<string>',
        ],
        // ...
    ],
    'message' => '<string>',
    'successful' => [
        [
            'cell' => '<string>',
            'challengeFailures' => <integer>,
            'codeValidation' => true || false,
            'countryCode' => '<string>',
            'firstName' => '<string>',
            'inviteCode' => '<string>',
            'isAdmin' => true || false,
            'isInviteExpired' => true || false,
            'isUser' => true || false,
            'lastName' => '<string>',
            'otpEnabled' => true || false,
            'scimId' => '<string>',
            'securityGroups' => ['<string>', ...],
            'status' => <integer>,
            'suspended' => true || false,
            'type' => '<string>',
            'uname' => '<string>',
            'userId' => '<string>',
            'username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Create multiple users

$result = $client->batchCreateUser([
    'clientToken' => '550e8400-e29b-41d4-a716-446655440000',
    'networkId' => '12345678',
    'users' => [
        [
            'codeValidation' => 1,
            'firstName' => 'John',
            'inviteCode' => 'INVITE123',
            'inviteCodeTtl' => 7,
            'lastName' => 'Doe',
            'securityGroupIds' => [
                'BCTY8Qhe',
            ],
            'username' => 'john.doe@example.com',
        ],
        [
            'firstName' => 'Jane',
            'lastName' => 'Smith',
            'securityGroupIds' => [
                'BCTY8Qhe',
            ],
            'username' => 'jane.smith@example.com',
        ],
    ],
]);

Result syntax:

[
    'failed' => [
    ],
    'successful' => [
        [
            'codeValidation' => 1,
            'firstName' => 'John',
            'inviteCode' => 'INVITE123',
            'isInviteExpired' => ,
            'lastName' => 'Doe',
            'status' => 1,
            'userId' => '123',
            'username' => 'john.doe@example.com',
        ],
        [
            'codeValidation' => ,
            'firstName' => 'Jane',
            'inviteCode' => 'AUTOGEN456',
            'isInviteExpired' => ,
            'lastName' => 'Smith',
            'status' => 1,
            'userId' => '456',
            'username' => 'jane.smith@example.com',
        ],
    ],
]

Example 2: Partial failure - duplicate user

$result = $client->batchCreateUser([
    'networkId' => '12345678',
    'users' => [
        [
            'firstName' => 'Alice',
            'lastName' => 'Johnson',
            'securityGroupIds' => [
                'BCTY8Qhe',
            ],
            'username' => 'alice.johnson@example.com',
        ],
        [
            'firstName' => 'Bob',
            'lastName' => 'Wilson',
            'securityGroupIds' => [
                'BCTY8Qhe',
            ],
            'username' => 'existing.user@example.com',
        ],
    ],
]);

Result syntax:

[
    'failed' => [
        [
            'field' => 'username',
            'reason' => 'User already exists',
            'userId' => '0',
        ],
    ],
    'successful' => [
        [
            'codeValidation' => ,
            'firstName' => 'Alice',
            'inviteCode' => 'AUTOGEN789',
            'isInviteExpired' => ,
            'lastName' => 'Johnson',
            'status' => 1,
            'userId' => '678',
            'username' => 'alice.johnson@example.com',
        ],
    ],
]

BatchDeleteUser

$result = $client->batchDeleteUser([/* ... */]);
$promise = $client->batchDeleteUserAsync([/* ... */]);

Deletes multiple users from a specified Wickr network. This operation permanently removes user accounts and their associated data from the network.

Parameter Syntax

$result = $client->batchDeleteUser([
    'clientToken' => '<string>',
    'networkId' => '<string>', // REQUIRED
    'userIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'failed' => [
        [
            'field' => '<string>',
            'reason' => '<string>',
            'userId' => '<string>',
        ],
        // ...
    ],
    'message' => '<string>',
    'successful' => [
        [
            'userId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Delete multiple users

$result = $client->batchDeleteUser([
    'clientToken' => '6ba7b814-9dad-11d1-80b4-00c04fd430c8',
    'networkId' => '12345678',
    'userIds' => [
        '123',
        '456',
    ],
]);

Result syntax:

[
    'failed' => [
    ],
    'message' => 'success',
    'successful' => [
        [
            'userId' => '123',
        ],
        [
            'userId' => '456',
        ],
    ],
]

Example 2: Partial failure - user not found

$result = $client->batchDeleteUser([
    'networkId' => '12345678',
    'userIds' => [
        '123',
        '456',
    ],
]);

Result syntax:

[
    'failed' => [
        [
            'field' => 'username',
            'reason' => 'User not found',
            'userId' => '456',
        ],
    ],
    'message' => 'partial success',
    'successful' => [
        [
            'userId' => '123',
        ],
    ],
]

BatchLookupUserUname

$result = $client->batchLookupUserUname([/* ... */]);
$promise = $client->batchLookupUserUnameAsync([/* ... */]);

Looks up multiple user usernames from their unique username hashes (unames). This operation allows you to retrieve the email addresses associated with a list of username hashes.

Parameter Syntax

$result = $client->batchLookupUserUname([
    'clientToken' => '<string>',
    'networkId' => '<string>', // REQUIRED
    'unames' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'failed' => [
        [
            'field' => '<string>',
            'reason' => '<string>',
            'uname' => '<string>',
        ],
        // ...
    ],
    'message' => '<string>',
    'successful' => [
        [
            'uname' => '<string>',
            'username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Lookup multiple user unames

$result = $client->batchLookupUserUname([
    'clientToken' => 'f47ac10b-58cc-4372-a567-0e02b2c3d479',
    'networkId' => '12345678',
    'unames' => [
        'a1b2c3d4e5f6',
        'g7h8i9j0k1l2',
    ],
]);

Result syntax:

[
    'failed' => [
    ],
    'message' => 'success',
    'successful' => [
        [
            'uname' => 'a1b2c3d4e5f6',
            'username' => 'john.doe@example.com',
        ],
        [
            'uname' => 'g7h8i9j0k1l2',
            'username' => 'john.doe2@example.com',
        ],
    ],
]

Example 2: Partial failure - uname not found

$result = $client->batchLookupUserUname([
    'networkId' => '12345678',
    'unames' => [
        'a1b2c3d4e5f6',
        'invaliduname',
    ],
]);

Result syntax:

[
    'failed' => [
        [
            'field' => 'uname',
            'reason' => 'Uname not found',
            'uname' => 'invaliduname',
        ],
    ],
    'message' => 'partial success',
    'successful' => [
        [
            'uname' => 'a1b2c3d4e5f6',
            'username' => 'john.doe@example.com',
        ],
    ],
]

BatchReinviteUser

$result = $client->batchReinviteUser([/* ... */]);
$promise = $client->batchReinviteUserAsync([/* ... */]);

Resends invitation codes to multiple users who have pending invitations in a Wickr network. This operation is useful when users haven't accepted their initial invitations or when invitations have expired.

Parameter Syntax

$result = $client->batchReinviteUser([
    'clientToken' => '<string>',
    'networkId' => '<string>', // REQUIRED
    'userIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'failed' => [
        [
            'field' => '<string>',
            'reason' => '<string>',
            'userId' => '<string>',
        ],
        // ...
    ],
    'message' => '<string>',
    'successful' => [
        [
            'userId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Batch reinvite users successfully

$result = $client->batchReinviteUser([
    'networkId' => '12345678',
    'userIds' => [
        '12345',
        '67890',
    ],
]);

Result syntax:

[
    'failed' => [
    ],
    'successful' => [
        [
            'userId' => '12345',
        ],
        [
            'userId' => '67890',
        ],
    ],
]

Example 2: Batch reinvite users - partial success

$result = $client->batchReinviteUser([
    'networkId' => '12345678',
    'userIds' => [
        '12345',
        '99999',
    ],
]);

Result syntax:

[
    'failed' => [
        [
            'reason' => 'user not found in current network',
            'userId' => '99999',
        ],
    ],
    'successful' => [
        [
            'userId' => '12345',
        ],
    ],
]

Example 3: Batch reinvite users - cannot reinvite

$result = $client->batchReinviteUser([
    'networkId' => '12345678',
    'userIds' => [
        '54321',
    ],
]);

Result syntax:

[
    'failed' => [
        [
            'reason' => 'user cannot be reinvited',
            'userId' => '54321',
        ],
    ],
    'successful' => [
    ],
]

BatchResetDevicesForUser

$result = $client->batchResetDevicesForUser([/* ... */]);
$promise = $client->batchResetDevicesForUserAsync([/* ... */]);

Resets multiple devices for a specific user in a Wickr network. This operation forces the selected devices to log out and requires users to re-authenticate, which is useful for security purposes or when devices need to be revoked.

Parameter Syntax

$result = $client->batchResetDevicesForUser([
    'appIds' => ['<string>', ...], // REQUIRED
    'clientToken' => '<string>',
    'networkId' => '<string>', // REQUIRED
    'userId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'failed' => [
        [
            'appId' => '<string>',
            'field' => '<string>',
            'reason' => '<string>',
        ],
        // ...
    ],
    'message' => '<string>',
    'successful' => [
        [
            'appId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Successful device reset

$result = $client->batchResetDevicesForUser([
    'appIds' => [
        'd3135a42dcb6437780b16c3ca9581fe64e6822773cd6b965d25fc9929c89aca6',
        'e4246b53edc7548891c27d4da0692fe75f7933884de7c076e36gca030d90bdb7',
    ],
    'networkId' => '12345678',
    'userId' => '12345',
]);

Result syntax:

[
    'failed' => [
    ],
    'message' => 'success',
    'successful' => [
        [
            'appId' => 'd3135a42dcb6437780b16c3ca9581fe64e6822773cd6b965d25fc9929c89aca6',
        ],
        [
            'appId' => 'e4246b53edc7548891c27d4da0692fe75f7933884de7c076e36gca030d90bdb7',
        ],
    ],
]

Example 2: Partial failure device reset

$result = $client->batchResetDevicesForUser([
    'appIds' => [
        'd3135a42dcb6437780b16c3ca9581fe64e6822773cd6b965d25fc9929c89aca6',
        'invalid-app-id',
    ],
    'networkId' => '12345678',
    'userId' => '12345',
]);

Result syntax:

[
    'failed' => [
        [
            'appId' => 'invalid-app-id',
            'field' => 'appId',
            'reason' => 'Invalid app ID.',
        ],
    ],
    'message' => 'partial success',
    'successful' => [
        [
            'appId' => 'd3135a42dcb6437780b16c3ca9581fe64e6822773cd6b965d25fc9929c89aca6',
        ],
    ],
]

Example 3: Invalid network ID error

$result = $client->batchResetDevicesForUser([
    'appIds' => [
        'd3135a42dcb6437780b16c3ca9581fe64e6822773cd6b965d25fc9929c89aca6',
    ],
    'networkId' => '00000000',
    'userId' => '12345',
]);

BatchToggleUserSuspendStatus

$result = $client->batchToggleUserSuspendStatus([/* ... */]);
$promise = $client->batchToggleUserSuspendStatusAsync([/* ... */]);

Suspends or unsuspends multiple users in a Wickr network. Suspended users cannot access the network until they are unsuspended. This operation is useful for temporarily restricting access without deleting user accounts.

Parameter Syntax

$result = $client->batchToggleUserSuspendStatus([
    'clientToken' => '<string>',
    'networkId' => '<string>', // REQUIRED
    'suspend' => true || false, // REQUIRED
    'userIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'failed' => [
        [
            'field' => '<string>',
            'reason' => '<string>',
            'userId' => '<string>',
        ],
        // ...
    ],
    'message' => '<string>',
    'successful' => [
        [
            'userId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Suspend multiple users

$result = $client->batchToggleUserSuspendStatus([
    'clientToken' => '6ba7b815-9dad-11d1-80b4-00c04fd430c8',
    'networkId' => '12345678',
    'suspend' => 1,
    'userIds' => [
        '123',
        '456',
    ],
]);

Result syntax:

[
    'failed' => [
    ],
    'message' => 'success',
    'successful' => [
        [
            'userId' => '123',
        ],
        [
            'userId' => '456',
        ],
    ],
]

Example 2: Unsuspend users with partial failure

$result = $client->batchToggleUserSuspendStatus([
    'networkId' => '12345678',
    'suspend' => ,
    'userIds' => [
        '123',
        '456',
    ],
]);

Result syntax:

[
    'failed' => [
        [
            'field' => 'username',
            'reason' => 'User not found',
            'userId' => '456',
        ],
    ],
    'message' => 'partial success',
    'successful' => [
        [
            'userId' => '123',
        ],
    ],
]

CreateBot

$result = $client->createBot([/* ... */]);
$promise = $client->createBotAsync([/* ... */]);

Creates a new bot in a specified Wickr network. Bots are automated accounts that can send and receive messages, enabling integration with external systems and automation of tasks.

Parameter Syntax

$result = $client->createBot([
    'challenge' => '<string>', // REQUIRED
    'displayName' => '<string>',
    'groupId' => '<string>', // REQUIRED
    'networkId' => '<string>', // REQUIRED
    'username' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'botId' => '<string>',
    'displayName' => '<string>',
    'groupId' => '<string>',
    'message' => '<string>',
    'networkId' => '<string>',
    'username' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Create bot successfully

$result = $client->createBot([
    'challenge' => 'SecureP@ssw0rd123',
    'displayName' => 'Analytics Bot',
    'groupId' => 'analytics_group',
    'networkId' => '12345678',
    'username' => 'analytics_bot',
]);

Result syntax:

[
    'botId' => '98766',
    'displayName' => 'Analytics Bot',
    'groupId' => 'analytics_group',
    'networkId' => '12345678',
    'username' => 'analytics_bot',
]

Example 2: Create bot - username unavailable

$result = $client->createBot([
    'challenge' => 'SecureP@ssw0rd123',
    'displayName' => 'Support Bot',
    'groupId' => 'default_group',
    'networkId' => '12345678',
    'username' => 'support_bot',
]);

Example 3: Create bot - invalid username format

$result = $client->createBot([
    'challenge' => 'SecureP@ssw0rd123',
    'displayName' => 'Test Bot',
    'groupId' => 'default_group',
    'networkId' => '12345678',
    'username' => 'bot@invalid',
]);

CreateDataRetentionBot

$result = $client->createDataRetentionBot([/* ... */]);
$promise = $client->createDataRetentionBotAsync([/* ... */]);

Creates a data retention bot in a Wickr network. Data retention bots are specialized bots that handle message archiving and compliance by capturing and storing messages for regulatory or organizational requirements.

Parameter Syntax

$result = $client->createDataRetentionBot([
    'networkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'message' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Create data retention bot successfully

$result = $client->createDataRetentionBot([
    'networkId' => '12345678',
]);

Result syntax:

[
    'message' => 'successfully provisioned data retention bot',
]

Example 2: Create data retention bot - users already exist

$result = $client->createDataRetentionBot([
    'networkId' => '12345678',
]);

CreateDataRetentionBotChallenge

$result = $client->createDataRetentionBotChallenge([/* ... */]);
$promise = $client->createDataRetentionBotChallengeAsync([/* ... */]);

Creates a new challenge password for the data retention bot. This password is used for authentication when the bot connects to the network.

Parameter Syntax

$result = $client->createDataRetentionBotChallenge([
    'networkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'challenge' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Create data retention bot challenge successfully

$result = $client->createDataRetentionBotChallenge([
    'networkId' => '12345678',
]);

Result syntax:

[
    'challenge' => 'a1b2c3d4e5f6',
]

CreateNetwork

$result = $client->createNetwork([/* ... */]);
$promise = $client->createNetworkAsync([/* ... */]);

Creates a new Wickr network with specified access level and configuration. This operation provisions a new communication network for your organization.

Parameter Syntax

$result = $client->createNetwork([
    'accessLevel' => 'STANDARD|PREMIUM', // REQUIRED
    'enablePremiumFreeTrial' => true || false,
    'encryptionKeyArn' => '<string>',
    'networkName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'encryptionKeyArn' => '<string>',
    'networkId' => '<string>',
    'networkName' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Create network successfully

$result = $client->createNetwork([
    'accessLevel' => 'PREMIUM',
    'enablePremiumFreeTrial' => ,
    'networkName' => 'Production Network',
]);

Result syntax:

[
    'networkId' => '12345678',
    'networkName' => 'Production Network',
]

Example 2: Create network with free trial

$result = $client->createNetwork([
    'accessLevel' => 'PREMIUM',
    'enablePremiumFreeTrial' => 1,
    'networkName' => 'Trial Network',
]);

Result syntax:

[
    'networkId' => '87654321',
    'networkName' => 'Trial Network',
]

Example 3: Create network - invalid name

$result = $client->createNetwork([
    'accessLevel' => 'STANDARD',
    'networkName' => 'This network name is way too long',
]);

CreateSecurityGroup

$result = $client->createSecurityGroup([/* ... */]);
$promise = $client->createSecurityGroupAsync([/* ... */]);

Creates a new security group in a Wickr network. Security groups allow you to organize users and control their permissions, features, and security settings.

Parameter Syntax

$result = $client->createSecurityGroup([
    'clientToken' => '<string>',
    'name' => '<string>', // REQUIRED
    'networkId' => '<string>', // REQUIRED
    'securityGroupSettings' => [ // REQUIRED
        'enableGuestFederation' => true || false,
        'enableRestrictedGlobalFederation' => true || false,
        'federationMode' => <integer>,
        'globalFederation' => true || false,
        'lockoutThreshold' => <integer>,
        'permittedNetworks' => ['<string>', ...],
        'permittedWickrAwsNetworks' => [
            [
                'networkId' => '<string>', // REQUIRED
                'region' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'permittedWickrEnterpriseNetworks' => [
            [
                'domain' => '<string>', // REQUIRED
                'networkId' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'securityGroup' => [
        'activeDirectoryGuid' => '<string>',
        'activeMembers' => <integer>,
        'botMembers' => <integer>,
        'id' => '<string>',
        'isDefault' => true || false,
        'modified' => <integer>,
        'name' => '<string>',
        'securityGroupSettings' => [
            'alwaysReauthenticate' => true || false,
            'atakPackageValues' => ['<string>', ...],
            'calling' => [
                'canStart11Call' => true || false,
                'canVideoCall' => true || false,
                'forceTcpCall' => true || false,
            ],
            'checkForUpdates' => true || false,
            'enableAtak' => true || false,
            'enableCrashReports' => true || false,
            'enableFileDownload' => true || false,
            'enableGuestFederation' => true || false,
            'enableNotificationPreview' => true || false,
            'enableOpenAccessOption' => true || false,
            'enableRestrictedGlobalFederation' => true || false,
            'federationMode' => <integer>,
            'filesEnabled' => true || false,
            'forceDeviceLockout' => <integer>,
            'forceOpenAccess' => true || false,
            'forceReadReceipts' => true || false,
            'globalFederation' => true || false,
            'isAtoEnabled' => true || false,
            'isLinkPreviewEnabled' => true || false,
            'locationAllowMaps' => true || false,
            'locationEnabled' => true || false,
            'lockoutThreshold' => <integer>,
            'maxAutoDownloadSize' => <integer>,
            'maxBor' => <integer>,
            'maxTtl' => <integer>,
            'messageForwardingEnabled' => true || false,
            'passwordRequirements' => [
                'lowercase' => <integer>,
                'minLength' => <integer>,
                'numbers' => <integer>,
                'symbols' => <integer>,
                'uppercase' => <integer>,
            ],
            'permittedNetworks' => ['<string>', ...],
            'permittedWickrAwsNetworks' => [
                [
                    'networkId' => '<string>',
                    'region' => '<string>',
                ],
                // ...
            ],
            'permittedWickrEnterpriseNetworks' => [
                [
                    'domain' => '<string>',
                    'networkId' => '<string>',
                ],
                // ...
            ],
            'presenceEnabled' => true || false,
            'quickResponses' => ['<string>', ...],
            'showMasterRecoveryKey' => true || false,
            'shredder' => [
                'canProcessManually' => true || false,
                'intensity' => <integer>,
            ],
            'ssoMaxIdleMinutes' => <integer>,
        ],
    ],
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Create security group successfully

$result = $client->createSecurityGroup([
    'name' => 'engineering',
    'networkId' => '12345678',
    'securityGroupSettings' => [
        'federationMode' => 1,
        'lockoutThreshold' => 10,
    ],
]);

Result syntax:

[
    'securityGroup' => [
        'name' => 'engineering',
        'activeMembers' => 0,
        'botMembers' => 0,
        'id' => 'def67890',
        'isDefault' => ,
        'modified' => 1638360000,
        'securityGroupSettings' => [
            'federationMode' => 1,
            'lockoutThreshold' => 10,
        ],
    ],
]

Example 2: Create security group - missing name

$result = $client->createSecurityGroup([
    'name' => '',
    'networkId' => '12345678',
    'securityGroupSettings' => [
        'federationMode' => 1,
    ],
]);

DeleteBot

$result = $client->deleteBot([/* ... */]);
$promise = $client->deleteBotAsync([/* ... */]);

Deletes a bot from a specified Wickr network. This operation permanently removes the bot account and its associated data from the network.

Parameter Syntax

$result = $client->deleteBot([
    'botId' => '<string>', // REQUIRED
    'networkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'message' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Delete bot successfully

$result = $client->deleteBot([
    'botId' => '98765',
    'networkId' => '12345678',
]);

Result syntax:

[
    'message' => 'success',
]

Example 2: Delete bot - bot not found

$result = $client->deleteBot([
    'botId' => '99999',
    'networkId' => '12345678',
]);

DeleteDataRetentionBot

$result = $client->deleteDataRetentionBot([/* ... */]);
$promise = $client->deleteDataRetentionBotAsync([/* ... */]);

Deletes the data retention bot from a Wickr network. This operation permanently removes the bot and all its associated data from the database.

Parameter Syntax

$result = $client->deleteDataRetentionBot([
    'networkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'message' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Delete data retention bot successfully

$result = $client->deleteDataRetentionBot([
    'networkId' => '12345678',
]);

Result syntax:

[
    'message' => 'deleted data retention bot and all associated data from the database',
]

DeleteNetwork

$result = $client->deleteNetwork([/* ... */]);
$promise = $client->deleteNetworkAsync([/* ... */]);

Deletes a Wickr network and all its associated resources, including users, bots, security groups, and settings. This operation is permanent and cannot be undone.

Parameter Syntax

$result = $client->deleteNetwork([
    'clientToken' => '<string>',
    'networkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'message' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Delete network successfully

$result = $client->deleteNetwork([
    'networkId' => '12345678',
]);

Result syntax:

[
    'message' => 'Network deletion initiated successfully',
]

Example 2: Delete network - not found

$result = $client->deleteNetwork([
    'networkId' => '99999999',
]);

DeleteSecurityGroup

$result = $client->deleteSecurityGroup([/* ... */]);
$promise = $client->deleteSecurityGroupAsync([/* ... */]);

Deletes a security group from a Wickr network. This operation cannot be performed on the default security group.

Parameter Syntax

$result = $client->deleteSecurityGroup([
    'groupId' => '<string>', // REQUIRED
    'networkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'groupId' => '<string>',
    'message' => '<string>',
    'networkId' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Delete security group successfully

$result = $client->deleteSecurityGroup([
    'groupId' => 'def67890',
    'networkId' => '12345678',
]);

Result syntax:

[
    'groupId' => 'def67890',
    'message' => 'success',
    'networkId' => '12345678',
]

Example 2: Delete security group - not found

$result = $client->deleteSecurityGroup([
    'groupId' => 'invalid99',
    'networkId' => '12345678',
]);

GetBot

$result = $client->getBot([/* ... */]);
$promise = $client->getBotAsync([/* ... */]);

Retrieves detailed information about a specific bot in a Wickr network, including its status, group membership, and authentication details.

Parameter Syntax

$result = $client->getBot([
    'botId' => '<string>', // REQUIRED
    'networkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'botId' => '<string>',
    'displayName' => '<string>',
    'groupId' => '<string>',
    'hasChallenge' => true || false,
    'lastLogin' => '<string>',
    'pubkey' => '<string>',
    'status' => <integer>,
    'suspended' => true || false,
    'uname' => '<string>',
    'username' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Get bot successfully

$result = $client->getBot([
    'botId' => '98765',
    'networkId' => '12345678',
]);

Result syntax:

[
    'botId' => '98765',
    'displayName' => 'Support Bot',
    'groupId' => 'default_group',
    'hasChallenge' => 1,
    'lastLogin' => '1704067200',
    'pubkey' => 'LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUF4',
    'status' => 2,
    'suspended' => ,
    'uname' => 'abc123def456',
    'username' => 'support_bot',
]

Example 2: Get bot - bot not found

$result = $client->getBot([
    'botId' => '99999',
    'networkId' => '12345678',
]);

GetBotsCount

$result = $client->getBotsCount([/* ... */]);
$promise = $client->getBotsCountAsync([/* ... */]);

Retrieves the count of bots in a Wickr network, categorized by their status (pending, active, and total).

Parameter Syntax

$result = $client->getBotsCount([
    'networkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'active' => <integer>,
    'pending' => <integer>,
    'total' => <integer>,
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Get bots count successfully

$result = $client->getBotsCount([
    'networkId' => '12345678',
]);

Result syntax:

[
    'active' => 12,
    'pending' => 2,
    'total' => 15,
]

Example 2: Get bots count with filters

$result = $client->getBotsCount([
    'networkId' => '12345678',
]);

Result syntax:

[
    'active' => 12,
    'pending' => 0,
    'total' => 12,
]

GetDataRetentionBot

$result = $client->getDataRetentionBot([/* ... */]);
$promise = $client->getDataRetentionBotAsync([/* ... */]);

Retrieves information about the data retention bot in a Wickr network, including its status and whether the data retention service is enabled.

Parameter Syntax

$result = $client->getDataRetentionBot([
    'networkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'botExists' => true || false,
    'botName' => '<string>',
    'isBotActive' => true || false,
    'isDataRetentionBotRegistered' => true || false,
    'isDataRetentionServiceEnabled' => true || false,
    'isPubkeyMsgAcked' => true || false,
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Get data retention bot successfully

$result = $client->getDataRetentionBot([
    'networkId' => '12345678',
]);

Result syntax:

[
    'botExists' => 1,
    'botName' => 'compliance_12345678_bot',
    'isBotActive' => 1,
    'isDataRetentionBotRegistered' => 1,
    'isDataRetentionServiceEnabled' => 1,
    'isPubkeyMsgAcked' => ,
]

Example 2: Get data retention bot - not provisioned

$result = $client->getDataRetentionBot([
    'networkId' => '12345678',
]);

Result syntax:

[
    'botExists' => ,
    'botName' => 'compliance_12345678_bot',
    'isBotActive' => ,
    'isDataRetentionBotRegistered' => ,
    'isDataRetentionServiceEnabled' => ,
    'isPubkeyMsgAcked' => ,
]

GetGuestUserHistoryCount

$result = $client->getGuestUserHistoryCount([/* ... */]);
$promise = $client->getGuestUserHistoryCountAsync([/* ... */]);

Retrieves historical guest user count data for a Wickr network, showing the number of guest users per billing period over the past 90 days.

Parameter Syntax

$result = $client->getGuestUserHistoryCount([
    'networkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'history' => [
        [
            'count' => '<string>',
            'month' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Get guest user history count

$result = $client->getGuestUserHistoryCount([
    'networkId' => '12345678',
]);

Result syntax:

[
    'history' => [
        [
            'count' => '32',
            'month' => '2024_01',
        ],
        [
            'count' => '28',
            'month' => '2023_12',
        ],
        [
            'count' => '35',
            'month' => '2023_11',
        ],
        [
            'count' => '22',
            'month' => '2023_10',
        ],
        [
            'count' => '18',
            'month' => '2023_09',
        ],
        [
            'count' => '15',
            'month' => '2023_08',
        ],
    ],
]

Example 2: Empty response for network with no guest user history

$result = $client->getGuestUserHistoryCount([
    'networkId' => '87654321',
]);

Result syntax:

[
    'history' => [
    ],
]

GetNetwork

$result = $client->getNetwork([/* ... */]);
$promise = $client->getNetworkAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getNetwork([
    'networkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'accessLevel' => 'STANDARD|PREMIUM',
    'awsAccountId' => '<string>',
    'encryptionKeyArn' => '<string>',
    'freeTrialExpiration' => '<string>',
    'migrationState' => <integer>,
    'networkArn' => '<string>',
    'networkId' => '<string>',
    'networkName' => '<string>',
    'standing' => <integer>,
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Get network successfully

$result = $client->getNetwork([
    'networkId' => '12345678',
]);

Result syntax:

[
    'accessLevel' => 'PREMIUM',
    'awsAccountId' => '123456789012',
    'migrationState' => 0,
    'networkArn' => 'arn:aws:wickr:us-east-1:123456789012:network/12345678',
    'networkId' => '12345678',
    'networkName' => 'Production Network',
    'standing' => 1,
]

Example 2: Get network - not found

$result = $client->getNetwork([
    'networkId' => '99999999',
]);

GetNetworkSettings

$result = $client->getNetworkSettings([/* ... */]);
$promise = $client->getNetworkSettingsAsync([/* ... */]);

Retrieves all network-level settings for a Wickr network, including client metrics, data retention, and other configuration options.

Parameter Syntax

$result = $client->getNetworkSettings([
    'networkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'settings' => [
        [
            'optionName' => '<string>',
            'type' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Get network settings with mixed value types

$result = $client->getNetworkSettings([
    'networkId' => '12345678',
]);

Result syntax:

[
    'settings' => [
        [
            'type' => 'boolean',
            'value' => 'true',
            'optionName' => 'enableClientMetrics',
        ],
        [
            'type' => 'boolean',
            'value' => 'true',
            'optionName' => 'dataRetention',
        ],
    ],
]

Example 2: Get settings for network with defaults only

$result = $client->getNetworkSettings([
    'networkId' => '87654321',
]);

Result syntax:

[
    'settings' => [
        [
            'type' => 'boolean',
            'value' => 'false',
            'optionName' => 'enableClientMetrics',
        ],
        [
            'type' => 'boolean',
            'value' => 'false',
            'optionName' => 'dataRetention',
        ],
    ],
]

Example 3: Network not found error

$result = $client->getNetworkSettings([
    'networkId' => '99999999',
]);

GetOidcInfo

$result = $client->getOidcInfo([/* ... */]);
$promise = $client->getOidcInfoAsync([/* ... */]);

Retrieves the OpenID Connect (OIDC) configuration for a Wickr network, including SSO settings and optional token information if access token parameters are provided.

Parameter Syntax

$result = $client->getOidcInfo([
    'certificate' => '<string>',
    'clientId' => '<string>',
    'clientSecret' => '<string>',
    'code' => '<string>',
    'codeVerifier' => '<string>',
    'grantType' => '<string>',
    'networkId' => '<string>', // REQUIRED
    'redirectUri' => '<string>',
    'url' => '<string>',
]);

Parameter Details

Result Syntax

[
    'openidConnectInfo' => [
        'applicationId' => <integer>,
        'applicationName' => '<string>',
        'caCertificate' => '<string>',
        'clientId' => '<string>',
        'clientSecret' => '<string>',
        'companyId' => '<string>',
        'customUsername' => '<string>',
        'extraAuthParams' => '<string>',
        'issuer' => '<string>',
        'redirectUrl' => '<string>',
        'scopes' => '<string>',
        'secret' => '<string>',
        'ssoTokenBufferMinutes' => <integer>,
        'userId' => '<string>',
    ],
    'tokenInfo' => [
        'accessToken' => '<string>',
        'codeChallenge' => '<string>',
        'codeVerifier' => '<string>',
        'expiresIn' => <integer>,
        'idToken' => '<string>',
        'refreshToken' => '<string>',
        'tokenType' => '<string>',
    ],
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Get OIDC info successfully

$result = $client->getOidcInfo([
    'networkId' => '12345678',
]);

Result syntax:

[
    'openidConnectInfo' => [
        'clientId' => 'client123',
        'companyId' => 'us-east-1-company123',
        'issuer' => 'https://login.example.com',
        'redirectUrl' => 'https://app.wickr.com/callback',
        'scopes' => 'openid profile email',
        'ssoTokenBufferMinutes' => 5,
        'userId' => 'email',
    ],
]

Example 2: Get OIDC info - not configured

$result = $client->getOidcInfo([
    'networkId' => '12345678',
]);

Result syntax:

[
    'openidConnectInfo' => [
        'companyId' => '',
        'issuer' => '',
        'scopes' => '',
    ],
]

GetSecurityGroup

$result = $client->getSecurityGroup([/* ... */]);
$promise = $client->getSecurityGroupAsync([/* ... */]);

Retrieves detailed information about a specific security group in a Wickr network, including its settings, member counts, and configuration.

Parameter Syntax

$result = $client->getSecurityGroup([
    'groupId' => '<string>', // REQUIRED
    'networkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'securityGroup' => [
        'activeDirectoryGuid' => '<string>',
        'activeMembers' => <integer>,
        'botMembers' => <integer>,
        'id' => '<string>',
        'isDefault' => true || false,
        'modified' => <integer>,
        'name' => '<string>',
        'securityGroupSettings' => [
            'alwaysReauthenticate' => true || false,
            'atakPackageValues' => ['<string>', ...],
            'calling' => [
                'canStart11Call' => true || false,
                'canVideoCall' => true || false,
                'forceTcpCall' => true || false,
            ],
            'checkForUpdates' => true || false,
            'enableAtak' => true || false,
            'enableCrashReports' => true || false,
            'enableFileDownload' => true || false,
            'enableGuestFederation' => true || false,
            'enableNotificationPreview' => true || false,
            'enableOpenAccessOption' => true || false,
            'enableRestrictedGlobalFederation' => true || false,
            'federationMode' => <integer>,
            'filesEnabled' => true || false,
            'forceDeviceLockout' => <integer>,
            'forceOpenAccess' => true || false,
            'forceReadReceipts' => true || false,
            'globalFederation' => true || false,
            'isAtoEnabled' => true || false,
            'isLinkPreviewEnabled' => true || false,
            'locationAllowMaps' => true || false,
            'locationEnabled' => true || false,
            'lockoutThreshold' => <integer>,
            'maxAutoDownloadSize' => <integer>,
            'maxBor' => <integer>,
            'maxTtl' => <integer>,
            'messageForwardingEnabled' => true || false,
            'passwordRequirements' => [
                'lowercase' => <integer>,
                'minLength' => <integer>,
                'numbers' => <integer>,
                'symbols' => <integer>,
                'uppercase' => <integer>,
            ],
            'permittedNetworks' => ['<string>', ...],
            'permittedWickrAwsNetworks' => [
                [
                    'networkId' => '<string>',
                    'region' => '<string>',
                ],
                // ...
            ],
            'permittedWickrEnterpriseNetworks' => [
                [
                    'domain' => '<string>',
                    'networkId' => '<string>',
                ],
                // ...
            ],
            'presenceEnabled' => true || false,
            'quickResponses' => ['<string>', ...],
            'showMasterRecoveryKey' => true || false,
            'shredder' => [
                'canProcessManually' => true || false,
                'intensity' => <integer>,
            ],
            'ssoMaxIdleMinutes' => <integer>,
        ],
    ],
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Get security group successfully

$result = $client->getSecurityGroup([
    'groupId' => 'abc12345',
    'networkId' => '12345678',
]);

Result syntax:

[
    'securityGroup' => [
        'name' => 'default',
        'activeMembers' => 50,
        'botMembers' => 5,
        'id' => 'abc12345',
        'isDefault' => 1,
        'modified' => 1638360000,
        'securityGroupSettings' => [
            'federationMode' => 1,
            'lockoutThreshold' => 10,
        ],
    ],
]

Example 2: Get security group - not found

$result = $client->getSecurityGroup([
    'groupId' => 'invalid99',
    'networkId' => '12345678',
]);

GetUser

$result = $client->getUser([/* ... */]);
$promise = $client->getUserAsync([/* ... */]);

Retrieves detailed information about a specific user in a Wickr network, including their profile, status, and activity history.

Parameter Syntax

$result = $client->getUser([
    'endTime' => <integer || string || DateTime>,
    'networkId' => '<string>', // REQUIRED
    'startTime' => <integer || string || DateTime>,
    'userId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'firstName' => '<string>',
    'isAdmin' => true || false,
    'lastActivity' => <integer>,
    'lastLogin' => <integer>,
    'lastName' => '<string>',
    'securityGroupIds' => ['<string>', ...],
    'status' => <integer>,
    'suspended' => true || false,
    'userId' => '<string>',
    'username' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Get user information

$result = $client->getUser([
    'networkId' => '12345678',
    'userId' => '12345',
]);

Result syntax:

[
    'firstName' => 'John',
    'isAdmin' => ,
    'lastActivity' => 1705500000,
    'lastLogin' => 1705499000,
    'lastName' => 'Doe',
    'securityGroupIds' => [
        'BCTY8Qhe',
    ],
    'status' => 2,
    'suspended' => ,
    'userId' => '12345',
    'username' => 'john.doe@example.com',
]

Example 2: Get user info with activity time range

$result = $client->getUser([
    'endTime' => ,
    'networkId' => '12345678',
    'startTime' => ,
    'userId' => '12345',
]);

Result syntax:

[
    'firstName' => 'Jane',
    'isAdmin' => 1,
    'lastActivity' => 1705400000,
    'lastLogin' => 1705350000,
    'lastName' => 'Admin',
    'securityGroupIds' => [
        'BCTY8Qhe',
        'ADMIN001',
    ],
    'status' => 2,
    'suspended' => ,
    'userId' => '12345',
    'username' => 'jane.admin@example.com',
]

Example 3: User not found error

$result = $client->getUser([
    'networkId' => '12345678',
    'userId' => '99999',
]);

Example 4: Invalid userId error

$result = $client->getUser([
    'networkId' => '12345678',
    'userId' => '99999',
]);

GetUsersCount

$result = $client->getUsersCount([/* ... */]);
$promise = $client->getUsersCountAsync([/* ... */]);

Retrieves the count of users in a Wickr network, categorized by their status (pending, active, rejected) and showing how many users can still be added.

Parameter Syntax

$result = $client->getUsersCount([
    'networkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'active' => <integer>,
    'pending' => <integer>,
    'rejected' => <integer>,
    'remaining' => <integer>,
    'total' => <integer>,
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Get user counts for network

$result = $client->getUsersCount([
    'networkId' => '12345678',
]);

Result syntax:

[
    'active' => 25,
    'pending' => 5,
    'rejected' => 2,
    'remaining' => 15,
    'total' => 32,
]

Example 2: Network with no users

$result = $client->getUsersCount([
    'networkId' => '87654321',
]);

Result syntax:

[
    'active' => 0,
    'pending' => 0,
    'rejected' => 0,
    'remaining' => 50,
    'total' => 0,
]

ListBlockedGuestUsers

$result = $client->listBlockedGuestUsers([/* ... */]);
$promise = $client->listBlockedGuestUsersAsync([/* ... */]);

Retrieves a paginated list of guest users who have been blocked from a Wickr network. You can filter and sort the results.

Parameter Syntax

$result = $client->listBlockedGuestUsers([
    'admin' => '<string>',
    'maxResults' => <integer>,
    'networkId' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'sortDirection' => 'ASC|DESC',
    'sortFields' => '<string>',
    'username' => '<string>',
]);

Parameter Details

Result Syntax

[
    'blocklist' => [
        [
            'admin' => '<string>',
            'modified' => '<string>',
            'username' => '<string>',
            'usernameHash' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Get paginated list of blocked guest users

$result = $client->listBlockedGuestUsers([
    'maxResults' => 10,
    'networkId' => '12345678',
    'sortDirection' => 'DESC',
    'sortFields' => 'modified',
]);

Result syntax:

[
    'blocklist' => [
        [
            'admin' => 'admin@company.com',
            'modified' => '2024-01-15 10:30:00',
            'username' => 'blocked.user1@example.com',
            'usernameHash' => '032c36d5623781204592a69269ed9480d604484269c8a4c2d39528885a56470d',
        ],
        [
            'admin' => 'admin@company.com',
            'modified' => '2024-01-10 14:20:00',
            'username' => 'blocked.user2@example.com',
            'usernameHash' => '032c36d5623781204592a69269ed9480d604484269c8a4c2d39528885a56470d',
        ],
        [
            'admin' => 'security@company.com',
            'modified' => '2024-01-05 09:15:00',
            'username' => 'blocked.user3@example.com',
            'usernameHash' => '032c36d5623781204592a69269ed9480d604484269c8a4c2d39528885a56470d',
        ],
    ],
    'nextToken' => 'v1:pagination:f47ac10b-58cc-4372-a567-0e02b2c3d479',
]

Example 2: Filter by username

$result = $client->listBlockedGuestUsers([
    'networkId' => '12345678',
    'username' => 'john.doe@example.com',
]);

Result syntax:

[
    'blocklist' => [
        [
            'admin' => 'admin@company.com',
            'modified' => '2023-12-20 16:45:00',
            'username' => 'john.doe@example.com',
            'usernameHash' => '032c36d5623781204592a69269ed9480d604484269c8a4c2d39528885a56470d',
        ],
    ],
]

Example 3: Empty blocklist

$result = $client->listBlockedGuestUsers([
    'networkId' => '12345678',
]);

Result syntax:

[
    'blocklist' => [
    ],
]

ListBots

$result = $client->listBots([/* ... */]);
$promise = $client->listBotsAsync([/* ... */]);

Retrieves a paginated list of bots in a specified Wickr network. You can filter and sort the results based on various criteria.

Parameter Syntax

$result = $client->listBots([
    'displayName' => '<string>',
    'groupId' => '<string>',
    'maxResults' => <integer>,
    'networkId' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'sortDirection' => 'ASC|DESC',
    'sortFields' => '<string>',
    'status' => <integer>,
    'username' => '<string>',
]);

Parameter Details

Result Syntax

[
    'bots' => [
        [
            'botId' => '<string>',
            'displayName' => '<string>',
            'groupId' => '<string>',
            'hasChallenge' => true || false,
            'lastLogin' => '<string>',
            'pubkey' => '<string>',
            'status' => <integer>,
            'suspended' => true || false,
            'uname' => '<string>',
            'username' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: List bots with pagination

$result = $client->listBots([
    'maxResults' => 10,
    'networkId' => '12345678',
    'sortDirection' => 'ASC',
    'sortFields' => 'username',
]);

Result syntax:

[
    'bots' => [
        [
            'botId' => '98765',
            'displayName' => 'Analytics Bot',
            'groupId' => 'analytics_group',
            'hasChallenge' => 1,
            'lastLogin' => '1704067200',
            'pubkey' => 'LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUF4',
            'status' => 2,
            'suspended' => ,
            'uname' => 'abc123def456',
            'username' => 'analytics_bot',
        ],
        [
            'botId' => '98766',
            'displayName' => 'Support Bot',
            'groupId' => 'support_group',
            'hasChallenge' => 1,
            'lastLogin' => '1704153600',
            'pubkey' => 'LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUF5',
            'status' => 2,
            'suspended' => ,
            'uname' => 'def456ghi789',
            'username' => 'support_bot',
        ],
    ],
    'nextToken' => 'eyJzdGFydEluZGV4IjoxMH0=',
]

Example 2: List bots with filters

$result = $client->listBots([
    'displayName' => 'Support',
    'maxResults' => 10,
    'networkId' => '12345678',
    'status' => 2,
]);

Result syntax:

[
    'bots' => [
        [
            'botId' => '98766',
            'displayName' => 'Support Bot',
            'groupId' => 'support_group',
            'hasChallenge' => 1,
            'lastLogin' => '1704153600',
            'pubkey' => 'LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUF5',
            'status' => 2,
            'suspended' => ,
            'uname' => 'def456ghi789',
            'username' => 'support_bot',
        ],
    ],
]

ListDevicesForUser

$result = $client->listDevicesForUser([/* ... */]);
$promise = $client->listDevicesForUserAsync([/* ... */]);

Retrieves a paginated list of devices associated with a specific user in a Wickr network. This operation returns information about all devices where the user has logged into Wickr.

Parameter Syntax

$result = $client->listDevicesForUser([
    'maxResults' => <integer>,
    'networkId' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'sortDirection' => 'ASC|DESC',
    'sortFields' => '<string>',
    'userId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'devices' => [
        [
            'appId' => '<string>',
            'created' => '<string>',
            'lastLogin' => '<string>',
            'statusText' => '<string>',
            'suspend' => true || false,
            'type' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Successful device list retrieval

$result = $client->listDevicesForUser([
    'maxResults' => 10,
    'networkId' => '12345678',
    'sortDirection' => 'DESC',
    'sortFields' => 'appId',
    'userId' => '12345',
]);

Result syntax:

[
    'devices' => [
        [
            'type' => 'mobile',
            'appId' => 'd3135a42dcb6437780b16c3ca9581fe64e6822773cd6b965d25fc9929c89aca6',
            'created' => 'January 15th 2024, 2:30:45 pm',
            'lastLogin' => 'January 20th 2024, 9:15:30 am',
            'statusText' => 'Active',
            'suspend' => ,
        ],
        [
            'type' => 'desktop',
            'appId' => 'e4246b53edc7548891c27d4da0692fe75f7933884de7c076e36gca030d90bdb7',
            'created' => 'December 10th 2023, 11:45:20 am',
            'lastLogin' => 'January 18th 2024, 4:20:15 pm',
            'statusText' => 'Suspended',
            'suspend' => 1,
        ],
    ],
]

Example 2: Retrieving subsequent page of devices

$result = $client->listDevicesForUser([
    'maxResults' => 10,
    'networkId' => '12345678',
    'nextToken' => 'v1:pagination:6ba7b810-9dad-11d1-80b4-00c04fd430c8',
    'userId' => '12345',
]);

Result syntax:

[
    'devices' => [
        [
            'type' => 'web',
            'appId' => 'f5357c64fde8659002c38e5db1804gf86g8044995ef8d187f47hdb141e01dce8',
            'created' => 'January 1st 2024, 12:00:00 pm',
            'lastLogin' => 'January 21st 2024, 8:22:00 am',
            'statusText' => 'Active',
            'suspend' => ,
        ],
        [
            'type' => 'mobile',
            'appId' => 'g6468d75gef9760113d49f6ec2915hg97h9155aa6fg9e298g58iec252f12edf9',
            'created' => 'December 24th 2023, 4:00:00 pm',
            'lastLogin' => 'January 20th 2024, 9:15:30 am',
            'statusText' => 'Active',
            'suspend' => ,
        ],
    ],
    'nextToken' => 'v1:pagination:7cb8c921-aebe-22e2-91c5-11d05fe541d9',
]

Example 3: Invalid userId error

$result = $client->listDevicesForUser([
    'maxResults' => 10,
    'networkId' => '12345678',
    'userId' => '99999',
]);

ListGuestUsers

$result = $client->listGuestUsers([/* ... */]);
$promise = $client->listGuestUsersAsync([/* ... */]);

Retrieves a paginated list of guest users who have communicated with your Wickr network. Guest users are external users from federated networks who can communicate with network members.

Parameter Syntax

$result = $client->listGuestUsers([
    'billingPeriod' => '<string>',
    'maxResults' => <integer>,
    'networkId' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'sortDirection' => 'ASC|DESC',
    'sortFields' => '<string>',
    'username' => '<string>',
]);

Parameter Details

Result Syntax

[
    'guestlist' => [
        [
            'billingPeriod' => '<string>',
            'username' => '<string>',
            'usernameHash' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Get paginated list of guest users

$result = $client->listGuestUsers([
    'maxResults' => 20,
    'networkId' => '12345678',
    'sortDirection' => 'DESC',
    'sortFields' => 'billingPeriod',
]);

Result syntax:

[
    'guestlist' => [
        [
            'billingPeriod' => '2024-01',
            'username' => 'guest1@example.com',
            'usernameHash' => 'e8e55b924aee6554edb87816c66704564504d25fbb95fc4dbc944feb977cbc26',
        ],
        [
            'billingPeriod' => '2024-01',
            'username' => 'guest2@example.com',
            'usernameHash' => 'a9e55b924aee6554edb87816c66704564504d25fbb95fc4dbc944feb977cbc26',
        ],
        [
            'billingPeriod' => '2023-12',
            'username' => 'guest3@example.com',
            'usernameHash' => 'c3e55b924aee6554edb87816c66704564504d25fbb95fc4dbc944feb977cbc26',
        ],
        [
            'billingPeriod' => '2023-12',
            'username' => 'guest4@example.com',
            'usernameHash' => 'k2e55b924aee6554edb87816c66704564504d25fbb95fc4dbc944feb977cbc26',
        ],
    ],
    'nextToken' => 'v1:pagination:550e8400-e29b-41d4-a716-446655440000',
]

Example 2: Filter by billing period

$result = $client->listGuestUsers([
    'billingPeriod' => '2024-01',
    'maxResults' => 10,
    'networkId' => '12345678',
]);

Result syntax:

[
    'guestlist' => [
        [
            'billingPeriod' => '2024-01',
            'username' => 'guest1@example.com',
            'usernameHash' => 'e8e55b924aee6554edb87816c66704564504d25fbb95fc4dbc944feb977cbc26',
        ],
        [
            'billingPeriod' => '2024-01',
            'username' => 'guest2@example.com',
            'usernameHash' => 'a9e55b924aee6554edb87816c66704564504d25fbb95fc4dbc944feb977cbc26',
        ],
    ],
    'nextToken' => 'v1:pagination:6ba7b810-9dad-11d1-80b4-00c04fd430c8',
]

Example 3: Empty guest list

$result = $client->listGuestUsers([
    'networkId' => '87654321',
]);

Result syntax:

[
    'guestlist' => [
    ],
]

ListNetworks

$result = $client->listNetworks([/* ... */]);
$promise = $client->listNetworksAsync([/* ... */]);

Retrieves a paginated list of all Wickr networks associated with your Amazon Web Services account. You can sort the results by network ID or name.

Parameter Syntax

$result = $client->listNetworks([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortDirection' => 'ASC|DESC',
    'sortFields' => '<string>',
]);

Parameter Details

Result Syntax

[
    'networks' => [
        [
            'accessLevel' => 'STANDARD|PREMIUM',
            'awsAccountId' => '<string>',
            'encryptionKeyArn' => '<string>',
            'freeTrialExpiration' => '<string>',
            'migrationState' => <integer>,
            'networkArn' => '<string>',
            'networkId' => '<string>',
            'networkName' => '<string>',
            'standing' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: List networks with pagination

$result = $client->listNetworks([
    'maxResults' => 10,
    'sortDirection' => 'ASC',
    'sortFields' => 'networkName',
]);

Result syntax:

[
    'networks' => [
        [
            'accessLevel' => 'STANDARD',
            'awsAccountId' => '123456789012',
            'networkArn' => 'arn:aws:wickr:us-east-1:123456789012:network/12345678',
            'networkId' => '12345678',
            'networkName' => 'Dev Network',
            'standing' => 1,
        ],
        [
            'accessLevel' => 'PREMIUM',
            'awsAccountId' => '123456789012',
            'networkArn' => 'arn:aws:wickr:us-east-1:123456789012:network/87654321',
            'networkId' => '87654321',
            'networkName' => 'Prod Network',
            'standing' => 1,
        ],
    ],
    'nextToken' => 'eyJvZmZzZXQiOjEwfQ==',
]

Example 2: List networks - first page

$result = $client->listNetworks([
    'maxResults' => 10,
]);

Result syntax:

[
    'networks' => [
        [
            'accessLevel' => 'PREMIUM',
            'awsAccountId' => '123456789012',
            'networkArn' => 'arn:aws:wickr:us-east-1:123456789012:network/12345678',
            'networkId' => '12345678',
            'networkName' => 'Production Network',
            'standing' => 1,
        ],
    ],
]

ListSecurityGroupUsers

$result = $client->listSecurityGroupUsers([/* ... */]);
$promise = $client->listSecurityGroupUsersAsync([/* ... */]);

Retrieves a paginated list of users who belong to a specific security group in a Wickr network.

Parameter Syntax

$result = $client->listSecurityGroupUsers([
    'groupId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'networkId' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'sortDirection' => 'ASC|DESC',
    'sortFields' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'users' => [
        [
            'cell' => '<string>',
            'challengeFailures' => <integer>,
            'codeValidation' => true || false,
            'countryCode' => '<string>',
            'firstName' => '<string>',
            'inviteCode' => '<string>',
            'isAdmin' => true || false,
            'isInviteExpired' => true || false,
            'isUser' => true || false,
            'lastName' => '<string>',
            'otpEnabled' => true || false,
            'scimId' => '<string>',
            'securityGroups' => ['<string>', ...],
            'status' => <integer>,
            'suspended' => true || false,
            'type' => '<string>',
            'uname' => '<string>',
            'userId' => '<string>',
            'username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: List security group users with pagination

$result = $client->listSecurityGroupUsers([
    'groupId' => 'abc12345',
    'maxResults' => 10,
    'networkId' => '12345678',
    'sortDirection' => 'ASC',
    'sortFields' => 'username',
]);

Result syntax:

[
    'nextToken' => 'eyJvZmZzZXQiOjEwfQ==',
    'users' => [
        [
            'firstName' => 'Alice',
            'lastName' => 'Smith',
            'username' => 'alice@example.com',
        ],
        [
            'firstName' => 'Bob',
            'lastName' => 'Jones',
            'username' => 'bob@example.com',
        ],
    ],
]

ListSecurityGroups

$result = $client->listSecurityGroups([/* ... */]);
$promise = $client->listSecurityGroupsAsync([/* ... */]);

Retrieves a paginated list of security groups in a specified Wickr network. You can sort the results by various criteria.

Parameter Syntax

$result = $client->listSecurityGroups([
    'maxResults' => <integer>,
    'networkId' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'sortDirection' => 'ASC|DESC',
    'sortFields' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'securityGroups' => [
        [
            'activeDirectoryGuid' => '<string>',
            'activeMembers' => <integer>,
            'botMembers' => <integer>,
            'id' => '<string>',
            'isDefault' => true || false,
            'modified' => <integer>,
            'name' => '<string>',
            'securityGroupSettings' => [
                'alwaysReauthenticate' => true || false,
                'atakPackageValues' => ['<string>', ...],
                'calling' => [
                    'canStart11Call' => true || false,
                    'canVideoCall' => true || false,
                    'forceTcpCall' => true || false,
                ],
                'checkForUpdates' => true || false,
                'enableAtak' => true || false,
                'enableCrashReports' => true || false,
                'enableFileDownload' => true || false,
                'enableGuestFederation' => true || false,
                'enableNotificationPreview' => true || false,
                'enableOpenAccessOption' => true || false,
                'enableRestrictedGlobalFederation' => true || false,
                'federationMode' => <integer>,
                'filesEnabled' => true || false,
                'forceDeviceLockout' => <integer>,
                'forceOpenAccess' => true || false,
                'forceReadReceipts' => true || false,
                'globalFederation' => true || false,
                'isAtoEnabled' => true || false,
                'isLinkPreviewEnabled' => true || false,
                'locationAllowMaps' => true || false,
                'locationEnabled' => true || false,
                'lockoutThreshold' => <integer>,
                'maxAutoDownloadSize' => <integer>,
                'maxBor' => <integer>,
                'maxTtl' => <integer>,
                'messageForwardingEnabled' => true || false,
                'passwordRequirements' => [
                    'lowercase' => <integer>,
                    'minLength' => <integer>,
                    'numbers' => <integer>,
                    'symbols' => <integer>,
                    'uppercase' => <integer>,
                ],
                'permittedNetworks' => ['<string>', ...],
                'permittedWickrAwsNetworks' => [
                    [
                        'networkId' => '<string>',
                        'region' => '<string>',
                    ],
                    // ...
                ],
                'permittedWickrEnterpriseNetworks' => [
                    [
                        'domain' => '<string>',
                        'networkId' => '<string>',
                    ],
                    // ...
                ],
                'presenceEnabled' => true || false,
                'quickResponses' => ['<string>', ...],
                'showMasterRecoveryKey' => true || false,
                'shredder' => [
                    'canProcessManually' => true || false,
                    'intensity' => <integer>,
                ],
                'ssoMaxIdleMinutes' => <integer>,
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: List security groups with pagination

$result = $client->listSecurityGroups([
    'maxResults' => 10,
    'networkId' => '12345678',
    'sortDirection' => 'ASC',
    'sortFields' => 'name',
]);

Result syntax:

[
    'nextToken' => 'eyJvZmZzZXQiOjEwfQ==',
    'securityGroups' => [
        [
            'name' => 'default',
            'activeMembers' => 25,
            'botMembers' => 0,
            'id' => 'abc12345',
            'isDefault' => 1,
            'modified' => 1638360000,
            'securityGroupSettings' => [
                'lockoutThreshold' => 10,
            ],
        ],
        [
            'name' => 'engineering',
            'activeMembers' => 10,
            'botMembers' => 2,
            'id' => 'def67890',
            'isDefault' => ,
            'modified' => 1638360000,
            'securityGroupSettings' => [
                'lockoutThreshold' => 15,
            ],
        ],
    ],
]

Example 2: List security groups - first page

$result = $client->listSecurityGroups([
    'maxResults' => 10,
    'networkId' => '12345678',
]);

Result syntax:

[
    'securityGroups' => [
        [
            'name' => 'default',
            'activeMembers' => 25,
            'botMembers' => 0,
            'id' => 'abc12345',
            'isDefault' => 1,
            'modified' => 1638360000,
            'securityGroupSettings' => [
                'lockoutThreshold' => 10,
            ],
        ],
    ],
]

ListUsers

$result = $client->listUsers([/* ... */]);
$promise = $client->listUsersAsync([/* ... */]);

Retrieves a paginated list of users in a specified Wickr network. You can filter and sort the results based on various criteria such as name, status, or security group membership.

Parameter Syntax

$result = $client->listUsers([
    'firstName' => '<string>',
    'groupId' => '<string>',
    'lastName' => '<string>',
    'maxResults' => <integer>,
    'networkId' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'sortDirection' => 'ASC|DESC',
    'sortFields' => '<string>',
    'status' => <integer>,
    'username' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'users' => [
        [
            'cell' => '<string>',
            'challengeFailures' => <integer>,
            'codeValidation' => true || false,
            'countryCode' => '<string>',
            'firstName' => '<string>',
            'inviteCode' => '<string>',
            'isAdmin' => true || false,
            'isInviteExpired' => true || false,
            'isUser' => true || false,
            'lastName' => '<string>',
            'otpEnabled' => true || false,
            'scimId' => '<string>',
            'securityGroups' => ['<string>', ...],
            'status' => <integer>,
            'suspended' => true || false,
            'type' => '<string>',
            'uname' => '<string>',
            'userId' => '<string>',
            'username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Get paginated list of users

$result = $client->listUsers([
    'maxResults' => 20,
    'networkId' => '12345678',
    'sortDirection' => 'ASC',
    'sortFields' => 'username',
]);

Result syntax:

[
    'nextToken' => 'v1:pagination:6ba7b810-9dad-11d1-80b4-00c04fd430c8',
    'users' => [
        [
            'type' => 'user',
            'firstName' => 'Alice',
            'isAdmin' => ,
            'lastName' => 'Anderson',
            'status' => 2,
            'suspended' => ,
            'username' => 'alice.anderson@example.com',
        ],
        [
            'type' => 'user',
            'firstName' => 'Bob',
            'isAdmin' => ,
            'lastName' => 'Brown',
            'status' => 2,
            'suspended' => ,
            'username' => 'bob.brown@example.com',
        ],
        [
            'type' => 'user',
            'firstName' => 'Charlie',
            'isAdmin' => 1,
            'lastName' => 'Chen',
            'status' => 2,
            'suspended' => ,
            'username' => 'charlie.chen@example.com',
        ],
    ],
]

Example 2: Filter by status and group

$result = $client->listUsers([
    'groupId' => 'BCTY8Qhe',
    'maxResults' => 10,
    'networkId' => '12345678',
    'status' => 1,
]);

Result syntax:

[
    'users' => [
        [
            'type' => 'user',
            'firstName' => 'David',
            'inviteCode' => 'INVITE789',
            'isAdmin' => ,
            'isInviteExpired' => ,
            'lastName' => 'Davis',
            'status' => 1,
            'suspended' => ,
            'username' => 'david.davis@example.com',
        ],
    ],
]

Example 3: Empty user list for network with no users

$result = $client->listUsers([
    'networkId' => '12345678',
]);

Result syntax:

[
    'users' => [
    ],
]

RegisterOidcConfig

$result = $client->registerOidcConfig([/* ... */]);
$promise = $client->registerOidcConfigAsync([/* ... */]);

Registers and saves an OpenID Connect (OIDC) configuration for a Wickr network, enabling Single Sign-On (SSO) authentication through an identity provider.

Parameter Syntax

$result = $client->registerOidcConfig([
    'companyId' => '<string>', // REQUIRED
    'customUsername' => '<string>',
    'extraAuthParams' => '<string>',
    'issuer' => '<string>', // REQUIRED
    'networkId' => '<string>', // REQUIRED
    'scopes' => '<string>', // REQUIRED
    'secret' => '<string>',
    'ssoTokenBufferMinutes' => <integer>,
    'userId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'applicationId' => <integer>,
    'applicationName' => '<string>',
    'caCertificate' => '<string>',
    'clientId' => '<string>',
    'clientSecret' => '<string>',
    'companyId' => '<string>',
    'customUsername' => '<string>',
    'extraAuthParams' => '<string>',
    'issuer' => '<string>',
    'redirectUrl' => '<string>',
    'scopes' => '<string>',
    'secret' => '<string>',
    'ssoTokenBufferMinutes' => <integer>,
    'userId' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Save OIDC config successfully

$result = $client->registerOidcConfig([
    'companyId' => 'us-east-1-company123',
    'issuer' => 'https://login.example.com',
    'networkId' => '12345678',
    'scopes' => 'openid profile email',
    'ssoTokenBufferMinutes' => 5,
    'userId' => 'email',
]);

Result syntax:

[
    'clientId' => 'client123',
    'companyId' => 'us-east-1-company123',
    'issuer' => 'https://login.example.com',
    'redirectUrl' => 'https://app.wickr.com/callback',
    'scopes' => 'openid profile email',
    'ssoTokenBufferMinutes' => 5,
    'userId' => 'email',
]

Example 2: Save OIDC config - missing company ID

$result = $client->registerOidcConfig([
    'companyId' => '',
    'issuer' => 'https://login.example.com',
    'networkId' => '12345678',
    'scopes' => 'openid profile email',
]);

Example 3: Save OIDC config - invalid company ID prefix

$result = $client->registerOidcConfig([
    'companyId' => 'invalid-company123',
    'issuer' => 'https://login.example.com',
    'networkId' => '12345678',
    'scopes' => 'openid profile email',
]);

RegisterOidcConfigTest

$result = $client->registerOidcConfigTest([/* ... */]);
$promise = $client->registerOidcConfigTestAsync([/* ... */]);

Tests an OpenID Connect (OIDC) configuration for a Wickr network by validating the connection to the identity provider and retrieving its supported capabilities.

Parameter Syntax

$result = $client->registerOidcConfigTest([
    'certificate' => '<string>',
    'extraAuthParams' => '<string>',
    'issuer' => '<string>', // REQUIRED
    'networkId' => '<string>', // REQUIRED
    'scopes' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'authorizationEndpoint' => '<string>',
    'endSessionEndpoint' => '<string>',
    'grantTypesSupported' => ['<string>', ...],
    'issuer' => '<string>',
    'logoutEndpoint' => '<string>',
    'microsoftMultiRefreshToken' => true || false,
    'responseTypesSupported' => ['<string>', ...],
    'revocationEndpoint' => '<string>',
    'scopesSupported' => ['<string>', ...],
    'tokenEndpoint' => '<string>',
    'tokenEndpointAuthMethodsSupported' => ['<string>', ...],
    'userinfoEndpoint' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Test OIDC config successfully

$result = $client->registerOidcConfigTest([
    'issuer' => 'https://login.example.com',
    'networkId' => '12345678',
    'scopes' => 'openid profile email',
]);

Result syntax:

[
    'authorizationEndpoint' => 'https://login.example.com/authorize',
    'issuer' => 'https://login.example.com',
    'tokenEndpoint' => 'https://login.example.com/oauth/token',
    'userinfoEndpoint' => 'https://login.example.com/userinfo',
]

Example 2: Test OIDC config - missing issuer

$result = $client->registerOidcConfigTest([
    'issuer' => '',
    'networkId' => '12345678',
    'scopes' => 'openid profile email',
]);

Example 3: Test OIDC config - invalid endpoint

$result = $client->registerOidcConfigTest([
    'issuer' => 'https://blocked-endpoint.com',
    'networkId' => '12345678',
    'scopes' => 'openid profile email',
]);

UpdateBot

$result = $client->updateBot([/* ... */]);
$promise = $client->updateBotAsync([/* ... */]);

Updates the properties of an existing bot in a Wickr network. This operation allows you to modify the bot's display name, security group, password, or suspension status.

Parameter Syntax

$result = $client->updateBot([
    'botId' => '<string>', // REQUIRED
    'challenge' => '<string>',
    'displayName' => '<string>',
    'groupId' => '<string>',
    'networkId' => '<string>', // REQUIRED
    'suspend' => true || false,
]);

Parameter Details

Result Syntax

[
    'message' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Update bot successfully

$result = $client->updateBot([
    'botId' => '98765',
    'displayName' => 'Updated Support Bot',
    'groupId' => 'support_group',
    'networkId' => '12345678',
]);

Result syntax:

[
    'message' => 'success',
]

Example 2: Update bot - bot not found

$result = $client->updateBot([
    'botId' => '99999',
    'displayName' => 'Updated Bot',
    'networkId' => '12345678',
]);

UpdateDataRetention

$result = $client->updateDataRetention([/* ... */]);
$promise = $client->updateDataRetentionAsync([/* ... */]);

Updates the data retention bot settings, allowing you to enable or disable the data retention service, or acknowledge the public key message.

Parameter Syntax

$result = $client->updateDataRetention([
    'actionType' => 'ENABLE|DISABLE|PUBKEY_MSG_ACK', // REQUIRED
    'networkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'message' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Update data retention - enable service

$result = $client->updateDataRetention([
    'actionType' => 'ENABLE',
    'networkId' => '12345678',
]);

Result syntax:

[
    'message' => 'data retention service enabled',
]

Example 2: Update data retention - disable service

$result = $client->updateDataRetention([
    'actionType' => 'DISABLE',
    'networkId' => '12345678',
]);

Result syntax:

[
    'message' => 'data retention service disabled',
]

Example 3: Update data retention - acknowledge pubkey message

$result = $client->updateDataRetention([
    'actionType' => 'PUBKEY_MSG_ACK',
    'networkId' => '12345678',
]);

Result syntax:

[
    'message' => 'pubkey message was acknowledged',
]

UpdateGuestUser

$result = $client->updateGuestUser([/* ... */]);
$promise = $client->updateGuestUserAsync([/* ... */]);

Updates the block status of a guest user in a Wickr network. This operation allows you to block or unblock a guest user from accessing the network.

Parameter Syntax

$result = $client->updateGuestUser([
    'block' => true || false, // REQUIRED
    'networkId' => '<string>', // REQUIRED
    'usernameHash' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'message' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Block a guest user

$result = $client->updateGuestUser([
    'block' => 1,
    'networkId' => '12345678',
    'usernameHash' => '032c36d5623781204592a69269ed9480d604484269c8a4c2d39528885a56470d',
]);

Result syntax:

[
    'message' => 'success',
]

Example 2: Unblock a guest user

$result = $client->updateGuestUser([
    'block' => ,
    'networkId' => '12345678',
    'usernameHash' => '032c36d5623781204592a69269ed9480d604484269c8a4c2d39528885a56470d',
]);

Result syntax:

[
    'message' => 'success',
]

Example 3: User already blocked error

$result = $client->updateGuestUser([
    'block' => 1,
    'networkId' => '12345678',
    'usernameHash' => '032c36d5623781204592a69269ed9480d604484269c8a4c2d39528885a56470d',
]);

UpdateNetwork

$result = $client->updateNetwork([/* ... */]);
$promise = $client->updateNetworkAsync([/* ... */]);

Updates the properties of an existing Wickr network, such as its name or encryption key configuration.

Parameter Syntax

$result = $client->updateNetwork([
    'clientToken' => '<string>',
    'encryptionKeyArn' => '<string>',
    'networkId' => '<string>', // REQUIRED
    'networkName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'message' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Update network name successfully

$result = $client->updateNetwork([
    'networkId' => '12345678',
    'networkName' => 'Updated Network Name',
]);

Result syntax:

[
    'message' => 'Network updated successfully',
]

Example 2: Update network - invalid name

$result = $client->updateNetwork([
    'networkId' => '12345678',
    'networkName' => 'This name is way too long for a network',
]);

Example 3: Update network - not found

$result = $client->updateNetwork([
    'networkId' => '99999999',
    'networkName' => 'New Name',
]);

UpdateNetworkSettings

$result = $client->updateNetworkSettings([/* ... */]);
$promise = $client->updateNetworkSettingsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateNetworkSettings([
    'networkId' => '<string>', // REQUIRED
    'settings' => [ // REQUIRED
        'dataRetention' => true || false,
        'enableClientMetrics' => true || false,
        'readReceiptConfig' => [
            'status' => 'DISABLED|ENABLED|FORCE_ENABLED',
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'settings' => [
        [
            'optionName' => '<string>',
            'type' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Update multiple network settings

$result = $client->updateNetworkSettings([
    'networkId' => '12345678',
    'settings' => [
        'dataRetention' => 1,
        'enableClientMetrics' => 1,
    ],
]);

Result syntax:

[
    'settings' => [
        [
            'type' => 'boolean',
            'value' => 'true',
            'optionName' => 'enableClientMetrics',
        ],
        [
            'type' => 'boolean',
            'value' => 'true',
            'optionName' => 'dataRetention',
        ],
    ],
]

Example 2: Update single boolean setting

$result = $client->updateNetworkSettings([
    'networkId' => '12345678',
    'settings' => [
        'enableClientMetrics' => ,
    ],
]);

Result syntax:

[
    'settings' => [
        [
            'type' => 'boolean',
            'value' => 'false',
            'optionName' => 'enableClientMetrics',
        ],
    ],
]

Example 3: Update client metrics settings

$result = $client->updateNetworkSettings([
    'networkId' => '12345678',
    'settings' => [
        'enableClientMetrics' => 1,
    ],
]);

Result syntax:

[
    'settings' => [
        [
            'type' => 'boolean',
            'value' => 'true',
            'optionName' => 'enableClientMetrics',
        ],
    ],
]

Example 4: Invalid setting name error

$result = $client->updateNetworkSettings([
    'networkId' => '12345678',
    'settings' => [
        'enableClientMetrics' => ,
    ],
]);

Example 5: Network not found error

$result = $client->updateNetworkSettings([
    'networkId' => '99999999',
    'settings' => [
        'enableClientMetrics' => 1,
    ],
]);

Example 6: Invalid value type error

$result = $client->updateNetworkSettings([
    'networkId' => '12345678',
    'settings' => [
        'dataRetention' => 1,
    ],
]);

UpdateSecurityGroup

$result = $client->updateSecurityGroup([/* ... */]);
$promise = $client->updateSecurityGroupAsync([/* ... */]);

Updates the properties of an existing security group in a Wickr network, such as its name or settings.

Parameter Syntax

$result = $client->updateSecurityGroup([
    'groupId' => '<string>', // REQUIRED
    'name' => '<string>',
    'networkId' => '<string>', // REQUIRED
    'securityGroupSettings' => [
        'alwaysReauthenticate' => true || false,
        'atakPackageValues' => ['<string>', ...],
        'calling' => [
            'canStart11Call' => true || false,
            'canVideoCall' => true || false,
            'forceTcpCall' => true || false,
        ],
        'checkForUpdates' => true || false,
        'enableAtak' => true || false,
        'enableCrashReports' => true || false,
        'enableFileDownload' => true || false,
        'enableGuestFederation' => true || false,
        'enableNotificationPreview' => true || false,
        'enableOpenAccessOption' => true || false,
        'enableRestrictedGlobalFederation' => true || false,
        'federationMode' => <integer>,
        'filesEnabled' => true || false,
        'forceDeviceLockout' => <integer>,
        'forceOpenAccess' => true || false,
        'forceReadReceipts' => true || false,
        'globalFederation' => true || false,
        'isAtoEnabled' => true || false,
        'isLinkPreviewEnabled' => true || false,
        'locationAllowMaps' => true || false,
        'locationEnabled' => true || false,
        'lockoutThreshold' => <integer>,
        'maxAutoDownloadSize' => <integer>,
        'maxBor' => <integer>,
        'maxTtl' => <integer>,
        'messageForwardingEnabled' => true || false,
        'passwordRequirements' => [
            'lowercase' => <integer>,
            'minLength' => <integer>,
            'numbers' => <integer>,
            'symbols' => <integer>,
            'uppercase' => <integer>,
        ],
        'permittedNetworks' => ['<string>', ...],
        'permittedWickrAwsNetworks' => [
            [
                'networkId' => '<string>', // REQUIRED
                'region' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'permittedWickrEnterpriseNetworks' => [
            [
                'domain' => '<string>', // REQUIRED
                'networkId' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'presenceEnabled' => true || false,
        'quickResponses' => ['<string>', ...],
        'showMasterRecoveryKey' => true || false,
        'shredder' => [
            'canProcessManually' => true || false,
            'intensity' => <integer>,
        ],
        'ssoMaxIdleMinutes' => <integer>,
    ],
]);

Parameter Details

Result Syntax

[
    'securityGroup' => [
        'activeDirectoryGuid' => '<string>',
        'activeMembers' => <integer>,
        'botMembers' => <integer>,
        'id' => '<string>',
        'isDefault' => true || false,
        'modified' => <integer>,
        'name' => '<string>',
        'securityGroupSettings' => [
            'alwaysReauthenticate' => true || false,
            'atakPackageValues' => ['<string>', ...],
            'calling' => [
                'canStart11Call' => true || false,
                'canVideoCall' => true || false,
                'forceTcpCall' => true || false,
            ],
            'checkForUpdates' => true || false,
            'enableAtak' => true || false,
            'enableCrashReports' => true || false,
            'enableFileDownload' => true || false,
            'enableGuestFederation' => true || false,
            'enableNotificationPreview' => true || false,
            'enableOpenAccessOption' => true || false,
            'enableRestrictedGlobalFederation' => true || false,
            'federationMode' => <integer>,
            'filesEnabled' => true || false,
            'forceDeviceLockout' => <integer>,
            'forceOpenAccess' => true || false,
            'forceReadReceipts' => true || false,
            'globalFederation' => true || false,
            'isAtoEnabled' => true || false,
            'isLinkPreviewEnabled' => true || false,
            'locationAllowMaps' => true || false,
            'locationEnabled' => true || false,
            'lockoutThreshold' => <integer>,
            'maxAutoDownloadSize' => <integer>,
            'maxBor' => <integer>,
            'maxTtl' => <integer>,
            'messageForwardingEnabled' => true || false,
            'passwordRequirements' => [
                'lowercase' => <integer>,
                'minLength' => <integer>,
                'numbers' => <integer>,
                'symbols' => <integer>,
                'uppercase' => <integer>,
            ],
            'permittedNetworks' => ['<string>', ...],
            'permittedWickrAwsNetworks' => [
                [
                    'networkId' => '<string>',
                    'region' => '<string>',
                ],
                // ...
            ],
            'permittedWickrEnterpriseNetworks' => [
                [
                    'domain' => '<string>',
                    'networkId' => '<string>',
                ],
                // ...
            ],
            'presenceEnabled' => true || false,
            'quickResponses' => ['<string>', ...],
            'showMasterRecoveryKey' => true || false,
            'shredder' => [
                'canProcessManually' => true || false,
                'intensity' => <integer>,
            ],
            'ssoMaxIdleMinutes' => <integer>,
        ],
    ],
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Update security group successfully

$result = $client->updateSecurityGroup([
    'name' => 'Updated Group Name',
    'groupId' => 'abc12345',
    'networkId' => '12345678',
    'securityGroupSettings' => [
        'lockoutThreshold' => 15,
    ],
]);

Result syntax:

[
    'securityGroup' => [
        'name' => 'Updated Group Name',
        'activeMembers' => 10,
        'botMembers' => 2,
        'id' => 'abc12345',
        'isDefault' => ,
        'modified' => 1638360000,
        'securityGroupSettings' => [
            'lockoutThreshold' => 15,
        ],
    ],
]

Example 2: Update security group - not found

$result = $client->updateSecurityGroup([
    'name' => 'New Name',
    'groupId' => 'invalid99',
    'networkId' => '12345678',
]);

UpdateUser

$result = $client->updateUser([/* ... */]);
$promise = $client->updateUserAsync([/* ... */]);

Updates the properties of an existing user in a Wickr network. This operation allows you to modify the user's name, password, security group membership, and invite code settings.

Parameter Syntax

$result = $client->updateUser([
    'networkId' => '<string>', // REQUIRED
    'userDetails' => [
        'codeValidation' => true || false,
        'firstName' => '<string>',
        'inviteCode' => '<string>',
        'inviteCodeTtl' => <integer>,
        'lastName' => '<string>',
        'securityGroupIds' => ['<string>', ...],
        'username' => '<string>',
    ],
    'userId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'codeValidation' => true || false,
    'firstName' => '<string>',
    'inviteCode' => '<string>',
    'inviteExpiration' => <integer>,
    'lastName' => '<string>',
    'middleName' => '<string>',
    'modified' => <integer>,
    'networkId' => '<string>',
    'securityGroupIds' => ['<string>', ...],
    'status' => <integer>,
    'suspended' => true || false,
    'userId' => '<string>',
]

Result Details

Errors

ValidationError:

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

BadRequestError:

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

ResourceNotFoundError:

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

ForbiddenError:

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

UnauthorizedError:

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

InternalServerError:

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.

RateLimitError:

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

Examples

Example 1: Update user information

$result = $client->updateUser([
    'networkId' => '12345678',
    'userDetails' => [
        'firstName' => 'Jonathan',
        'lastName' => 'Doe',
        'securityGroupIds' => [
            'BCTY8Qhe',
            'DEPT001',
        ],
        'username' => 'john.doe@example.com',
    ],
    'userId' => '12345',
]);

Result syntax:

[
    'firstName' => 'Jonathan',
    'lastName' => 'Doe',
    'modified' => 1705500000,
    'networkId' => '12345678',
    'securityGroupIds' => [
        'BCTY8Qhe',
        'DEPT001',
    ],
    'status' => 2,
    'suspended' => ,
    'userId' => '12345',
]

Example 2: Update user with invite code

$result = $client->updateUser([
    'networkId' => '12345678',
    'userDetails' => [
        'codeValidation' => 1,
        'firstName' => 'Jane',
        'inviteCode' => 'NEWINVITE789',
        'inviteCodeTtl' => 14,
        'lastName' => 'Smith',
        'username' => 'jane.smith@example.com',
    ],
    'userId' => '12345',
]);

Result syntax:

[
    'codeValidation' => 1,
    'firstName' => 'Jane',
    'inviteCode' => 'NEWINVITE789',
    'inviteExpiration' => 1706709600,
    'lastName' => 'Smith',
    'modified' => 1705500100,
    'networkId' => '12345678',
    'status' => 2,
    'suspended' => ,
    'userId' => '12345',
]

Example 3: User not found error

$result = $client->updateUser([
    'networkId' => '12345678',
    'userDetails' => [
        'firstName' => 'Non',
        'lastName' => 'Existent',
        'username' => 'nonexistent@example.com',
    ],
    'userId' => '99999',
]);

Example 4: Invalid userId error

$result = $client->updateUser([
    'networkId' => '12345678',
    'userDetails' => [
        'firstName' => 'John',
        'lastName' => 'Doe',
        'securityGroupIds' => [
            'BCTY8Qhe',
        ],
        'username' => 'john.doe@example.com',
    ],
    'userId' => '99999',
]);