GetNetwork
Retrieves detailed information about a specific Wickr network, including its configuration, access level, and status.
Request Syntax
GET /networks/networkId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- networkId
-
The ID of the Wickr network to retrieve.
Length Constraints: Fixed length of 8.
Pattern:
[0-9]{8}Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"accessLevel": "string",
"awsAccountId": "string",
"encryptionKeyArn": "string",
"freeTrialExpiration": "string",
"migrationState": number,
"networkArn": "string",
"networkId": "string",
"networkName": "string",
"standing": number
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- accessLevel
-
The access level of the network (STANDARD or PREMIUM), which determines available features and capabilities.
Type: String
Valid Values:
STANDARD | PREMIUM - awsAccountId
-
The AWS account ID that owns the network.
Type: String
Pattern:
[\S\s]* - networkArn
-
The Amazon Resource Name (ARN) of the network.
Type: String
Pattern:
[\S\s]* - networkId
-
The unique identifier of the network.
Type: String
Length Constraints: Fixed length of 8.
Pattern:
[0-9]{8} - networkName
-
The name of the network.
Type: String
Pattern:
[\S\s]* - encryptionKeyArn
-
The ARN of the AWS KMS customer managed key used for encrypting sensitive data in the network.
Type: String
Pattern:
[\S\s]* - freeTrialExpiration
-
The expiration date and time for the network's free trial period, if applicable.
Type: String
Pattern:
[\S\s]* - migrationState
-
The SSO redirect URI migration state, managed by the SSO redirect migration wizard. Values: 0 (not started), 1 (in progress), or 2 (completed).
Type: Integer
- standing
-
The current standing or status of the network.
Type: Integer
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestError
-
The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.
- message
-
A detailed message explaining what was wrong with the request and how to correct it.
HTTP Status Code: 400
- ForbiddenError
-
Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.
- message
-
A message explaining why access was denied and what permissions are required.
HTTP Status Code: 403
- InternalServerError
-
An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact AWS Support.
- message
-
A message describing the internal server error that occurred.
HTTP Status Code: 500
- RateLimitError
-
The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.
- message
-
A message indicating that the rate limit was exceeded and suggesting when to retry.
HTTP Status Code: 429
- ResourceNotFoundError
-
The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.
- message
-
A message identifying which resource was not found.
HTTP Status Code: 404
- UnauthorizedError
-
The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.
- message
-
A message explaining why the authentication failed.
HTTP Status Code: 401
- ValidationError
-
One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.
- reasons
-
A list of validation error details, where each item identifies a specific field that failed validation and explains the reason for the failure.
HTTP Status Code: 422
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
