Module Values.UpdateUserResponseSource

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.

Sourcetype nonrec t = {
  1. userId : UserId.t option;
    (*

    The unique identifier of the updated user.

    *)
  2. networkId : NetworkId.t option;
    (*

    The ID of the network where the user was updated.

    *)
  3. securityGroupIds : SecurityGroupIdList.t option;
    (*

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

    *)
  4. firstName : SensitiveString.t option;
    (*

    The updated first name of the user.

    *)
  5. lastName : SensitiveString.t option;
    (*

    The updated last name of the user.

    *)
  6. middleName : GenericString.t option;
    (*

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

    *)
  7. suspended : Boolean.t option;
    (*

    Indicates whether the user is suspended after the update.

    *)
  8. modified : Integer.t option;
    (*

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

    *)
  9. status : Integer.t option;
    (*

    The user's status after the update.

    *)
  10. inviteCode : GenericString.t option;
    (*

    The updated invite code for the user, if applicable.

    *)
  11. inviteExpiration : Integer.t option;
    (*

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

    *)
  12. codeValidation : Boolean.t option;
    (*

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

    *)
}
Sourcetype nonrec error = [
  1. | `BadRequestError of BadRequestError.t
  2. | `ForbiddenError of ForbiddenError.t
  3. | `InternalServerError of InternalServerError.t
  4. | `RateLimitError of RateLimitError.t
  5. | `ResourceNotFoundError of ResourceNotFoundError.t
  6. | `UnauthorizedError of UnauthorizedError.t
  7. | `ValidationError of ValidationError.t
  8. | `Unknown_operation_error of string * string option
]
Sourceval make : ?userId:??? -> ?networkId:??? -> ?securityGroupIds:??? -> ?firstName:??? -> ?lastName:??? -> ?middleName:??? -> ?suspended:??? -> ?modified:??? -> ?status:??? -> ?inviteCode:??? -> ?inviteExpiration:??? -> ?codeValidation:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `BadRequestError of BadRequestError.t | `ForbiddenError of ForbiddenError.t | `InternalServerError of InternalServerError.t | `RateLimitError of RateLimitError.t | `ResourceNotFoundError of ResourceNotFoundError.t | `UnauthorizedError of UnauthorizedError.t | `Unknown_operation_error of string * string option | `ValidationError of ValidationError.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `BadRequestError of BadRequestError.t | `ForbiddenError of ForbiddenError.t | `InternalServerError of InternalServerError.t | `RateLimitError of RateLimitError.t | `ResourceNotFoundError of ResourceNotFoundError.t | `UnauthorizedError of UnauthorizedError.t | `Unknown_operation_error of string * string option | `ValidationError of ValidationError.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Boolean.t | `Integer of Integer.t | `List of [> `String of SecurityGroupId.t ] list | `String of UserId.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t