Welcome to the Amazon Web Services Wickr API Reference.
The Amazon Web Services Wickr application programming interface (API) is designed for administrators to perform key tasks, such as creating and managing Amazon Web Services Wickr, networks, users, security groups, bots and more. This guide provides detailed information about the Amazon Web Services Wickr API, including operations, types, inputs and outputs, and error codes. You can use an Amazon Web Services SDK, the Amazon Web Services Command Line Interface (Amazon Web Services CLI, or the REST API to make API calls for Amazon Web Services Wickr.
Using Amazon Web Services SDK
The SDK clients authenticate your requests by using access keys that you provide. For more information, see Authentication and access using Amazon Web Services SDKs and tools in the Amazon Web Services SDKs and Tools Reference Guide.
Using Amazon Web Services CLI
Use your access keys with the Amazon Web Services CLI to make API calls. For more information about setting up the Amazon Web Services CLI, see Getting started with the Amazon Web Services CLI in the Amazon Web Services Command Line Interface User Guide for Version 2.
Using REST APIs
If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Web Services Wickr supports Signature Version 4. For more information, see Amazon Web Services Signature Version 4 for API requests in the Amazon Web Services Identity and Access Management User Guide.
Access and permissions to the APIs can be controlled by Amazon Web Services Identity and Access Management. The managed policy Amazon Web ServicesWickrFullAccess grants full administrative permission to the Amazon Web Services Wickr service APIs. For more information on restricting access to specific operations, see Identity and access management for Amazon Web Services Wickr in the Amazon Web Services Wickr Administration Guide.
Types of Errors:
The Amazon Web Services Wickr APIs provide an HTTP interface. HTTP defines ranges of HTTP Status Codes for different types of error responses.
Client errors are indicated by HTTP Status Code class of 4xx
Service errors are indicated by HTTP Status Code class of 5xx
In this reference guide, the documentation for each API has an Errors section that includes a brief discussion about HTTP status codes. We recommend looking there as part of your investigation when you get an error.
", "operations": { "BatchCreateUser": "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.
codeValidation, inviteCode, and inviteCodeTtl are restricted to networks under preview only.
Deletes multiple users from a specified Wickr network. This operation permanently removes user accounts and their associated data from the network.
", "BatchLookupUserUname": "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.
", "BatchReinviteUser": "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.
", "BatchResetDevicesForUser": "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.
", "BatchToggleUserSuspendStatus": "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.
", "CreateBot": "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.
", "CreateDataRetentionBot": "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.
", "CreateDataRetentionBotChallenge": "Creates a new challenge password for the data retention bot. This password is used for authentication when the bot connects to the network.
", "CreateNetwork": "Creates a new Wickr network with specified access level and configuration. This operation provisions a new communication network for your organization.
", "CreateSecurityGroup": "Creates a new security group in a Wickr network. Security groups allow you to organize users and control their permissions, features, and security settings.
", "DeleteBot": "Deletes a bot from a specified Wickr network. This operation permanently removes the bot account and its associated data from the network.
", "DeleteDataRetentionBot": "Deletes the data retention bot from a Wickr network. This operation permanently removes the bot and all its associated data from the database.
", "DeleteNetwork": "Deletes a Wickr network and all its associated resources, including users, bots, security groups, and settings. This operation is permanent and cannot be undone.
", "DeleteSecurityGroup": "Deletes a security group from a Wickr network. This operation cannot be performed on the default security group.
", "GetBot": "Retrieves detailed information about a specific bot in a Wickr network, including its status, group membership, and authentication details.
", "GetBotsCount": "Retrieves the count of bots in a Wickr network, categorized by their status (pending, active, and total).
", "GetDataRetentionBot": "Retrieves information about the data retention bot in a Wickr network, including its status and whether the data retention service is enabled.
", "GetGuestUserHistoryCount": "Retrieves historical guest user count data for a Wickr network, showing the number of guest users per billing period over the past 90 days.
", "GetNetwork": "Retrieves detailed information about a specific Wickr network, including its configuration, access level, and status.
", "GetNetworkSettings": "Retrieves all network-level settings for a Wickr network, including client metrics, data retention, and other configuration options.
", "GetOidcInfo": "Retrieves the OpenID Connect (OIDC) configuration for a Wickr network, including SSO settings and optional token information if access token parameters are provided.
", "GetSecurityGroup": "Retrieves detailed information about a specific security group in a Wickr network, including its settings, member counts, and configuration.
", "GetUser": "Retrieves detailed information about a specific user in a Wickr network, including their profile, status, and activity history.
", "GetUsersCount": "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.
", "ListBlockedGuestUsers": "Retrieves a paginated list of guest users who have been blocked from a Wickr network. You can filter and sort the results.
", "ListBots": "Retrieves a paginated list of bots in a specified Wickr network. You can filter and sort the results based on various criteria.
", "ListDevicesForUser": "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.
", "ListGuestUsers": "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.
", "ListNetworks": "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.
", "ListSecurityGroupUsers": "Retrieves a paginated list of users who belong to a specific security group in a Wickr network.
", "ListSecurityGroups": "Retrieves a paginated list of security groups in a specified Wickr network. You can sort the results by various criteria.
", "ListUsers": "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.
", "RegisterOidcConfig": "Registers and saves an OpenID Connect (OIDC) configuration for a Wickr network, enabling Single Sign-On (SSO) authentication through an identity provider.
", "RegisterOidcConfigTest": "Tests an OpenID Connect (OIDC) configuration for a Wickr network by validating the connection to the identity provider and retrieving its supported capabilities.
", "UpdateBot": "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.
", "UpdateDataRetention": "Updates the data retention bot settings, allowing you to enable or disable the data retention service, or acknowledge the public key message.
", "UpdateGuestUser": "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.
", "UpdateNetwork": "Updates the properties of an existing Wickr network, such as its name or encryption key configuration.
", "UpdateNetworkSettings": "Updates network-level settings for a Wickr network. You can modify settings such as client metrics, data retention, and other network-wide options.
", "UpdateSecurityGroup": "Updates the properties of an existing security group in a Wickr network, such as its name or settings.
", "UpdateUser": "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.
codeValidation, inviteCode, and inviteCodeTtl are restricted to networks under preview only.
The access level for the network. Valid values are STANDARD or PREMIUM, which determine the features and capabilities available to network members.
", "GetNetworkResponse$accessLevel": "The access level of the network (STANDARD or PREMIUM), which determines available features and capabilities.
", "Network$accessLevel": "The access level of the network (STANDARD or PREMIUM), which determines available features and capabilities.
" } }, "AppIds": { "base": null, "refs": { "BatchResetDevicesForUserRequest$appIds": "A list of application IDs identifying the specific devices to be reset for the user. Maximum 50 devices per batch request.
" } }, "BadRequestError": { "base": "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.
", "refs": {} }, "BasicDeviceObject": { "base": "Represents a device where a user has logged into Wickr, containing information about the device's type, status, and login history.
", "refs": { "Devices$member": null } }, "BatchCreateUserRequest": { "base": null, "refs": {} }, "BatchCreateUserRequestItem": { "base": "Contains the details for a single user to be created in a batch user creation request.
A user can only be assigned to a single security group. Attempting to add a user to multiple security groups is not supported and will result in an error.
codeValidation, inviteCode, and inviteCodeTtl are restricted to networks under preview only.
A list of user objects containing the details for each user to be created, including username, name, security groups, and optional invite codes. Maximum 50 users per batch request.
" } }, "BatchCreateUserResponse": { "base": null, "refs": {} }, "BatchDeleteUserRequest": { "base": null, "refs": {} }, "BatchDeleteUserResponse": { "base": null, "refs": {} }, "BatchDeviceErrorResponseItem": { "base": "Contains error information for a device operation that failed in a batch device request.
", "refs": { "BatchDeviceErrorResponseItems$member": null } }, "BatchDeviceErrorResponseItems": { "base": null, "refs": { "BatchResetDevicesForUserResponse$failed": "A list of device reset attempts that failed, including error details explaining why each device could not be reset.
" } }, "BatchDeviceSuccessResponseItem": { "base": "Contains information about a device that was successfully processed in a batch device operation.
", "refs": { "BatchDeviceSuccessResponseItems$member": null } }, "BatchDeviceSuccessResponseItems": { "base": null, "refs": { "BatchResetDevicesForUserResponse$successful": "A list of application IDs that were successfully reset.
" } }, "BatchLookupUserUnameRequest": { "base": null, "refs": {} }, "BatchLookupUserUnameResponse": { "base": null, "refs": {} }, "BatchReinviteUserRequest": { "base": null, "refs": {} }, "BatchReinviteUserResponse": { "base": null, "refs": {} }, "BatchResetDevicesForUserRequest": { "base": null, "refs": {} }, "BatchResetDevicesForUserResponse": { "base": null, "refs": {} }, "BatchToggleUserSuspendStatusRequest": { "base": null, "refs": {} }, "BatchToggleUserSuspendStatusResponse": { "base": null, "refs": {} }, "BatchUnameErrorResponseItem": { "base": "Contains error information for a username hash lookup that failed in a batch uname lookup request.
", "refs": { "BatchUnameErrorResponseItems$member": null } }, "BatchUnameErrorResponseItems": { "base": null, "refs": { "BatchLookupUserUnameResponse$failed": "A list of username hash lookup attempts that failed, including error details explaining why each lookup failed.
" } }, "BatchUnameSuccessResponseItem": { "base": "Contains information about a username hash that was successfully resolved in a batch uname lookup operation.
", "refs": { "BatchUnameSuccessResponseItems$member": null } }, "BatchUnameSuccessResponseItems": { "base": null, "refs": { "BatchLookupUserUnameResponse$successful": "A list of successfully resolved username hashes with their corresponding email addresses.
" } }, "BatchUserErrorResponseItem": { "base": "Contains error information for a user operation that failed in a batch user request.
", "refs": { "BatchUserErrorResponseItems$member": null } }, "BatchUserErrorResponseItems": { "base": null, "refs": { "BatchCreateUserResponse$failed": "A list of user creation attempts that failed, including error details explaining why each user could not be created.
", "BatchDeleteUserResponse$failed": "A list of user deletion attempts that failed, including error details explaining why each user could not be deleted.
", "BatchReinviteUserResponse$failed": "A list of reinvitation attempts that failed, including error details explaining why each user could not be reinvited.
", "BatchToggleUserSuspendStatusResponse$failed": "A list of suspend status toggle attempts that failed, including error details explaining why each user's status could not be changed.
" } }, "BatchUserSuccessResponseItem": { "base": "Contains information about a user that was successfully processed in a batch user operation.
", "refs": { "BatchUserSuccessResponseItems$member": null } }, "BatchUserSuccessResponseItems": { "base": null, "refs": { "BatchDeleteUserResponse$successful": "A list of user IDs that were successfully deleted from the network.
", "BatchReinviteUserResponse$successful": "A list of user IDs that were successfully reinvited.
", "BatchToggleUserSuspendStatusResponse$successful": "A list of user IDs whose suspend status was successfully toggled.
" } }, "BlockedGuestUser": { "base": "Represents a guest user who has been blocked from accessing a Wickr network.
", "refs": { "BlockedGuestUserList$member": null } }, "BlockedGuestUserList": { "base": null, "refs": { "ListBlockedGuestUsersResponse$blocklist": "A list of blocked guest user objects within the current page.
" } }, "Boolean": { "base": null, "refs": { "BasicDeviceObject$suspend": "Indicates whether the device is suspended.
", "BatchCreateUserRequestItem$codeValidation": "Indicates whether the user can be verified through a custom invite code.
", "BatchToggleUserSuspendStatusRequest$suspend": "A boolean value indicating whether to suspend (true) or unsuspend (false) the specified users.
", "Bot$hasChallenge": "Indicates whether the bot has a password set.
", "Bot$suspended": "Indicates whether the bot is currently suspended.
", "CallingSettings$canStart11Call": "Specifies whether users can start one-to-one calls.
", "CallingSettings$canVideoCall": "Specifies whether users can make video calls (as opposed to audio-only calls). Valid only when audio call(canStart11Call) is enabled.
", "CallingSettings$forceTcpCall": "When enabled, forces all calls to use TCP protocol instead of UDP for network traversal.
", "CreateNetworkRequest$enablePremiumFreeTrial": "Specifies whether to enable a premium free trial for the network. It is optional and has a default value as false. When set to true, the network starts with premium features for a limited trial period.
", "GetBotResponse$hasChallenge": "Indicates whether the bot has a password set.
", "GetBotResponse$suspended": "Indicates whether the bot is currently suspended.
", "GetDataRetentionBotResponse$botExists": "Indicates whether a data retention bot exists in the network.
", "GetDataRetentionBotResponse$isBotActive": "Indicates whether the data retention bot is active and operational.
", "GetDataRetentionBotResponse$isDataRetentionBotRegistered": "Indicates whether the data retention bot has been registered with the network.
", "GetDataRetentionBotResponse$isDataRetentionServiceEnabled": "Indicates whether the data retention service is enabled for the network.
", "GetDataRetentionBotResponse$isPubkeyMsgAcked": "Indicates whether the public key message has been acknowledged by the bot.
", "GetUserResponse$isAdmin": "Indicates whether the user has administrator privileges in the network.
", "GetUserResponse$suspended": "Indicates whether the user is currently suspended.
", "NetworkSettings$enableClientMetrics": "Allows Wickr clients to send anonymized performance and usage metrics to the Wickr backend server for service improvement and troubleshooting.
", "NetworkSettings$dataRetention": "Indicates whether the data retention feature is enabled for the network. When true, messages are captured by the data retention bot for compliance and archiving purposes.
", "RegisterOidcConfigTestResponse$microsoftMultiRefreshToken": "Indicates whether the provider supports Microsoft multi-refresh tokens.
", "SecurityGroup$isDefault": "Indicates whether this is the default security group for the network. Each network has only one default group.
", "SecurityGroupSettings$alwaysReauthenticate": "Requires users to reauthenticate every time they return to the application, providing an additional layer of security.
", "SecurityGroupSettings$checkForUpdates": "Enables automatic checking for Wickr client updates to ensure users stay current with the latest version.
", "SecurityGroupSettings$enableAtak": "Enables ATAK (Android Team Awareness Kit) integration for tactical communication and situational awareness.
", "SecurityGroupSettings$enableCrashReports": "Allow users to report crashes.
", "SecurityGroupSettings$enableFileDownload": "Specifies whether users can download files from messages to their devices.
", "SecurityGroupSettings$enableGuestFederation": "Allows users to communicate with guest users from other Wickr networks and federated external networks.
", "SecurityGroupSettings$enableNotificationPreview": "Enables message preview text in push notifications, allowing users to see message content before opening the app.
", "SecurityGroupSettings$enableOpenAccessOption": "Allow users to avoid censorship when they are geo-blocked or have network limitations.
", "SecurityGroupSettings$enableRestrictedGlobalFederation": "Enables restricted global federation, limiting external communication to only specified permitted networks.
", "SecurityGroupSettings$filesEnabled": "Enables file sharing capabilities, allowing users to send and receive files in conversations.
", "SecurityGroupSettings$forceOpenAccess": "Automatically enable and enforce Wickr open access on all devices. Valid only if enableOpenAccessOption settings is enabled.
", "SecurityGroupSettings$forceReadReceipts": "Allow user approved bots to read messages in rooms without using a slash command.
", "SecurityGroupSettings$globalFederation": "Allows users to communicate with users on other Wickr instances (Wickr Enterprise) outside the current network.
", "SecurityGroupSettings$isAtoEnabled": "Enforces a two-factor authentication when a user adds a new device to their account.
", "SecurityGroupSettings$isLinkPreviewEnabled": "Enables automatic preview of links shared in messages, showing webpage thumbnails and descriptions.
", "SecurityGroupSettings$locationAllowMaps": "Allows map integration in location sharing, enabling users to view shared locations on interactive maps. Only allowed when location setting is enabled.
", "SecurityGroupSettings$locationEnabled": "Enables location sharing features, allowing users to share their current location with others.
", "SecurityGroupSettings$messageForwardingEnabled": "Enables message forwarding, allowing users to forward messages from one conversation to another.
", "SecurityGroupSettings$presenceEnabled": "Enables presence indicators that show whether users are online, away, or offline.
", "SecurityGroupSettings$showMasterRecoveryKey": "Users will get a master recovery key that can be used to securely sign in to their Wickr account without having access to their primary device for authentication. Available in SSO enabled network.
", "SecurityGroupSettingsRequest$enableGuestFederation": "Guest users let you work with people outside your organization that only have limited access to Wickr. Only valid when federationMode is set to Global.
", "SecurityGroupSettingsRequest$globalFederation": "Allow users to securely federate with all Amazon Web Services Wickr networks and Amazon Web Services Enterprise networks.
", "SecurityGroupSettingsRequest$enableRestrictedGlobalFederation": "Enables restricted global federation to limit communication to specific permitted networks only. Requires globalFederation to be enabled.
", "ShredderSettings$canProcessManually": "Specifies whether users can manually trigger the shredder to delete content.
", "UpdateBotRequest$suspend": "Set to true to suspend the bot or false to unsuspend it. Omit this field for standard updates that don't affect suspension status.
", "UpdateGuestUserRequest$block": "Set to true to block the guest user or false to unblock them.
", "UpdateUserDetails$codeValidation": "Indicates whether the user can be verified through a custom invite code.
", "UpdateUserResponse$suspended": "Indicates whether the user is suspended after the update.
", "UpdateUserResponse$codeValidation": "Indicates whether the user can be verified through a custom invite code.
", "User$isAdmin": "Indicates whether the user has administrator privileges in the network.
", "User$suspended": "Indicates whether the user is currently suspended and unable to access the network.
", "User$otpEnabled": "Indicates whether one-time password (OTP) authentication is enabled for the user.
", "User$isInviteExpired": "Indicates whether the user's email invitation code has expired, applicable to cloud deployments.
", "User$isUser": "Indicates whether this account is a user (as opposed to a bot or other account type).
", "User$codeValidation": "Indicates whether the user can be verified through a custom invite code.
" } }, "Bot": { "base": "Represents a bot account in a Wickr network with all its informational fields.
", "refs": { "Bots$member": null } }, "BotId": { "base": null, "refs": { "CreateBotResponse$botId": "The unique identifier assigned to the newly created bot.
", "DeleteBotRequest$botId": "The unique identifier of the bot to be deleted.
", "GetBotRequest$botId": "The unique identifier of the bot to retrieve.
", "UpdateBotRequest$botId": "The unique identifier of the bot to update.
" } }, "BotStatus": { "base": null, "refs": { "Bot$status": "The current status of the bot (1 for pending, 2 for active).
", "GetBotResponse$status": "The current status of the bot (1 for pending, 2 for active).
", "ListBotsRequest$status": "Filter results to only include bots with this status (1 for pending, 2 for active).
" } }, "Bots": { "base": null, "refs": { "ListBotsResponse$bots": "A list of bot objects matching the specified filters and within the current page.
" } }, "CallingSettings": { "base": "Defines the calling feature permissions and settings for users in a security group, controlling what types of calls users can initiate and participate in.
", "refs": { "SecurityGroupSettings$calling": "The calling feature permissions and settings that control what types of calls users can initiate and participate in.
" } }, "ClientToken": { "base": null, "refs": { "BatchCreateUserRequest$clientToken": "A unique identifier for this request to ensure idempotency. If you retry a request with the same client token, the service will return the same response without creating duplicate users.
", "BatchDeleteUserRequest$clientToken": "A unique identifier for this request to ensure idempotency. If you retry a request with the same client token, the service will return the same response without attempting to delete users again.
", "BatchLookupUserUnameRequest$clientToken": "A unique identifier for this request to ensure idempotency.
", "BatchReinviteUserRequest$clientToken": "A unique identifier for this request to ensure idempotency.
", "BatchResetDevicesForUserRequest$clientToken": "A unique identifier for this request to ensure idempotency.
", "BatchToggleUserSuspendStatusRequest$clientToken": "A unique identifier for this request to ensure idempotency.
", "CreateSecurityGroupRequest$clientToken": "A unique identifier for this request to ensure idempotency.
", "DeleteNetworkRequest$clientToken": "A unique identifier for this request to ensure idempotency. If you retry a request with the same client token, the service will return the same response without attempting to delete the network again.
", "UpdateNetworkRequest$clientToken": "A unique identifier for this request to ensure idempotency.
" } }, "CreateBotRequest": { "base": null, "refs": {} }, "CreateBotResponse": { "base": null, "refs": {} }, "CreateDataRetentionBotChallengeRequest": { "base": null, "refs": {} }, "CreateDataRetentionBotChallengeResponse": { "base": null, "refs": {} }, "CreateDataRetentionBotRequest": { "base": null, "refs": {} }, "CreateDataRetentionBotResponse": { "base": null, "refs": {} }, "CreateNetworkRequest": { "base": null, "refs": {} }, "CreateNetworkResponse": { "base": null, "refs": {} }, "CreateSecurityGroupRequest": { "base": null, "refs": {} }, "CreateSecurityGroupResponse": { "base": null, "refs": {} }, "DataRetentionActionType": { "base": null, "refs": { "UpdateDataRetentionRequest$actionType": "The action to perform. Valid values are 'ENABLE' (to enable the data retention service), 'DISABLE' (to disable the service), or 'PUBKEY_MSG_ACK' (to acknowledge the public key message).
" } }, "DeleteBotRequest": { "base": null, "refs": {} }, "DeleteBotResponse": { "base": null, "refs": {} }, "DeleteDataRetentionBotRequest": { "base": null, "refs": {} }, "DeleteDataRetentionBotResponse": { "base": null, "refs": {} }, "DeleteNetworkRequest": { "base": null, "refs": {} }, "DeleteNetworkResponse": { "base": null, "refs": {} }, "DeleteSecurityGroupRequest": { "base": null, "refs": {} }, "DeleteSecurityGroupResponse": { "base": null, "refs": {} }, "Devices": { "base": null, "refs": { "ListDevicesForUserResponse$devices": "A list of device objects associated with the user within the current page.
" } }, "ErrorDetail": { "base": "Contains detailed error information explaining why an operation failed, including which field caused the error and the reason for the failure.
", "refs": { "ErrorDetailList$member": null } }, "ErrorDetailList": { "base": null, "refs": { "ValidationError$reasons": "A list of validation error details, where each item identifies a specific field that failed validation and explains the reason for the failure.
" } }, "ForbiddenError": { "base": "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.
", "refs": {} }, "GenericString": { "base": null, "refs": { "AppIds$member": null, "BadRequestError$message": "A detailed message explaining what was wrong with the request and how to correct it.
", "BasicDeviceObject$appId": "The unique application ID for the Wickr app on this device.
", "BasicDeviceObject$created": "The timestamp when the device first appeared in the Wickr database.
", "BasicDeviceObject$lastLogin": "The timestamp when the device last successfully logged into Wickr. This is also used to determine SSO idle time.
", "BasicDeviceObject$statusText": "The current status of the device, either 'Active' or 'Reset' depending on whether the device is currently active or has been marked for reset.
", "BasicDeviceObject$type": "The operating system of the device (e.g., 'MacOSX', 'Windows', 'iOS', 'Android').
", "BatchCreateUserRequestItem$username": "The email address or username for the user. Must be unique within the network.
", "BatchCreateUserRequestItem$inviteCode": "A custom invite code for the user. If not provided, one will be generated automatically.
", "BatchCreateUserResponse$message": "A message indicating the overall result of the batch operation.
", "BatchDeleteUserResponse$message": "A message indicating the overall result of the batch deletion operation.
", "BatchDeviceErrorResponseItem$field": "The field that caused the error.
", "BatchDeviceErrorResponseItem$reason": "A description of why the device operation failed.
", "BatchDeviceErrorResponseItem$appId": "The application ID of the device that failed to be processed.
", "BatchDeviceSuccessResponseItem$appId": "The application ID of the device that was successfully processed.
", "BatchLookupUserUnameResponse$message": "A message indicating the overall result of the batch lookup operation.
", "BatchReinviteUserResponse$message": "A message indicating the overall result of the batch reinvitation operation.
", "BatchResetDevicesForUserResponse$message": "A message indicating the overall result of the batch device reset operation.
", "BatchToggleUserSuspendStatusResponse$message": "A message indicating the overall result of the batch suspend status toggle operation.
", "BatchUnameErrorResponseItem$field": "The field that caused the error.
", "BatchUnameErrorResponseItem$reason": "A description of why the username hash lookup failed.
", "BatchUnameSuccessResponseItem$username": "The email address or username corresponding to the username hash.
", "BatchUserErrorResponseItem$field": "The field that caused the error.
", "BatchUserErrorResponseItem$reason": "A description of why the user operation failed.
", "BlockedGuestUser$username": "The username of the blocked guest user.
", "BlockedGuestUser$admin": "The username of the administrator who blocked this guest user.
", "BlockedGuestUser$modified": "The timestamp when the guest user was blocked or last modified.
", "BlockedGuestUser$usernameHash": "The unique username hash identifier for the blocked guest user.
", "Bot$botId": "The unique identifier of the bot.
", "Bot$displayName": "The display name of the bot that is visible to users.
", "Bot$username": "The username of the bot.
", "Bot$uname": "The unique username hash identifier for the bot.
", "Bot$pubkey": "The public key of the bot used for encryption.
", "Bot$groupId": "The ID of the security group to which the bot belongs.
", "Bot$lastLogin": "The timestamp of the bot's last login.
", "CreateBotRequest$username": "The username for the bot. This must be unique within the network and follow the network's naming conventions.
", "CreateBotRequest$displayName": "The display name for the bot that will be visible to users in the network.
", "CreateBotRequest$groupId": "The ID of the security group to which the bot will be assigned.
", "CreateBotResponse$message": "A message indicating the result of the bot creation operation.
", "CreateBotResponse$username": "The username of the newly created bot.
", "CreateBotResponse$displayName": "The display name of the newly created bot.
", "CreateBotResponse$groupId": "The ID of the security group to which the bot was assigned.
", "CreateDataRetentionBotResponse$message": "A message indicating that the data retention bot was successfully provisioned.
", "CreateNetworkRequest$networkName": "The name for the new network. Must be between 1 and 20 characters.
", "CreateNetworkRequest$encryptionKeyArn": "The ARN of the Amazon Web Services KMS customer managed key to use for encrypting sensitive data in the network.
", "CreateNetworkResponse$networkName": "The name of the newly created network.
", "CreateNetworkResponse$encryptionKeyArn": "The ARN of the KMS key being used to encrypt sensitive data in the network.
", "CreateSecurityGroupRequest$name": "The name for the new security group.
", "DeleteBotResponse$message": "A message indicating the result of the bot deletion operation.
", "DeleteDataRetentionBotResponse$message": "A message indicating that the data retention bot and all associated data were successfully deleted.
", "DeleteNetworkResponse$message": "A message indicating that the network deletion has been initiated successfully.
", "DeleteSecurityGroupRequest$groupId": "The unique identifier of the security group to delete.
", "DeleteSecurityGroupResponse$message": "A message indicating the result of the security group deletion operation.
", "DeleteSecurityGroupResponse$groupId": "The ID of the security group that was deleted.
", "ErrorDetail$field": "The name of the field that contains an error or warning.
", "ErrorDetail$reason": "A detailed description of the error or warning.
", "ForbiddenError$message": "A message explaining why access was denied and what permissions are required.
", "GetBotResponse$botId": "The unique identifier of the bot.
", "GetBotResponse$displayName": "The display name of the bot that is visible to users.
", "GetBotResponse$username": "The username of the bot.
", "GetBotResponse$uname": "The unique username hash identifier for the bot.
", "GetBotResponse$pubkey": "The public key of the bot used for encryption.
", "GetBotResponse$groupId": "The ID of the security group to which the bot belongs.
", "GetBotResponse$lastLogin": "The timestamp of the bot's last login.
", "GetDataRetentionBotResponse$botName": "The name of the data retention bot.
", "GetNetworkResponse$networkName": "The name of the network.
", "GetNetworkResponse$awsAccountId": "The Amazon Web Services account ID that owns the network.
", "GetNetworkResponse$networkArn": "The Amazon Resource Name (ARN) of the network.
", "GetNetworkResponse$freeTrialExpiration": "The expiration date and time for the network's free trial period, if applicable.
", "GetNetworkResponse$encryptionKeyArn": "The ARN of the Amazon Web Services KMS customer managed key used for encrypting sensitive data in the network.
", "GetOidcInfoRequest$clientId": "The OAuth client ID for retrieving access tokens (optional).
", "GetOidcInfoRequest$code": "The authorization code for retrieving access tokens (optional).
", "GetOidcInfoRequest$grantType": "The OAuth grant type for retrieving access tokens (optional).
", "GetOidcInfoRequest$redirectUri": "The redirect URI for the OAuth flow (optional).
", "GetOidcInfoRequest$url": "The URL for the OIDC provider (optional).
", "GetOidcInfoRequest$codeVerifier": "The PKCE code verifier for enhanced security in the OAuth flow (optional).
", "GetOidcInfoRequest$certificate": "The CA certificate for secure communication with the OIDC provider (optional).
", "GetSecurityGroupRequest$groupId": "The unique identifier of the security group to retrieve.
", "GetUserResponse$username": "The email address or username of the user.
", "GuestUser$billingPeriod": "The billing period when this guest user accessed the network (e.g., '2024-01').
", "GuestUser$username": "The username of the guest user.
", "GuestUser$usernameHash": "The unique username hash identifier for the guest user.
", "GuestUserHistoryCount$month": "The month and billing period in YYYY_MM format (e.g., '2024_01').
", "GuestUserHistoryCount$count": "The number of guest users who have communicated with your Wickr network during this billing period.
", "InternalServerError$message": "A message describing the internal server error that occurred.
", "ListBlockedGuestUsersRequest$sortFields": "The field to sort blocked guest users by. Accepted values include 'username', 'admin', and 'modified'.
", "ListBlockedGuestUsersRequest$username": "Filter results to only include blocked guest users with usernames matching this value.
", "ListBlockedGuestUsersRequest$admin": "Filter results to only include blocked guest users that were blocked by this administrator.
", "ListBlockedGuestUsersRequest$nextToken": "The token for retrieving the next page of results. This is returned from a previous request when there are more results available.
", "ListBlockedGuestUsersResponse$nextToken": "The token to use for retrieving the next page of results. If this is not present, there are no more results.
", "ListBotsRequest$nextToken": "The token for retrieving the next page of results. This is returned from a previous request when there are more results available.
", "ListBotsRequest$sortFields": "The fields to sort bots by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', 'displayName', 'status', and 'groupId'.
", "ListBotsRequest$displayName": "Filter results to only include bots with display names matching this value.
", "ListBotsRequest$username": "Filter results to only include bots with usernames matching this value.
", "ListBotsRequest$groupId": "Filter results to only include bots belonging to this security group.
", "ListBotsResponse$nextToken": "The token to use for retrieving the next page of results. If this is not present, there are no more results.
", "ListDevicesForUserRequest$nextToken": "The token for retrieving the next page of results. This is returned from a previous request when there are more results available.
", "ListDevicesForUserRequest$sortFields": "The fields to sort devices by. Multiple fields can be specified by separating them with '+'. Accepted values include 'lastlogin', 'type', 'suspend', and 'created'.
", "ListDevicesForUserResponse$nextToken": "The token to use for retrieving the next page of results. If this is not present, there are no more results.
", "ListGuestUsersRequest$sortFields": "The field to sort guest users by. Accepted values include 'username' and 'billingPeriod'.
", "ListGuestUsersRequest$username": "Filter results to only include guest users with usernames matching this value.
", "ListGuestUsersRequest$billingPeriod": "Filter results to only include guest users from this billing period (e.g., '2024-01').
", "ListGuestUsersRequest$nextToken": "The token for retrieving the next page of results. This is returned from a previous request when there are more results available.
", "ListGuestUsersResponse$nextToken": "The token to use for retrieving the next page of results. If this is not present, there are no more results.
", "ListNetworksRequest$sortFields": "The field to sort networks by. Accepted values are 'networkId' and 'networkName'. Default is 'networkId'.
", "ListNetworksRequest$nextToken": "The token for retrieving the next page of results. This is returned from a previous request when there are more results available.
", "ListNetworksResponse$nextToken": "The token to use for retrieving the next page of results. If this is not present, there are no more results.
", "ListSecurityGroupUsersRequest$groupId": "The unique identifier of the security group whose users will be listed.
", "ListSecurityGroupUsersRequest$nextToken": "The token for retrieving the next page of results. This is returned from a previous request when there are more results available.
", "ListSecurityGroupUsersRequest$sortFields": "The field to sort users by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', and 'lastName'.
", "ListSecurityGroupUsersResponse$nextToken": "The token to use for retrieving the next page of results. If this is not present, there are no more results.
", "ListSecurityGroupsRequest$nextToken": "The token for retrieving the next page of results. This is returned from a previous request when there are more results available.
", "ListSecurityGroupsRequest$sortFields": "The field to sort security groups by. Accepted values include 'id' and 'name'.
", "ListSecurityGroupsResponse$nextToken": "The token to use for retrieving the next page of results. If this is not present, there are no more results.
", "ListUsersRequest$nextToken": "The token for retrieving the next page of results. This is returned from a previous request when there are more results available.
", "ListUsersRequest$sortFields": "The fields to sort users by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', 'lastName', 'status', and 'groupId'.
", "ListUsersRequest$username": "Filter results to only include users with usernames matching this value.
", "ListUsersRequest$groupId": "Filter results to only include users belonging to this security group.
", "ListUsersResponse$nextToken": "The token to use for retrieving the next page of results. If this is not present, there are no more results.
", "Network$networkName": "The name of the network.
", "Network$awsAccountId": "The Amazon Web Services account ID that owns the network.
", "Network$networkArn": "The Amazon Resource Name (ARN) of the network.
", "Network$freeTrialExpiration": "The expiration date and time for the network's free trial period, if applicable.
", "Network$encryptionKeyArn": "The ARN of the Amazon Web Services KMS customer managed key used for encrypting sensitive data in the network.
", "OidcConfigInfo$applicationName": "The name of the OIDC application as registered with the identity provider.
", "OidcConfigInfo$clientId": "The OAuth client ID assigned by the identity provider for authentication requests.
", "OidcConfigInfo$companyId": "Custom identifier your end users will use to sign in with SSO.
", "OidcConfigInfo$scopes": "The OAuth scopes requested from the identity provider, which determine what user information is accessible (e.g., 'openid profile email').
", "OidcConfigInfo$issuer": "The issuer URL of the identity provider, which serves as the base URL for OIDC endpoints and configuration discovery.
", "OidcConfigInfo$redirectUrl": "The callback URL where the identity provider redirects users after successful authentication. This URL must be registered with the identity provider.
", "OidcConfigInfo$userId": "The claim field from the OIDC token to use as the unique user identifier (e.g., 'email', 'sub', or a custom claim).
", "OidcConfigInfo$customUsername": "A custom field mapping to extract the username from the OIDC token when the standard username claim is insufficient.
", "OidcConfigInfo$caCertificate": "The X.509 CA certificate for validating SSL/TLS connections to the identity provider when using self-signed or enterprise certificates.
", "OidcConfigInfo$extraAuthParams": "Additional authentication parameters to include in the OIDC authorization request as a query string. Useful for provider-specific extensions.
", "OidcTokenInfo$codeVerifier": "The PKCE (Proof Key for Code Exchange) code verifier, a cryptographically random string used to enhance security in the OAuth flow.
", "OidcTokenInfo$codeChallenge": "The PKCE code challenge, a transformed version of the code verifier sent during the authorization request for verification.
", "OidcTokenInfo$accessToken": "The OAuth access token that can be used to access protected resources on behalf of the authenticated user.
", "OidcTokenInfo$idToken": "The OpenID Connect ID token containing user identity information and authentication context as a signed JWT.
", "OidcTokenInfo$refreshToken": "The OAuth refresh token that can be used to obtain new access tokens without requiring the user to re-authenticate.
", "OidcTokenInfo$tokenType": "The type of access token issued, typically 'Bearer', which indicates how the token should be used in API requests.
", "PermittedWickrEnterpriseNetwork$domain": "The domain identifier for the permitted Wickr enterprise network.
", "RateLimitError$message": "A message indicating that the rate limit was exceeded and suggesting when to retry.
", "RegisterOidcConfigRequest$companyId": "Custom identifier your end users will use to sign in with SSO.
", "RegisterOidcConfigRequest$customUsername": "A custom field mapping to extract the username from the OIDC token (optional).
The customUsername is only required if you use something other than email as the username field.
Additional authentication parameters to include in the OIDC flow (optional).
", "RegisterOidcConfigRequest$issuer": "The issuer URL of the OIDC provider (e.g., 'https://login.example.com').
", "RegisterOidcConfigRequest$scopes": "The OAuth scopes to request from the OIDC provider (e.g., 'openid profile email').
", "RegisterOidcConfigRequest$userId": "Unique identifier provided by your identity provider to authenticate the access request. Also referred to as clientID.
", "RegisterOidcConfigResponse$applicationName": "The name of the registered OIDC application.
", "RegisterOidcConfigResponse$clientId": "The OAuth client ID assigned to the application.
", "RegisterOidcConfigResponse$companyId": "Custom identifier your end users will use to sign in with SSO.
", "RegisterOidcConfigResponse$scopes": "The OAuth scopes configured for the application.
", "RegisterOidcConfigResponse$issuer": "The issuer URL of the OIDC provider.
", "RegisterOidcConfigResponse$redirectUrl": "The redirect URL configured for the OAuth flow.
", "RegisterOidcConfigResponse$userId": "The claim field being used as the user identifier.
", "RegisterOidcConfigResponse$customUsername": "The custom field mapping used for extracting the username.
", "RegisterOidcConfigResponse$caCertificate": "The CA certificate used for secure communication with the OIDC provider.
", "RegisterOidcConfigResponse$extraAuthParams": "The additional authentication parameters configured for the OIDC flow.
", "RegisterOidcConfigTestRequest$extraAuthParams": "Additional authentication parameters to include in the test (optional).
", "RegisterOidcConfigTestRequest$issuer": "The issuer URL of the OIDC provider to test.
", "RegisterOidcConfigTestRequest$scopes": "The OAuth scopes to test with the OIDC provider.
", "RegisterOidcConfigTestRequest$certificate": "The CA certificate for secure communication with the OIDC provider (optional).
", "RegisterOidcConfigTestResponse$tokenEndpoint": "The token endpoint URL discovered from the OIDC provider.
", "RegisterOidcConfigTestResponse$userinfoEndpoint": "The user info endpoint URL discovered from the OIDC provider.
", "RegisterOidcConfigTestResponse$issuer": "The issuer URL confirmed by the OIDC provider.
", "RegisterOidcConfigTestResponse$authorizationEndpoint": "The authorization endpoint URL discovered from the OIDC provider.
", "RegisterOidcConfigTestResponse$endSessionEndpoint": "The end session endpoint URL for logging out users from the OIDC provider.
", "RegisterOidcConfigTestResponse$logoutEndpoint": "The logout endpoint URL for terminating user sessions.
", "RegisterOidcConfigTestResponse$revocationEndpoint": "The token revocation endpoint URL for invalidating tokens.
", "ResourceNotFoundError$message": "A message identifying which resource was not found.
", "SecurityGroup$activeDirectoryGuid": "The GUID of the Active Directory group associated with this security group, if synchronized with LDAP.
", "SecurityGroup$id": "The unique identifier of the security group.
", "SecurityGroup$name": "The human-readable name of the security group.
", "SecurityGroupStringList$member": null, "Setting$optionName": "The name of the network setting (e.g., 'enableClientMetrics', 'dataRetention').
", "Setting$value": "The current value of the setting as a string. Boolean values are represented as 'true' or 'false'.
", "Setting$type": "The data type of the setting value (e.g., 'boolean', 'string', 'number').
", "StringList$member": null, "Unames$member": null, "UnauthorizedError$message": "A message explaining why the authentication failed.
", "UpdateBotRequest$displayName": "The new display name for the bot.
", "UpdateBotRequest$groupId": "The ID of the new security group to assign the bot to.
", "UpdateBotResponse$message": "A message indicating the result of the bot update operation.
", "UpdateDataRetentionResponse$message": "A message indicating the result of the update operation.
", "UpdateGuestUserRequest$usernameHash": "The username hash (unique identifier) of the guest user to update.
", "UpdateGuestUserResponse$message": "A message indicating the result of the update operation.
", "UpdateNetworkRequest$networkName": "The new name for the network. Must be between 1 and 20 characters.
", "UpdateNetworkRequest$encryptionKeyArn": "The ARN of the Amazon Web Services KMS customer managed key to use for encrypting sensitive data in the network.
", "UpdateNetworkResponse$message": "A message indicating that the network was updated successfully.
", "UpdateSecurityGroupRequest$groupId": "The unique identifier of the security group to update.
", "UpdateSecurityGroupRequest$name": "The new name for the security group.
", "UpdateUserDetails$username": "The new username or email address for the user.
", "UpdateUserDetails$inviteCode": "A new custom invite code for the user.
", "UpdateUserResponse$middleName": "The middle name of the user (currently not used).
", "UpdateUserResponse$inviteCode": "The updated invite code for the user, if applicable.
", "User$username": "The email address or username of the user. For bots, this must end in 'bot'.
", "User$scimId": "The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.
", "User$type": "The descriptive type of the user account (e.g., 'user').
", "User$cell": "The phone number minus country code, used for cloud deployments.
", "User$countryCode": "The country code for the user's phone number, used for cloud deployments.
", "User$inviteCode": "The invitation code for this user, used during registration to join the network.
", "User$uname": "The unique identifier for the user.
", "WickrAwsNetworks$region": "The Amazon Web Services region identifier where the network is hosted (e.g., 'us-east-1').
" } }, "GetBotRequest": { "base": null, "refs": {} }, "GetBotResponse": { "base": null, "refs": {} }, "GetBotsCountRequest": { "base": null, "refs": {} }, "GetBotsCountResponse": { "base": null, "refs": {} }, "GetDataRetentionBotRequest": { "base": null, "refs": {} }, "GetDataRetentionBotResponse": { "base": null, "refs": {} }, "GetGuestUserHistoryCountRequest": { "base": null, "refs": {} }, "GetGuestUserHistoryCountResponse": { "base": null, "refs": {} }, "GetNetworkRequest": { "base": null, "refs": {} }, "GetNetworkResponse": { "base": null, "refs": {} }, "GetNetworkSettingsRequest": { "base": null, "refs": {} }, "GetNetworkSettingsResponse": { "base": null, "refs": {} }, "GetOidcInfoRequest": { "base": null, "refs": {} }, "GetOidcInfoResponse": { "base": null, "refs": {} }, "GetSecurityGroupRequest": { "base": null, "refs": {} }, "GetSecurityGroupResponse": { "base": null, "refs": {} }, "GetUserRequest": { "base": null, "refs": {} }, "GetUserResponse": { "base": null, "refs": {} }, "GetUsersCountRequest": { "base": null, "refs": {} }, "GetUsersCountResponse": { "base": null, "refs": {} }, "GuestUser": { "base": "Represents a guest user who has accessed the network from a federated Wickr network.
", "refs": { "GuestUserList$member": null } }, "GuestUserHistoryCount": { "base": "Contains the count of guest users for a specific billing period, used for tracking historical guest user activity.
", "refs": { "GuestUserHistoryCountList$member": null } }, "GuestUserHistoryCountList": { "base": null, "refs": { "GetGuestUserHistoryCountResponse$history": "A list of historical guest user counts, organized by month and billing period.
" } }, "GuestUserList": { "base": null, "refs": { "ListGuestUsersResponse$guestlist": "A list of guest user objects within the current page.
" } }, "Integer": { "base": null, "refs": { "BatchCreateUserRequestItem$inviteCodeTtl": "The time-to-live for the invite code in days. After this period, the invite code will expire.
", "GetBotsCountResponse$pending": "The number of bots with pending status (invited but not yet activated).
", "GetBotsCountResponse$active": "The number of bots with active status.
", "GetBotsCountResponse$total": "The total number of bots in the network (active and pending).
", "GetNetworkResponse$standing": "The current standing or status of the network.
", "GetNetworkResponse$migrationState": "The SSO redirect URI migration state, managed by the SSO redirect migration wizard. Values: 0 (not started), 1 (in progress), or 2 (completed).
", "GetUserResponse$status": "The current status of the user (1 for pending, 2 for active).
", "GetUserResponse$lastActivity": "The timestamp of the user's last activity in the network, specified in epoch seconds.
", "GetUserResponse$lastLogin": "The timestamp of the user's last login to the network, specified in epoch seconds.
", "GetUsersCountResponse$pending": "The number of users with pending status (invited but not yet accepted).
", "GetUsersCountResponse$active": "The number of users with active status in the network.
", "GetUsersCountResponse$rejected": "The number of users who have rejected network invitations.
", "GetUsersCountResponse$remaining": "The number of additional users that can be added to the network while maintaining premium free trial eligibility.
", "GetUsersCountResponse$total": "The total number of users in the network (active and pending combined).
", "ListBlockedGuestUsersRequest$maxResults": "The maximum number of blocked guest users to return in a single page. Valid range is 1-100. Default is 10.
", "ListBotsRequest$maxResults": "The maximum number of bots to return in a single page. Valid range is 1-100. Default is 10.
", "ListDevicesForUserRequest$maxResults": "The maximum number of devices to return in a single page. Valid range is 1-100. Default is 10.
", "ListGuestUsersRequest$maxResults": "The maximum number of guest users to return in a single page. Valid range is 1-100. Default is 10.
", "ListNetworksRequest$maxResults": "The maximum number of networks to return in a single page. Valid range is 1-100. Default is 10.
", "ListSecurityGroupUsersRequest$maxResults": "The maximum number of users to return in a single page. Valid range is 1-100. Default is 10.
", "ListSecurityGroupsRequest$maxResults": "The maximum number of security groups to return in a single page. Valid range is 1-100. Default is 10.
", "ListUsersRequest$maxResults": "The maximum number of users to return in a single page. Valid range is 1-100. Default is 10.
", "Network$standing": "The current standing or status of the network.
", "Network$migrationState": "The SSO redirect URI migration state, managed by the SSO redirect migration wizard. Values: 0 (not started), 1 (in progress), or 2 (completed).
", "OidcConfigInfo$ssoTokenBufferMinutes": "The grace period in minutes before the SSO token expires when the system should proactively refresh the token to maintain seamless user access.
", "PasswordRequirements$lowercase": "The minimum number of lowercase letters required in passwords.
", "PasswordRequirements$minLength": "The minimum password length in characters.
", "PasswordRequirements$numbers": "The minimum number of numeric characters required in passwords.
", "PasswordRequirements$symbols": "The minimum number of special symbol characters required in passwords.
", "PasswordRequirements$uppercase": "The minimum number of uppercase letters required in passwords.
", "RegisterOidcConfigRequest$ssoTokenBufferMinutes": "The buffer time in minutes before the SSO token expires to refresh it (optional).
", "RegisterOidcConfigResponse$ssoTokenBufferMinutes": "The buffer time in minutes before the SSO token expires.
", "SecurityGroup$activeMembers": "The number of active user members currently in the security group.
", "SecurityGroup$botMembers": "The number of bot members currently in the security group.
", "SecurityGroup$modified": "The timestamp when the security group was last modified, specified in epoch seconds.
", "SecurityGroupSettings$forceDeviceLockout": "Defines the number of failed login attempts before data stored on the device is reset. Should be less than lockoutThreshold.
", "SecurityGroupSettings$maxBor": "The maximum burn-on-read (BOR) time in seconds, which determines how long messages remain visible before auto-deletion after being read.
", "SecurityGroupSettings$ssoMaxIdleMinutes": "The duration for which users SSO session remains inactive before automatically logging them out for security. Available in SSO enabled network.
", "SecurityGroupSettings$federationMode": "The local federation mode controlling how users can communicate with other networks. Values: 0 (none), 1 (federated), 2 (restricted).
", "SecurityGroupSettings$lockoutThreshold": "The number of failed password attempts before a user account is locked out.
", "SecurityGroupSettingsRequest$lockoutThreshold": "The number of failed password attempts before a user account is locked out.
", "SecurityGroupSettingsRequest$federationMode": "The local federation mode. Values: 0 (none), 1 (federated - all networks), 2 (restricted - only permitted networks).
", "ShredderSettings$intensity": "Prevents Wickr data from being recovered by overwriting deleted Wickr data. Valid Values: Must be one of [0, 20, 60, 100]
", "UpdateUserDetails$inviteCodeTtl": "The new time-to-live for the invite code in days.
", "UpdateUserResponse$modified": "The timestamp when the user was last modified, specified in epoch seconds.
", "UpdateUserResponse$status": "The user's status after the update.
", "UpdateUserResponse$inviteExpiration": "The expiration time of the user's invite code, specified in epoch seconds.
", "User$status": "The current status of the user (1 for pending invitation, 2 for active).
", "User$challengeFailures": "The number of failed password attempts for enterprise deployments, used for account lockout policies.
" } }, "InternalServerError": { "base": "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.
", "refs": {} }, "ListBlockedGuestUsersRequest": { "base": null, "refs": {} }, "ListBlockedGuestUsersResponse": { "base": null, "refs": {} }, "ListBotsRequest": { "base": null, "refs": {} }, "ListBotsResponse": { "base": null, "refs": {} }, "ListDevicesForUserRequest": { "base": null, "refs": {} }, "ListDevicesForUserResponse": { "base": null, "refs": {} }, "ListGuestUsersRequest": { "base": null, "refs": {} }, "ListGuestUsersResponse": { "base": null, "refs": {} }, "ListNetworksRequest": { "base": null, "refs": {} }, "ListNetworksResponse": { "base": null, "refs": {} }, "ListSecurityGroupUsersRequest": { "base": null, "refs": {} }, "ListSecurityGroupUsersResponse": { "base": null, "refs": {} }, "ListSecurityGroupsRequest": { "base": null, "refs": {} }, "ListSecurityGroupsResponse": { "base": null, "refs": {} }, "ListUsersRequest": { "base": null, "refs": {} }, "ListUsersResponse": { "base": null, "refs": {} }, "Long": { "base": null, "refs": { "OidcTokenInfo$expiresIn": "The lifetime of the access token in seconds, indicating when the token will expire and need to be refreshed.
", "SecurityGroupSettings$maxAutoDownloadSize": "The maximum file size in bytes that will be automatically downloaded without user confirmation. Only allowed if fileDownload is enabled. Valid Values [512000 (low_quality), 7340032 (high_quality) ]
", "SecurityGroupSettings$maxTtl": "The maximum time-to-live (TTL) in seconds for messages, after which they will be automatically deleted from all devices.
" } }, "Network": { "base": "Represents a Wickr network with all its configuration and status information.
", "refs": { "NetworkList$member": null } }, "NetworkId": { "base": null, "refs": { "BatchCreateUserRequest$networkId": "The ID of the Wickr network where users will be created.
", "BatchDeleteUserRequest$networkId": "The ID of the Wickr network from which users will be deleted.
", "BatchLookupUserUnameRequest$networkId": "The ID of the Wickr network where the users will be looked up.
", "BatchReinviteUserRequest$networkId": "The ID of the Wickr network where users will be reinvited.
", "BatchResetDevicesForUserRequest$networkId": "The ID of the Wickr network containing the user whose devices will be reset.
", "BatchToggleUserSuspendStatusRequest$networkId": "The ID of the Wickr network where users will be suspended or unsuspended.
", "CreateBotRequest$networkId": "The ID of the Wickr network where the bot will be created.
", "CreateBotResponse$networkId": "The ID of the network where the bot was created.
", "CreateDataRetentionBotChallengeRequest$networkId": "The ID of the Wickr network containing the data retention bot.
", "CreateDataRetentionBotRequest$networkId": "The ID of the Wickr network where the data retention bot will be created.
", "CreateNetworkResponse$networkId": "The unique identifier assigned to the newly created network.
", "CreateSecurityGroupRequest$networkId": "The ID of the Wickr network where the security group will be created.
", "DeleteBotRequest$networkId": "The ID of the Wickr network from which the bot will be deleted.
", "DeleteDataRetentionBotRequest$networkId": "The ID of the Wickr network from which the data retention bot will be deleted.
", "DeleteNetworkRequest$networkId": "The ID of the Wickr network to delete.
", "DeleteSecurityGroupRequest$networkId": "The ID of the Wickr network from which the security group will be deleted.
", "DeleteSecurityGroupResponse$networkId": "The ID of the network from which the security group was deleted.
", "GetBotRequest$networkId": "The ID of the Wickr network containing the bot.
", "GetBotsCountRequest$networkId": "The ID of the Wickr network for which to retrieve bot counts.
", "GetDataRetentionBotRequest$networkId": "The ID of the Wickr network containing the data retention bot.
", "GetGuestUserHistoryCountRequest$networkId": "The ID of the Wickr network for which to retrieve guest user history.
", "GetNetworkRequest$networkId": "The ID of the Wickr network to retrieve.
", "GetNetworkResponse$networkId": "The unique identifier of the network.
", "GetNetworkSettingsRequest$networkId": "The ID of the Wickr network whose settings will be retrieved.
", "GetOidcInfoRequest$networkId": "The ID of the Wickr network whose OIDC configuration will be retrieved.
", "GetSecurityGroupRequest$networkId": "The ID of the Wickr network containing the security group.
", "GetUserRequest$networkId": "The ID of the Wickr network containing the user.
", "GetUsersCountRequest$networkId": "The ID of the Wickr network for which to retrieve user counts.
", "ListBlockedGuestUsersRequest$networkId": "The ID of the Wickr network from which to list blocked guest users.
", "ListBotsRequest$networkId": "The ID of the Wickr network from which to list bots.
", "ListDevicesForUserRequest$networkId": "The ID of the Wickr network containing the user.
", "ListGuestUsersRequest$networkId": "The ID of the Wickr network from which to list guest users.
", "ListSecurityGroupUsersRequest$networkId": "The ID of the Wickr network containing the security group.
", "ListSecurityGroupsRequest$networkId": "The ID of the Wickr network from which to list security groups.
", "ListUsersRequest$networkId": "The ID of the Wickr network from which to list users.
", "Network$networkId": "The unique identifier of the network.
", "PermittedNetworksList$member": null, "PermittedWickrEnterpriseNetwork$networkId": "The network ID of the permitted Wickr enterprise network.
", "RegisterOidcConfigRequest$networkId": "The ID of the Wickr network for which OIDC will be configured.
", "RegisterOidcConfigTestRequest$networkId": "The ID of the Wickr network for which the OIDC configuration will be tested.
", "UpdateBotRequest$networkId": "The ID of the Wickr network containing the bot to update.
", "UpdateDataRetentionRequest$networkId": "The ID of the Wickr network containing the data retention bot.
", "UpdateGuestUserRequest$networkId": "The ID of the Wickr network where the guest user's status will be updated.
", "UpdateNetworkRequest$networkId": "The ID of the Wickr network to update.
", "UpdateNetworkSettingsRequest$networkId": "The ID of the Wickr network whose settings will be updated.
", "UpdateSecurityGroupRequest$networkId": "The ID of the Wickr network containing the security group to update.
", "UpdateUserRequest$networkId": "The ID of the Wickr network containing the user to update.
", "UpdateUserResponse$networkId": "The ID of the network where the user was updated.
", "WickrAwsNetworks$networkId": "The network ID of the Wickr Amazon Web Services network.
" } }, "NetworkList": { "base": null, "refs": { "ListNetworksResponse$networks": "A list of network objects for the Amazon Web Services account.
" } }, "NetworkSettings": { "base": "Contains network-level configuration settings that apply to all users and security groups within a Wickr network.
", "refs": { "UpdateNetworkSettingsRequest$settings": "A map of setting names to their new values. Each setting should be provided with its appropriate type (boolean, string, number, etc.).
" } }, "OidcConfigInfo": { "base": "Contains the OpenID Connect (OIDC) configuration information for Single Sign-On (SSO) authentication, including identity provider settings and client credentials.
", "refs": { "GetOidcInfoResponse$openidConnectInfo": "The OpenID Connect configuration information for the network, including issuer, client ID, scopes, and other SSO settings.
" } }, "OidcConfigInfoApplicationIdInteger": { "base": null, "refs": { "OidcConfigInfo$applicationId": "The unique identifier for the registered OIDC application. Valid range is 1-10.
" } }, "OidcTokenInfo": { "base": "Contains OAuth token information returned from the identity provider, including access tokens, ID tokens, and PKCE parameters used for secure authentication.
", "refs": { "GetOidcInfoResponse$tokenInfo": "OAuth token information including access token, refresh token, and expiration details (only present if token parameters were provided in the request).
" } }, "PasswordRequirements": { "base": "Defines password complexity requirements for users in a security group, including minimum length and character type requirements.
", "refs": { "SecurityGroupSettings$passwordRequirements": "The password complexity requirements that users must follow when creating or changing passwords.
" } }, "PermittedNetworksList": { "base": null, "refs": { "SecurityGroupSettings$permittedNetworks": "A list of network IDs that are permitted for local federation when federation mode is set to restricted.
", "SecurityGroupSettingsRequest$permittedNetworks": "A list of network IDs that are permitted for local federation when federation mode is set to restricted.
" } }, "PermittedWickrEnterpriseNetwork": { "base": "Identifies a Wickr enterprise network that is permitted for global federation, allowing users to communicate with members of the specified network.
", "refs": { "PermittedWickrEnterpriseNetworksList$member": null } }, "PermittedWickrEnterpriseNetworksList": { "base": null, "refs": { "SecurityGroupSettings$permittedWickrEnterpriseNetworks": "A list of permitted Wickr Enterprise networks for global federation, restricting communication to specific approved networks.
", "SecurityGroupSettingsRequest$permittedWickrEnterpriseNetworks": "A list of permitted Wickr Enterprise networks for restricted global federation.
" } }, "RateLimitError": { "base": "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.
", "refs": {} }, "ReadReceiptConfig": { "base": "Configuration for read receipts at the network level, controlling whether senders can see when their messages have been read.
", "refs": { "NetworkSettings$readReceiptConfig": "Configuration for read receipts at the network level, controlling the default behavior for whether senders can see when their messages have been read.
" } }, "RegisterOidcConfigRequest": { "base": null, "refs": {} }, "RegisterOidcConfigResponse": { "base": null, "refs": {} }, "RegisterOidcConfigResponseApplicationIdInteger": { "base": null, "refs": { "RegisterOidcConfigResponse$applicationId": "The unique identifier for the registered OIDC application.
" } }, "RegisterOidcConfigTestRequest": { "base": null, "refs": {} }, "RegisterOidcConfigTestResponse": { "base": null, "refs": {} }, "ResourceNotFoundError": { "base": "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.
", "refs": {} }, "SecurityGroup": { "base": "Represents a security group in a Wickr network, containing membership statistics, configuration, and all permission settings that apply to its members.
", "refs": { "CreateSecurityGroupResponse$securityGroup": "The details of the newly created security group, including its ID, name, and settings.
", "GetSecurityGroupResponse$securityGroup": "The detailed information about the security group, including all its settings and member counts.
", "SecurityGroupList$member": null, "UpdateSecurityGroupResponse$securityGroup": "The updated security group details, including the new settings.
" } }, "SecurityGroupId": { "base": null, "refs": { "SecurityGroupIdList$member": null } }, "SecurityGroupIdList": { "base": null, "refs": { "BatchCreateUserRequestItem$securityGroupIds": "A list of security group IDs to which the user should be assigned.
", "GetUserResponse$securityGroupIds": "A list of security group IDs to which the user belongs.
", "UpdateUserDetails$securityGroupIds": "The updated list of security group IDs to which the user should belong.
", "UpdateUserResponse$securityGroupIds": "The list of security group IDs to which the user now belongs after the update.
", "User$securityGroups": "A list of security group IDs to which the user is assigned, determining their permissions and feature access.
" } }, "SecurityGroupList": { "base": null, "refs": { "ListSecurityGroupsResponse$securityGroups": "A list of security group objects in the current page.
" } }, "SecurityGroupSettings": { "base": "Comprehensive configuration settings that define all user capabilities, restrictions, and features for members of a security group. These settings control everything from calling permissions to federation settings to security policies.
", "refs": { "SecurityGroup$securityGroupSettings": "The comprehensive configuration settings that define capabilities and restrictions for members of this security group.
", "UpdateSecurityGroupRequest$securityGroupSettings": "The updated configuration settings for the security group.
Federation mode - 0 (Local federation), 1 (Restricted federation), 2 (Global federation)
" } }, "SecurityGroupSettingsRequest": { "base": "Contains the security group configuration settings that can be specified when creating or updating a security group. This is a subset of SecurityGroupSettings containing only the modifiable federation and security settings.
", "refs": { "CreateSecurityGroupRequest$securityGroupSettings": "The configuration settings for the security group, including permissions, federation settings, and feature controls.
" } }, "SecurityGroupStringList": { "base": null, "refs": { "SecurityGroupSettings$atakPackageValues": "Configuration values for ATAK (Android Team Awareness Kit) package integration, when ATAK is enabled.
", "SecurityGroupSettings$quickResponses": "A list of pre-defined quick response message templates that users can send with a single tap.
" } }, "SensitiveString": { "base": null, "refs": { "BatchCreateUserRequestItem$firstName": "The first name of the user.
", "BatchCreateUserRequestItem$lastName": "The last name of the user.
", "CreateBotRequest$challenge": "The password for the bot account.
", "CreateDataRetentionBotChallengeResponse$challenge": "The newly generated challenge password for the data retention bot.
", "GetOidcInfoRequest$clientSecret": "The OAuth client secret for retrieving access tokens (optional).
", "GetUserResponse$firstName": "The first name of the user.
", "GetUserResponse$lastName": "The last name of the user.
", "ListUsersRequest$firstName": "Filter results to only include users with first names matching this value.
", "ListUsersRequest$lastName": "Filter results to only include users with last names matching this value.
", "OidcConfigInfo$clientSecret": "The OAuth client secret used to authenticate the application with the identity provider.
", "OidcConfigInfo$secret": "An additional secret credential used by the identity provider for authentication.
", "RegisterOidcConfigRequest$secret": "The client secret for authenticating with the OIDC provider (optional).
", "RegisterOidcConfigResponse$clientSecret": "The OAuth client secret for the application.
", "RegisterOidcConfigResponse$secret": "The client secret for authenticating with the OIDC provider.
", "UpdateBotRequest$challenge": "The new password for the bot account.
", "UpdateUserDetails$firstName": "The new first name for the user.
", "UpdateUserDetails$lastName": "The new last name for the user.
", "UpdateUserResponse$firstName": "The updated first name of the user.
", "UpdateUserResponse$lastName": "The updated last name of the user.
", "User$firstName": "The first name of the user.
", "User$lastName": "The last name of the user.
" } }, "Setting": { "base": "Represents a single network-level configuration setting with its name, value, and data type. Settings control network-wide behaviors and features.
", "refs": { "SettingsList$member": null } }, "SettingsList": { "base": null, "refs": { "GetNetworkSettingsResponse$settings": "A list of network settings, where each setting includes a name, value, and type.
", "UpdateNetworkSettingsResponse$settings": "A list of the updated network settings, showing the new values for each modified setting.
" } }, "ShredderSettings": { "base": "Configuration for the message shredder feature, which securely deletes messages and files from devices to prevent data recovery.
", "refs": { "SecurityGroupSettings$shredder": "The message shredder configuration that controls secure deletion of messages and files from devices.
" } }, "SortDirection": { "base": null, "refs": { "ListBlockedGuestUsersRequest$sortDirection": "The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.
", "ListBotsRequest$sortDirection": "The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.
", "ListDevicesForUserRequest$sortDirection": "The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.
", "ListGuestUsersRequest$sortDirection": "The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.
", "ListNetworksRequest$sortDirection": "The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.
", "ListSecurityGroupUsersRequest$sortDirection": "The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.
", "ListSecurityGroupsRequest$sortDirection": "The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.
", "ListUsersRequest$sortDirection": "The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.
" } }, "Status": { "base": null, "refs": { "ReadReceiptConfig$status": "The read receipt status mode for the network.
" } }, "StringList": { "base": null, "refs": { "RegisterOidcConfigTestResponse$responseTypesSupported": "The OAuth response types supported by the OIDC provider.
", "RegisterOidcConfigTestResponse$scopesSupported": "The OAuth scopes supported by the OIDC provider.
", "RegisterOidcConfigTestResponse$grantTypesSupported": "The OAuth grant types supported by the OIDC provider.
", "RegisterOidcConfigTestResponse$tokenEndpointAuthMethodsSupported": "The authentication methods supported by the token endpoint.
" } }, "SyntheticTimestamp_epoch_seconds": { "base": null, "refs": { "GetUserRequest$startTime": "The start time for filtering the user's last activity. Only activity after this timestamp will be considered. Time is specified in epoch seconds.
", "GetUserRequest$endTime": "The end time for filtering the user's last activity. Only activity before this timestamp will be considered. Time is specified in epoch seconds.
" } }, "Uname": { "base": null, "refs": { "BatchUnameErrorResponseItem$uname": "The username hash that failed to be looked up.
", "BatchUnameSuccessResponseItem$uname": "The username hash that was successfully resolved.
" } }, "Unames": { "base": null, "refs": { "BatchLookupUserUnameRequest$unames": "A list of username hashes (unames) to look up. Each uname is a unique identifier for a user's username. Maximum 50 unames per batch request.
" } }, "UnauthorizedError": { "base": "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.
", "refs": {} }, "UpdateBotRequest": { "base": null, "refs": {} }, "UpdateBotResponse": { "base": null, "refs": {} }, "UpdateDataRetentionRequest": { "base": null, "refs": {} }, "UpdateDataRetentionResponse": { "base": null, "refs": {} }, "UpdateGuestUserRequest": { "base": null, "refs": {} }, "UpdateGuestUserResponse": { "base": null, "refs": {} }, "UpdateNetworkRequest": { "base": null, "refs": {} }, "UpdateNetworkResponse": { "base": null, "refs": {} }, "UpdateNetworkSettingsRequest": { "base": null, "refs": {} }, "UpdateNetworkSettingsResponse": { "base": null, "refs": {} }, "UpdateSecurityGroupRequest": { "base": null, "refs": {} }, "UpdateSecurityGroupResponse": { "base": null, "refs": {} }, "UpdateUserDetails": { "base": "Contains the modifiable details for updating an existing user, including name, password, security group membership, and invitation settings.
A user can only be assigned to a single security group. Attempting to add a user to multiple security groups is not supported and will result in an error.
An object containing the user details to be updated, such as name, password, security groups, and invite code settings.
" } }, "UpdateUserRequest": { "base": null, "refs": {} }, "UpdateUserResponse": { "base": null, "refs": {} }, "User": { "base": "Represents a user account in a Wickr network with detailed profile information, status, security settings, and authentication details.
codeValidation, inviteCode and inviteCodeTtl are restricted to networks under preview only.
The ID of the user whose devices will be reset.
", "BatchUserErrorResponseItem$userId": "The user ID associated with the failed operation.
", "BatchUserSuccessResponseItem$userId": "The user ID that was successfully processed.
", "GetUserRequest$userId": "The unique identifier of the user to retrieve.
", "GetUserResponse$userId": "The unique identifier of the user.
", "ListDevicesForUserRequest$userId": "The unique identifier of the user whose devices will be listed.
", "UpdateUserRequest$userId": "The unique identifier of the user to update.
", "UpdateUserResponse$userId": "The unique identifier of the updated user.
", "User$userId": "The unique identifier for the user within the network.
", "UserIds$member": null } }, "UserIds": { "base": null, "refs": { "BatchDeleteUserRequest$userIds": "A list of user IDs identifying the users to be deleted from the network. Maximum 50 users per batch request.
", "BatchReinviteUserRequest$userIds": "A list of user IDs identifying the users to be reinvited to the network. Maximum 50 users per batch request.
", "BatchToggleUserSuspendStatusRequest$userIds": "A list of user IDs identifying the users whose suspend status will be toggled. Maximum 50 users per batch request.
" } }, "UserStatus": { "base": null, "refs": { "ListUsersRequest$status": "Filter results to only include users with this status (1 for pending, 2 for active).
" } }, "Users": { "base": null, "refs": { "BatchCreateUserResponse$successful": "A list of user objects that were successfully created, including their assigned user IDs and invite codes.
", "ListSecurityGroupUsersResponse$users": "A list of user objects belonging to the security group within the current page.
", "ListUsersResponse$users": "A list of user objects matching the specified filters and within the current page.
" } }, "ValidationError": { "base": "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.
", "refs": {} }, "WickrAwsNetworks": { "base": "Identifies a Amazon Web Services Wickr network by region and network ID, used for configuring permitted networks for global federation.
", "refs": { "WickrAwsNetworksList$member": null } }, "WickrAwsNetworksList": { "base": null, "refs": { "SecurityGroupSettings$permittedWickrAwsNetworks": "A list of permitted Wickr networks for global federation, restricting communication to specific approved networks.
", "SecurityGroupSettingsRequest$permittedWickrAwsNetworks": "A list of permitted Amazon Web Services Wickr networks for restricted global federation.
" } } } }