Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListSecurityGroupUsers

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

Request Syntax


GET /networks/networkId/security-groups/groupId/users?maxResults=maxResults&nextToken=nextToken&sortDirection=sortDirection&sortFields=sortFields HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

groupId

The unique identifier of the security group whose users will be listed.

Pattern: [\S\s]*

Required: Yes

maxResults

The maximum number of users to return in a single page. Valid range is 1-100. Default is 10.

networkId

The ID of the Wickr network containing the security group.

Length Constraints: Fixed length of 8.

Pattern: [0-9]{8}

Required: Yes

nextToken

The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

Pattern: [\S\s]*

sortDirection

The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.

Valid Values: ASC | DESC

sortFields

The field to sort users by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', and 'lastName'.

Pattern: [\S\s]*

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "users": [ 
      { 
         "cell": "string",
         "challengeFailures": number,
         "codeValidation": boolean,
         "countryCode": "string",
         "firstName": "string",
         "inviteCode": "string",
         "isAdmin": boolean,
         "isInviteExpired": boolean,
         "isUser": boolean,
         "lastName": "string",
         "otpEnabled": boolean,
         "scimId": "string",
         "securityGroups": [ "string" ],
         "status": number,
         "suspended": boolean,
         "type": "string",
         "uname": "string",
         "userId": "string",
         "username": "string"
      }
   ]
}

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.

users

A list of user objects belonging to the security group within the current page.

Type: Array of User objects

nextToken

The token to use for retrieving the next page of results. If this is not present, there are no more results.

Type: String

Pattern: [\S\s]*

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