Module Values.UserSource

Represents a user account in a Wickr network with detailed profile information, status, security settings, and authentication details. codeValidation, inviteCode and inviteCodeTtl are restricted to networks under preview only.

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

    The unique identifier for the user within the network.

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

    The first name of the user.

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

    The last name of the user.

    *)
  4. username : GenericString.t option;
    (*

    The email address or username of the user. For bots, this must end in 'bot'.

    *)
  5. securityGroups : SecurityGroupIdList.t option;
    (*

    A list of security group IDs to which the user is assigned, determining their permissions and feature access.

    *)
  6. isAdmin : Boolean.t option;
    (*

    Indicates whether the user has administrator privileges in the network.

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

    Indicates whether the user is currently suspended and unable to access the network.

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

    The current status of the user (1 for pending invitation, 2 for active).

    *)
  9. otpEnabled : Boolean.t option;
    (*

    Indicates whether one-time password (OTP) authentication is enabled for the user.

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

    The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.

    *)
  11. type_ : GenericString.t option;
    (*

    The descriptive type of the user account (e.g., 'user').

    *)
  12. cell : GenericString.t option;
    (*

    The phone number minus country code, used for cloud deployments.

    *)
  13. countryCode : GenericString.t option;
    (*

    The country code for the user's phone number, used for cloud deployments.

    *)
  14. challengeFailures : Integer.t option;
    (*

    The number of failed password attempts for enterprise deployments, used for account lockout policies.

    *)
  15. isInviteExpired : Boolean.t option;
    (*

    Indicates whether the user's email invitation code has expired, applicable to cloud deployments.

    *)
  16. isUser : Boolean.t option;
    (*

    Indicates whether this account is a user (as opposed to a bot or other account type).

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

    The invitation code for this user, used during registration to join the network.

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

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

    *)
  19. uname : GenericString.t option;
    (*

    The unique identifier for the user.

    *)
}
Sourceval make : ?userId:??? -> ?firstName:??? -> ?lastName:??? -> ?username:??? -> ?securityGroups:??? -> ?isAdmin:??? -> ?suspended:??? -> ?status:??? -> ?otpEnabled:??? -> ?scimId:??? -> ?type_:??? -> ?cell:??? -> ?countryCode:??? -> ?challengeFailures:??? -> ?isInviteExpired:??? -> ?isUser:??? -> ?inviteCode:??? -> ?codeValidation:??? -> ?uname:??? -> unit -> 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