Wickr class

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.

1. Client errors are indicated by HTTP Status Code class of 4xx
2. 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.

Regional availability

The Amazon Web Services Wickr API is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see Amazon Web Services Wickr endpoints and quotas in the Amazon Web Services General Reference Guide.

Constructors

Wickr({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

batchCreateUser({required String networkId, required List<BatchCreateUserRequestItem> users, String? clientToken}) → Future<BatchCreateUserResponse>

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.

batchDeleteUser({required String networkId, required List<String> userIds, String? clientToken}) → Future<BatchDeleteUserResponse>

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

batchLookupUserUname({required String networkId, required List<String> unames, String? clientToken}) → Future<BatchLookupUserUnameResponse>

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({required String networkId, required List<String> userIds, String? clientToken}) → Future<BatchReinviteUserResponse>

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({required List<String> appIds, required String networkId, required String userId, String? clientToken}) → Future<BatchResetDevicesForUserResponse>

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({required String networkId, required bool suspend, required List<String> userIds, String? clientToken}) → Future<BatchToggleUserSuspendStatusResponse>

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.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createBot({required String challenge, required String groupId, required String networkId, required String username, String? displayName}) → Future<CreateBotResponse>

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({required String networkId}) → Future<CreateDataRetentionBotResponse>

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({required String networkId}) → Future<CreateDataRetentionBotChallengeResponse>

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

createNetwork({required AccessLevel accessLevel, required String networkName, bool? enablePremiumFreeTrial, String? encryptionKeyArn}) → Future<CreateNetworkResponse>

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

createSecurityGroup({required String name, required String networkId, required SecurityGroupSettingsRequest securityGroupSettings, String? clientToken}) → Future<CreateSecurityGroupResponse>

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({required String botId, required String networkId}) → Future<DeleteBotResponse>

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

deleteDataRetentionBot({required String networkId}) → Future<DeleteDataRetentionBotResponse>

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

deleteNetwork({required String networkId, String? clientToken}) → Future<DeleteNetworkResponse>

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({required String groupId, required String networkId}) → Future<DeleteSecurityGroupResponse>

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

getBot({required String botId, required String networkId}) → Future<GetBotResponse>

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

getBotsCount({required String networkId}) → Future<GetBotsCountResponse>

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

getDataRetentionBot({required String networkId}) → Future<GetDataRetentionBotResponse>

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

getGuestUserHistoryCount({required String networkId}) → Future<GetGuestUserHistoryCountResponse>

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({required String networkId}) → Future<GetNetworkResponse>

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

getNetworkSettings({required String networkId}) → Future<GetNetworkSettingsResponse>

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

getOidcInfo({required String networkId, String? certificate, String? clientId, String? clientSecret, String? code, String? codeVerifier, String? grantType, String? redirectUri, String? url}) → Future<GetOidcInfoResponse>

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

getOpentdfConfig({required String networkId}) → Future<GetOpentdfConfigResponse>

Retrieves the OpenTDF integration configuration for a Wickr network.

getSecurityGroup({required String groupId, required String networkId}) → Future<GetSecurityGroupResponse>

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

getUser({required String networkId, required String userId, DateTime? endTime, DateTime? startTime}) → Future<GetUserResponse>

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

getUsersCount({required String networkId}) → Future<GetUsersCountResponse>

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({required String networkId, String? admin, int? maxResults, String? nextToken, SortDirection? sortDirection, String? sortFields, String? username}) → Future<ListBlockedGuestUsersResponse>

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

listBots({required String networkId, String? displayName, String? groupId, int? maxResults, String? nextToken, SortDirection? sortDirection, String? sortFields, int? status, String? username}) → Future<ListBotsResponse>

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

listDevicesForUser({required String networkId, required String userId, int? maxResults, String? nextToken, SortDirection? sortDirection, String? sortFields}) → Future<ListDevicesForUserResponse>

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({required String networkId, String? billingPeriod, int? maxResults, String? nextToken, SortDirection? sortDirection, String? sortFields, String? username}) → Future<ListGuestUsersResponse>

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({int? maxResults, String? nextToken, SortDirection? sortDirection, String? sortFields}) → Future<ListNetworksResponse>

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.

listSecurityGroups({required String networkId, int? maxResults, String? nextToken, SortDirection? sortDirection, String? sortFields}) → Future<ListSecurityGroupsResponse>

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

listSecurityGroupUsers({required String groupId, required String networkId, int? maxResults, String? nextToken, SortDirection? sortDirection, String? sortFields}) → Future<ListSecurityGroupUsersResponse>

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

listUsers({required String networkId, String? firstName, String? groupId, String? lastName, int? maxResults, String? nextToken, SortDirection? sortDirection, String? sortFields, int? status, String? username}) → Future<ListUsersResponse>

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.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOidcConfig({required String companyId, required String issuer, required String networkId, required String scopes, String? customUsername, String? extraAuthParams, String? secret, int? ssoTokenBufferMinutes, String? userId}) → Future<RegisterOidcConfigResponse>

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

registerOidcConfigTest({required String issuer, required String networkId, required String scopes, String? certificate, String? extraAuthParams}) → Future<RegisterOidcConfigTestResponse>

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

registerOpentdfConfig({required String clientId, required String clientSecret, required String domain, required String networkId, required String provider, bool? dryRun}) → Future<RegisterOpentdfConfigResponse>

Registers and saves OpenTDF configuration for a Wickr network, enabling attribute-based access control for Wickr through an OpenTDF provider.

toString() → String

A string representation of this object.

inherited

updateBot({required String botId, required String networkId, String? challenge, String? displayName, String? groupId, bool? suspend}) → Future<UpdateBotResponse>

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({required DataRetentionActionType actionType, required String networkId}) → Future<UpdateDataRetentionResponse>

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

updateGuestUser({required bool block, required String networkId, required String usernameHash}) → Future<UpdateGuestUserResponse>

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({required String networkId, required String networkName, String? clientToken, String? encryptionKeyArn}) → Future<UpdateNetworkResponse>

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

updateNetworkSettings({required String networkId, required NetworkSettings settings}) → Future<UpdateNetworkSettingsResponse>

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

updateSecurityGroup({required String groupId, required String networkId, String? name, SecurityGroupSettings? securityGroupSettings}) → Future<UpdateSecurityGroupResponse>

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

updateUser({required String networkId, required String userId, UpdateUserDetails? userDetails}) → Future<UpdateUserResponse>

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.

Operators

operator ==(Object other) → bool

The equality operator.

inherited