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

UpdateUser

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.

Note

codeValidation, inviteCode, and inviteCodeTtl are restricted to networks under preview only.

Request Syntax


PATCH /networks/networkId/users HTTP/1.1
Content-type: application/json

{
   "userDetails": { 
      "codeValidation": boolean,
      "firstName": "string",
      "inviteCode": "string",
      "inviteCodeTtl": number,
      "lastName": "string",
      "securityGroupIds": [ "string" ],
      "username": "string"
   },
   "userId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

networkId

The ID of the Wickr network containing the user to update.

Length Constraints: Fixed length of 8.

Pattern: [0-9]{8}

Required: Yes

Request Body

The request accepts the following data in JSON format.

userId

The unique identifier of the user to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10.

Pattern: [0-9]+

Required: Yes

userDetails

An object containing the user details to be updated, such as name, password, security groups, and invite code settings.

Type: UpdateUserDetails object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "codeValidation": boolean,
   "firstName": "string",
   "inviteCode": "string",
   "inviteExpiration": number,
   "lastName": "string",
   "middleName": "string",
   "modified": number,
   "networkId": "string",
   "securityGroupIds": [ "string" ],
   "status": number,
   "suspended": boolean,
   "userId": "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.

networkId

The ID of the network where the user was updated.

Type: String

Length Constraints: Fixed length of 8.

Pattern: [0-9]{8}

suspended

Indicates whether the user is suspended after the update.

Type: Boolean

userId

The unique identifier of the updated user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10.

Pattern: [0-9]+

codeValidation

Indicates whether the user can be verified through a custom invite code.

Type: Boolean

firstName

The updated first name of the user.

Type: String

Pattern: [\S\s]*

inviteCode

The updated invite code for the user, if applicable.

Type: String

Pattern: [\S\s]*

inviteExpiration

The expiration time of the user's invite code, specified in epoch seconds.

Type: Integer

lastName

The updated last name of the user.

Type: String

Pattern: [\S\s]*

middleName

The middle name of the user (currently not used).

Type: String

Pattern: [\S\s]*

modified

The timestamp when the user was last modified, specified in epoch seconds.

Type: Integer

securityGroupIds

The list of security group IDs to which the user now belongs after the update.

Type: Array of strings

Pattern: [\S]+

status

The user's status after the update.

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