View Source AWS.Wickr (aws-elixir v1.0.11)

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.

Link to this section Summary

Functions

Creates multiple users in a specified Wickr network.

Deletes multiple users from a specified Wickr network.

Looks up multiple user usernames from their unique username hashes (unames).

Resends invitation codes to multiple users who have pending invitations in a Wickr network.

Resets multiple devices for a specific user in a Wickr network.

Suspends or unsuspends multiple users in a Wickr network.

Creates a new bot in a specified Wickr network.

Creates a data retention bot in a Wickr network.

Creates a new challenge password for the data retention bot.

Creates a new Wickr network with specified access level and configuration.

Creates a new security group in a Wickr network.

Deletes a bot from a specified Wickr network.

Deletes the data retention bot from a Wickr network.

Deletes a Wickr network and all its associated resources, including users, bots, security groups, and settings.

Deletes a security group from a Wickr network.

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

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

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

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

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

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

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

Retrieves the OpenTDF integration configuration for a Wickr network.

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

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

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.

Retrieves a paginated list of all Wickr networks associated with your Amazon Web Services account.

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

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

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

Updates the properties of an existing bot in a Wickr network.

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

Updates the block status of a guest user in a Wickr network.

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

Updates network-level settings for a Wickr network.

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

Updates the properties of an existing user in a Wickr network.

Link to this section Functions

Link to this function

batch_create_user(client, network_id, input, options \\ [])

View Source

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.

Link to this function

batch_delete_user(client, network_id, input, options \\ [])

View Source

Deletes multiple users from a specified Wickr network.

This operation permanently removes user accounts and their associated data from the network.

Link to this function

batch_lookup_user_uname(client, network_id, input, options \\ [])

View Source

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.

Link to this function

batch_reinvite_user(client, network_id, input, options \\ [])

View Source

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.

Link to this function

batch_reset_devices_for_user(client, network_id, user_id, input, options \\ [])

View Source

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.

Link to this function

batch_toggle_user_suspend_status(client, network_id, input, options \\ [])

View Source

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.

Link to this function

create_bot(client, network_id, input, options \\ [])

View Source

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.

Link to this function

create_data_retention_bot(client, network_id, input, options \\ [])

View Source

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.

Link to this function

create_data_retention_bot_challenge(client, network_id, input, options \\ [])

View Source

Creates a new challenge password for the data retention bot.

This password is used for authentication when the bot connects to the network.

Link to this function

create_network(client, input, options \\ [])

View Source

Creates a new Wickr network with specified access level and configuration.

This operation provisions a new communication network for your organization.

Link to this function

create_security_group(client, network_id, input, options \\ [])

View Source

Creates a new security group in a Wickr network.

Security groups allow you to organize users and control their permissions, features, and security settings.

Link to this function

delete_bot(client, bot_id, network_id, input, options \\ [])

View Source

Deletes a bot from a specified Wickr network.

This operation permanently removes the bot account and its associated data from the network.

Link to this function

delete_data_retention_bot(client, network_id, input, options \\ [])

View Source

Deletes the data retention bot from a Wickr network.

This operation permanently removes the bot and all its associated data from the database.

Link to this function

delete_network(client, network_id, input, options \\ [])

View Source

Deletes a Wickr network and all its associated resources, including users, bots, security groups, and settings.

This operation is permanent and cannot be undone.

Link to this function

delete_security_group(client, group_id, network_id, input, options \\ [])

View Source

Deletes a security group from a Wickr network.

This operation cannot be performed on the default security group.

Link to this function

get_bot(client, bot_id, network_id, options \\ [])

View Source

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

Link to this function

get_bots_count(client, network_id, options \\ [])

View Source

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

Link to this function

get_data_retention_bot(client, network_id, options \\ [])

View Source

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

Link to this function

get_guest_user_history_count(client, network_id, options \\ [])

View Source

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

Link to this function

get_network(client, network_id, options \\ [])

View Source

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

Link to this function

get_network_settings(client, network_id, options \\ [])

View Source

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

Link to this function

get_oidc_info(client, network_id, certificate \\ nil, client_id \\ nil, client_secret \\ nil, code \\ nil, code_verifier \\ nil, grant_type \\ nil, redirect_uri \\ nil, url \\ nil, options \\ [])

View Source

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

Link to this function

get_opentdf_config(client, network_id, options \\ [])

View Source

Retrieves the OpenTDF integration configuration for a Wickr network.

Link to this function

get_security_group(client, group_id, network_id, options \\ [])

View Source

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

Link to this function

get_user(client, network_id, user_id, end_time \\ nil, start_time \\ nil, options \\ [])

View Source

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

Link to this function

get_users_count(client, network_id, options \\ [])

View Source

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.

Link to this function

list_blocked_guest_users(client, network_id, admin \\ nil, max_results \\ nil, next_token \\ nil, sort_direction \\ nil, sort_fields \\ nil, username \\ nil, options \\ [])

View Source

Retrieves a paginated list of guest users who have been blocked from a Wickr network.

You can filter and sort the results.

Link to this function

list_bots(client, network_id, display_name \\ nil, group_id \\ nil, max_results \\ nil, next_token \\ nil, sort_direction \\ nil, sort_fields \\ nil, status \\ nil, username \\ nil, options \\ [])

View Source

Retrieves a paginated list of bots in a specified Wickr network.

You can filter and sort the results based on various criteria.

Link to this function

list_devices_for_user(client, network_id, user_id, max_results \\ nil, next_token \\ nil, sort_direction \\ nil, sort_fields \\ nil, options \\ [])

View Source

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.

Link to this function

list_guest_users(client, network_id, billing_period \\ nil, max_results \\ nil, next_token \\ nil, sort_direction \\ nil, sort_fields \\ nil, username \\ nil, options \\ [])

View Source

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.

Link to this function

list_networks(client, max_results \\ nil, next_token \\ nil, sort_direction \\ nil, sort_fields \\ nil, options \\ [])

View Source

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.

Link to this function

list_security_group_users(client, group_id, network_id, max_results \\ nil, next_token \\ nil, sort_direction \\ nil, sort_fields \\ nil, options \\ [])

View Source

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

Link to this function

list_security_groups(client, network_id, max_results \\ nil, next_token \\ nil, sort_direction \\ nil, sort_fields \\ nil, options \\ [])

View Source

Retrieves a paginated list of security groups in a specified Wickr network.

You can sort the results by various criteria.

Link to this function

list_users(client, network_id, first_name \\ nil, group_id \\ nil, last_name \\ nil, max_results \\ nil, next_token \\ nil, sort_direction \\ nil, sort_fields \\ nil, status \\ nil, username \\ nil, options \\ [])

View Source

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.

Link to this function

register_oidc_config(client, network_id, input, options \\ [])

View Source

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

Link to this function

register_oidc_config_test(client, network_id, input, options \\ [])

View Source

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

Link to this function

register_opentdf_config(client, network_id, input, options \\ [])

View Source

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

Link to this function

update_bot(client, bot_id, network_id, input, options \\ [])

View Source

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.

Link to this function

update_data_retention(client, network_id, input, options \\ [])

View Source

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

Link to this function

update_guest_user(client, network_id, username_hash, input, options \\ [])

View Source

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.

Link to this function

update_network(client, network_id, input, options \\ [])

View Source

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

Link to this function

update_network_settings(client, network_id, input, options \\ [])

View Source

Updates network-level settings for a Wickr network.

You can modify settings such as client metrics, data retention, and other network-wide options.

Link to this function

update_security_group(client, group_id, network_id, input, options \\ [])

View Source

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

Link to this function

update_user(client, network_id, input, options \\ [])

View Source

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.