Amazon Web Services, Inc.

AWS Wickr Admin API

Welcome to the Amazon Web Services Wickr API Reference . The Amazon Web Services Wickr application programming interface (API) is designed for administrators…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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. 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 . Wickr API endpoints are region-specific and include a region code in the format: https://admin.wickr.[regioncode].amazonaws.com . For example, for the US East (N.Virginia) us-east-1 , the API endpoint is https://admin.wickr.us-east-1.amazonaws.com .

Endpoints 44

  • GETList users/networks/:networkId/users?nextToken=string&maxResults=0&sortFields=string&sortDirection=string&firstName=string&lastName=string&username=string&status=string&groupId=stringRetrieves 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…
  • POSTBatch create user/networks/:networkId/usersCreates multiple users in a specified Wickr network. This operation allows you to provision multiple user accounts simultaneously, optionally specifying…
  • PATCHUpdate user/networks/:networkId/usersUpdates 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…
  • POSTBatch delete user/networks/:networkId/users/batch-deleteDeletes multiple users from a specified Wickr network. This operation permanently removes user accounts and their associated data from the network.
  • POSTBatch lookup user uname/networks/:networkId/users/uname-lookupLooks up multiple user usernames from their unique username hashes (unames). This operation allows you to retrieve the email addresses associated with a list…
  • PATCHBatch reinvite user/networks/:networkId/users/re-inviteResends invitation codes to multiple users who have pending invitations in a Wickr network. This operation is useful when users haven't accepted their initial…
  • GETList devices for user/networks/:networkId/users/:userId/devices?nextToken=string&maxResults=0&sortFields=string&sortDirection=stringRetrieves a paginated list of devices associated with a specific user in a Wickr network. This operation returns information about all devices where the user…
  • PATCHBatch reset devices for user/networks/:networkId/users/:userId/devicesResets 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,…
  • PATCHBatch toggle user suspend status/networks/:networkId/users/toggleSuspend?suspend=trueSuspends or unsuspends multiple users in a Wickr network. Suspended users cannot access the network until they are unsuspended. This operation is useful for…
  • GETList bots/networks/:networkId/bots?nextToken=string&maxResults=0&sortFields=string&sortDirection=string&displayName=string&username=string&status=string&groupId=stringRetrieves a paginated list of bots in a specified Wickr network. You can filter and sort the results based on various criteria.
  • POSTCreate bot/networks/:networkId/botsCreates a new bot in a specified Wickr network. Bots are automated accounts that can send and receive messages, enabling integration with external systems and…
  • GETGet data retention bot/networks/:networkId/data-retention-botsRetrieves information about the data retention bot in a Wickr network, including its status and whether the data retention service is enabled.
  • POSTCreate data retention bot/networks/:networkId/data-retention-botsCreates a data retention bot in a Wickr network. Data retention bots are specialized bots that handle message archiving and compliance by capturing and…
  • DELETEDelete data retention bot/networks/:networkId/data-retention-botsDeletes the data retention bot from a Wickr network. This operation permanently removes the bot and all its associated data from the database.
  • PATCHUpdate data retention/networks/:networkId/data-retention-botsUpdates the data retention bot settings, allowing you to enable or disable the data retention service, or acknowledge the public key message.
  • POSTCreate data retention bot challenge/networks/:networkId/data-retention-bots/challengeCreates a new challenge password for the data retention bot. This password is used for authentication when the bot connects to the network.
  • GETList networks/networks?maxResults=0&sortFields=string&sortDirection=string&nextToken=stringRetrieves a paginated list of all Wickr networks associated with your Amazon Web Services account. You can sort the results by network ID or name.
  • POSTCreate network/networksCreates a new Wickr network with specified access level and configuration. This operation provisions a new communication network for your organization.
  • GETList security groups/networks/:networkId/security-groups?nextToken=string&maxResults=0&sortFields=string&sortDirection=stringRetrieves a paginated list of security groups in a specified Wickr network. You can sort the results by various criteria.
  • POSTCreate security group/networks/:networkId/security-groupsCreates a new security group in a Wickr network. Security groups allow you to organize users and control their permissions, features, and security settings.
  • GETGet bot/networks/:networkId/bots/:botIdRetrieves detailed information about a specific bot in a Wickr network, including its status, group membership, and authentication details.
  • DELETEDelete bot/networks/:networkId/bots/:botIdDeletes a bot from a specified Wickr network. This operation permanently removes the bot account and its associated data from the network.
  • PATCHUpdate bot/networks/:networkId/bots/:botIdUpdates 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…
  • GETGet network/networks/:networkIdRetrieves detailed information about a specific Wickr network, including its configuration, access level, and status.
  • DELETEDelete network/networks/:networkIdDeletes a Wickr network and all its associated resources, including users, bots, security groups, and settings. This operation is permanent and cannot be…
  • PATCHUpdate network/networks/:networkIdUpdates the properties of an existing Wickr network, such as its name or encryption key configuration.
  • GETGet security group/networks/:networkId/security-groups/:groupIdRetrieves detailed information about a specific security group in a Wickr network, including its settings, member counts, and configuration.
  • DELETEDelete security group/networks/:networkId/security-groups/:groupIdDeletes a security group from a Wickr network. This operation cannot be performed on the default security group.
  • PATCHUpdate security group/networks/:networkId/security-groups/:groupIdUpdates the properties of an existing security group in a Wickr network, such as its name or settings.
  • GETGet bots count/networks/:networkId/bots/countRetrieves the count of bots in a Wickr network, categorized by their status (pending, active, and total).
  • GETGet guest user history count/networks/:networkId/guest-users/countRetrieves historical guest user count data for a Wickr network, showing the number of guest users per billing period over the past 90 days.
  • GETGet network settings/networks/:networkId/settingsRetrieves all network-level settings for a Wickr network, including client metrics, data retention, and other configuration options.
  • PATCHUpdate network settings/networks/:networkId/settingsUpdates network-level settings for a Wickr network. You can modify settings such as client metrics, data retention, and other network-wide options.
  • GETGet oidc info/networks/:networkId/oidc?clientId=string&code=string&grantType=string&redirectUri=string&url=string&clientSecret=string&codeVerifier=string&certificate=stringRetrieves the OpenID Connect (OIDC) configuration for a Wickr network, including SSO settings and optional token information if access token parameters are…
  • GETGet opentdf config/networks/:networkId/tdfRetrieves the OpenTDF integration configuration for a Wickr network.
  • POSTRegister opentdf config/networks/:networkId/tdf?dryRun=trueRegisters and saves OpenTDF configuration for a Wickr network, enabling attribute-based access control for Wickr through an OpenTDF provider.
  • GETGet user/networks/:networkId/users/:userId?startTime=string&endTime=stringRetrieves detailed information about a specific user in a Wickr network, including their profile, status, and activity history.
  • GETGet users count/networks/:networkId/users/countRetrieves the count of users in a Wickr network, categorized by their status (pending, active, rejected) and showing how many users can still be added.
  • GETList blocked guest users/networks/:networkId/guest-users/blocklist?maxResults=0&sortDirection=string&sortFields=string&username=string&admin=string&nextToken=stringRetrieves a paginated list of guest users who have been blocked from a Wickr network. You can filter and sort the results.
  • GETList guest users/networks/:networkId/guest-users?maxResults=0&sortDirection=string&sortFields=string&username=string&billingPeriod=string&nextToken=stringRetrieves a paginated list of guest users who have communicated with your Wickr network. Guest users are external users from federated networks who can…
  • GETList security group users/networks/:networkId/security-groups/:groupId/users?nextToken=string&maxResults=0&sortFields=string&sortDirection=stringRetrieves a paginated list of users who belong to a specific security group in a Wickr network.
  • POSTRegister oidc config/networks/:networkId/oidc/saveRegisters and saves an OpenID Connect (OIDC) configuration for a Wickr network, enabling Single Sign-On (SSO) authentication through an identity provider.
  • POSTRegister oidc config test/networks/:networkId/oidc/testTests an OpenID Connect (OIDC) configuration for a Wickr network by validating the connection to the identity provider and retrieving its supported…
  • PATCHUpdate guest user/networks/:networkId/guest-users/:usernameHashUpdates 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.

API details

Base URL
https://admin.wickr.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
44 operations on 27 pathsGET 19POST 11PATCH 10DELETE 4
Description format
AWS Smithy model, API version 2024-02-01

How to test the AWS Wickr Admin API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Wickr Admin API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List users” (GET /networks/:networkId/users?nextToken=string&maxResults=0&sortFields=string&sortDirection=string&firstName=string&lastName=string&username=string&status=string&groupId=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Wickr Admin API?

Welcome to the Amazon Web Services Wickr API Reference . The Amazon Web Services Wickr application programming interface (API) is designed for administrators… It is listed under Developer tools and has 44 endpoints.

Who publishes the AWS Wickr Admin API?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Wickr Admin API?

Requests go to https://admin.wickr.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Wickr Admin API?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Wickr Admin API have?

44 operations on 27 paths (19 GET, 11 POST, 10 PATCH, 4 DELETE).

Is forking the AWS Wickr Admin API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.