Access to User objects different than the current logged in user is granted only to administrative users.
The login token
The index of the starting user to get
How many users to get
Success
Specifications of a User object.
Name of the Tenant this user is associated to. Required during Login and Registration operations. Returned during Get operations. Ignored in other cases.
User ID. Unique and assigned by the system. Returned during Login and Get operations. Ignored in other cases.
User name. Must be unique. Required during Login and Registration operations. Returned during Get operations. Ignored in other cases.
Password. Required during Login and Registration operations. Also required during Update operations if NewPassword is specified. Ignored in other cases.
New password. Used during Update and Login operations, if the user wants or must change password. Ignored in other cases.
E-mail address. Required during Registration operations. Used during Update operations. May be used as an alternative to UserName during Login operations. Returned during Get operations. The address is checked via a verification code.
URL of the avatar image representing the User. May be provided during Registration and Update operations. Returned during Login and Get operations.
URL of the avatar 3D model representing the User. May be provided during Registration and Update operations. Returned during Login and Get operations.
Additional information about the avatar 3D model URL, e.g. if it's a head-only, full-body avatar, custom model etc. Sample possible values are: readyplayerme: the avatar 3D URL points a half-body ReadyPlayerMe GLB model readyplayerme-full: the avatar 3D URL points a full-body ReadyPlayerMe GLB model customglb: the avatar 3D URL points to a custom GLB model
If True during a Creation operation, the automatic
invitation e-mail is not sent, and the temporary password is
returned as part of the operation response.
Used during Creation operations. Ignored in other cases.
Optional referral URL from which the User reached the registration page.
Optional coupon code used by the User during Registration.
True if the e-mail address is subscribed to the newsletter.
Used during Registration and Update operations.
Returned during Get operations.
True if the User is an administrator, i.e. can administer
the tenant they are part of.
Used during Creation and Update operations by a super administrator.
Returned during Login and Get operations.
True if the User is a super administrator, i.e. can
administer all tenants.
Returned during Login and Get operations.
Ignored in other cases.
Current number of Memori objects belonging to this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Maximum number of Memori objects this User can create.
If 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Number of session in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Number of valid session in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Number of valid session in the current month for this User, with Deep Thought enabled. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Maximum number of free Memori sessions this User can open per month.
if 0> it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Cost of each new session above the max free sessions threshold.
Number of completions in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Number of completions in the current month for this User, with Deep Thought enabled. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Number of characters imported in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Maximum number of completions for this User per month.
if 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Maximum number of characters that can imported be by this User per month.
if 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
If True means this User has an actual payment
contract in effect and non-free sessions (i.e. sessions above
the max free session threshold) can be performed.
True if the User can create new Memori objects.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Board of Experts feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User access the DCM integration feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
If True this User accepts DCM outcomes and
consequently can receive badges in the Open Badge format.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Deep Thought feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Virtual Spaces feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
User date of birth. Necessary of age-restricted features, such as enabling completions or accessing NSFW content. Used during Registration and Update operations. Returned during Get operations.
Age computed from the birth date. Returned during Get operations. Ignored in other cases.
Terms & Conditions and Privacy Policy acceptance flag. May be reset to False in case of T. & C. and/or P. P. change. When False all operations that imply a change are blocked. Mandatory during Registration. Used during Update operations. Returned during Get operations.
Date of acceptance of Terms & Conditions and Privacy Policy. Returned during Get operations. Ignored in other cases.
Profiling & Commercial Use acceptance flag. May be reset to False in case of T. & C. and/or P. P. change. When False features that require profiling and may imply commercial communication to the User (e.g. Deep Thought) are disabled. Used during Registration and Update operations. Returned during Get operations.
Date of acceptance of Profiling & Commercial Use. Returned during Get operations. Ignored in other cases.
Verification code. May be required during Login or Registration operations if the User has MFA enabled or if a verification code has been sent. Ignored in other cases
Login flow ID. May be required during a Login operation if a previous Login or Registration operation did not succeed due to a challenge (password change, verification code etc.). Ignored in other cases.
Timestamp of creation. Returned during Get operations. Ignored in other cases.
Timestamp of latest change. Returned during Get operations. Ignored in other cases.
Success
Creation of User objects is granted only to administrative users.
The login token
Specifications of a User object.
Name of the Tenant this user is associated to. Required during Login and Registration operations. Returned during Get operations. Ignored in other cases.
User ID. Unique and assigned by the system. Returned during Login and Get operations. Ignored in other cases.
User name. Must be unique. Required during Login and Registration operations. Returned during Get operations. Ignored in other cases.
Password. Required during Login and Registration operations. Also required during Update operations if NewPassword is specified. Ignored in other cases.
New password. Used during Update and Login operations, if the user wants or must change password. Ignored in other cases.
E-mail address. Required during Registration operations. Used during Update operations. May be used as an alternative to UserName during Login operations. Returned during Get operations. The address is checked via a verification code.
URL of the avatar image representing the User. May be provided during Registration and Update operations. Returned during Login and Get operations.
URL of the avatar 3D model representing the User. May be provided during Registration and Update operations. Returned during Login and Get operations.
Additional information about the avatar 3D model URL, e.g. if it's a head-only, full-body avatar, custom model etc. Sample possible values are: readyplayerme: the avatar 3D URL points a half-body ReadyPlayerMe GLB model readyplayerme-full: the avatar 3D URL points a full-body ReadyPlayerMe GLB model customglb: the avatar 3D URL points to a custom GLB model
If True during a Creation operation, the automatic
invitation e-mail is not sent, and the temporary password is
returned as part of the operation response.
Used during Creation operations. Ignored in other cases.
Optional referral URL from which the User reached the registration page.
Optional coupon code used by the User during Registration.
True if the e-mail address is subscribed to the newsletter.
Used during Registration and Update operations.
Returned during Get operations.
True if the User is an administrator, i.e. can administer
the tenant they are part of.
Used during Creation and Update operations by a super administrator.
Returned during Login and Get operations.
True if the User is a super administrator, i.e. can
administer all tenants.
Returned during Login and Get operations.
Ignored in other cases.
Current number of Memori objects belonging to this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Maximum number of Memori objects this User can create.
If 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Number of session in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Number of valid session in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Number of valid session in the current month for this User, with Deep Thought enabled. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Maximum number of free Memori sessions this User can open per month.
if 0> it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Cost of each new session above the max free sessions threshold.
Number of completions in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Number of completions in the current month for this User, with Deep Thought enabled. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Number of characters imported in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Maximum number of completions for this User per month.
if 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Maximum number of characters that can imported be by this User per month.
if 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
If True means this User has an actual payment
contract in effect and non-free sessions (i.e. sessions above
the max free session threshold) can be performed.
True if the User can create new Memori objects.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Board of Experts feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User access the DCM integration feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
If True this User accepts DCM outcomes and
consequently can receive badges in the Open Badge format.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Deep Thought feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Virtual Spaces feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
User date of birth. Necessary of age-restricted features, such as enabling completions or accessing NSFW content. Used during Registration and Update operations. Returned during Get operations.
Age computed from the birth date. Returned during Get operations. Ignored in other cases.
Terms & Conditions and Privacy Policy acceptance flag. May be reset to False in case of T. & C. and/or P. P. change. When False all operations that imply a change are blocked. Mandatory during Registration. Used during Update operations. Returned during Get operations.
Date of acceptance of Terms & Conditions and Privacy Policy. Returned during Get operations. Ignored in other cases.
Profiling & Commercial Use acceptance flag. May be reset to False in case of T. & C. and/or P. P. change. When False features that require profiling and may imply commercial communication to the User (e.g. Deep Thought) are disabled. Used during Registration and Update operations. Returned during Get operations.
Date of acceptance of Profiling & Commercial Use. Returned during Get operations. Ignored in other cases.
Verification code. May be required during Login or Registration operations if the User has MFA enabled or if a verification code has been sent. Ignored in other cases
Login flow ID. May be required during a Login operation if a previous Login or Registration operation did not succeed due to a challenge (password change, verification code etc.). Ignored in other cases.
Timestamp of creation. Returned during Get operations. Ignored in other cases.
Timestamp of latest change. Returned during Get operations. Ignored in other cases.
Success
Access to User objects different than the current logged in user is granted only to administrative users.
The login token
The User object ID
Specifications of a User object.
Name of the Tenant this user is associated to. Required during Login and Registration operations. Returned during Get operations. Ignored in other cases.
User ID. Unique and assigned by the system. Returned during Login and Get operations. Ignored in other cases.
User name. Must be unique. Required during Login and Registration operations. Returned during Get operations. Ignored in other cases.
Password. Required during Login and Registration operations. Also required during Update operations if NewPassword is specified. Ignored in other cases.
New password. Used during Update and Login operations, if the user wants or must change password. Ignored in other cases.
E-mail address. Required during Registration operations. Used during Update operations. May be used as an alternative to UserName during Login operations. Returned during Get operations. The address is checked via a verification code.
URL of the avatar image representing the User. May be provided during Registration and Update operations. Returned during Login and Get operations.
URL of the avatar 3D model representing the User. May be provided during Registration and Update operations. Returned during Login and Get operations.
Additional information about the avatar 3D model URL, e.g. if it's a head-only, full-body avatar, custom model etc. Sample possible values are: readyplayerme: the avatar 3D URL points a half-body ReadyPlayerMe GLB model readyplayerme-full: the avatar 3D URL points a full-body ReadyPlayerMe GLB model customglb: the avatar 3D URL points to a custom GLB model
If True during a Creation operation, the automatic
invitation e-mail is not sent, and the temporary password is
returned as part of the operation response.
Used during Creation operations. Ignored in other cases.
Optional referral URL from which the User reached the registration page.
Optional coupon code used by the User during Registration.
True if the e-mail address is subscribed to the newsletter.
Used during Registration and Update operations.
Returned during Get operations.
True if the User is an administrator, i.e. can administer
the tenant they are part of.
Used during Creation and Update operations by a super administrator.
Returned during Login and Get operations.
True if the User is a super administrator, i.e. can
administer all tenants.
Returned during Login and Get operations.
Ignored in other cases.
Current number of Memori objects belonging to this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Maximum number of Memori objects this User can create.
If 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Number of session in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Number of valid session in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Number of valid session in the current month for this User, with Deep Thought enabled. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Maximum number of free Memori sessions this User can open per month.
if 0> it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Cost of each new session above the max free sessions threshold.
Number of completions in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Number of completions in the current month for this User, with Deep Thought enabled. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Number of characters imported in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Maximum number of completions for this User per month.
if 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Maximum number of characters that can imported be by this User per month.
if 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
If True means this User has an actual payment
contract in effect and non-free sessions (i.e. sessions above
the max free session threshold) can be performed.
True if the User can create new Memori objects.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Board of Experts feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User access the DCM integration feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
If True this User accepts DCM outcomes and
consequently can receive badges in the Open Badge format.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Deep Thought feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Virtual Spaces feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
User date of birth. Necessary of age-restricted features, such as enabling completions or accessing NSFW content. Used during Registration and Update operations. Returned during Get operations.
Age computed from the birth date. Returned during Get operations. Ignored in other cases.
Terms & Conditions and Privacy Policy acceptance flag. May be reset to False in case of T. & C. and/or P. P. change. When False all operations that imply a change are blocked. Mandatory during Registration. Used during Update operations. Returned during Get operations.
Date of acceptance of Terms & Conditions and Privacy Policy. Returned during Get operations. Ignored in other cases.
Profiling & Commercial Use acceptance flag. May be reset to False in case of T. & C. and/or P. P. change. When False features that require profiling and may imply commercial communication to the User (e.g. Deep Thought) are disabled. Used during Registration and Update operations. Returned during Get operations.
Date of acceptance of Profiling & Commercial Use. Returned during Get operations. Ignored in other cases.
Verification code. May be required during Login or Registration operations if the User has MFA enabled or if a verification code has been sent. Ignored in other cases
Login flow ID. May be required during a Login operation if a previous Login or Registration operation did not succeed due to a challenge (password change, verification code etc.). Ignored in other cases.
Timestamp of creation. Returned during Get operations. Ignored in other cases.
Timestamp of latest change. Returned during Get operations. Ignored in other cases.
Success
The login token
The starting date of the filter
The end date of the filter
The tenant name to filter the users.
A search query to filter the users
Optional number of results. If omitted defaults to 5.
Optional initial result index, 0-based. If omitted defaults to 0. Used for Search, Filter Memories and Memory Hints. Ignored for Random picking.
Optional order by field. If omitted defaults to CreationDate. Can be one of the following: CreationDateAscending: the results are ordered by creation date in ascending order. CreationDateDescending: the results are ordered by creation date in descending order. MemoriCountAscending: the results are ordered by Memori count in ascending order. MemoriCountDescending: the results are ordered by Memori count in descending order. MonthCompletionsAscending: the results are ordered by month completions in ascending order. MonthCompletionsDescending: the results are ordered by month completions in descending order. MonthImportSizeAscending: the results are ordered by month import size in ascending order. MonthImportSizeDescending: the results are ordered by month import size in descending order.
Success
If registration succeeds, the User receives a verification code via e-mail.
The code must be sent via the UserConfirm API, passing the same
User object sent to this API with the addition of the verification code.
Specifications of a User object.
Name of the Tenant this user is associated to. Required during Login and Registration operations. Returned during Get operations. Ignored in other cases.
User ID. Unique and assigned by the system. Returned during Login and Get operations. Ignored in other cases.
User name. Must be unique. Required during Login and Registration operations. Returned during Get operations. Ignored in other cases.
Password. Required during Login and Registration operations. Also required during Update operations if NewPassword is specified. Ignored in other cases.
New password. Used during Update and Login operations, if the user wants or must change password. Ignored in other cases.
E-mail address. Required during Registration operations. Used during Update operations. May be used as an alternative to UserName during Login operations. Returned during Get operations. The address is checked via a verification code.
URL of the avatar image representing the User. May be provided during Registration and Update operations. Returned during Login and Get operations.
URL of the avatar 3D model representing the User. May be provided during Registration and Update operations. Returned during Login and Get operations.
Additional information about the avatar 3D model URL, e.g. if it's a head-only, full-body avatar, custom model etc. Sample possible values are: readyplayerme: the avatar 3D URL points a half-body ReadyPlayerMe GLB model readyplayerme-full: the avatar 3D URL points a full-body ReadyPlayerMe GLB model customglb: the avatar 3D URL points to a custom GLB model
If True during a Creation operation, the automatic
invitation e-mail is not sent, and the temporary password is
returned as part of the operation response.
Used during Creation operations. Ignored in other cases.
Optional referral URL from which the User reached the registration page.
Optional coupon code used by the User during Registration.
True if the e-mail address is subscribed to the newsletter.
Used during Registration and Update operations.
Returned during Get operations.
True if the User is an administrator, i.e. can administer
the tenant they are part of.
Used during Creation and Update operations by a super administrator.
Returned during Login and Get operations.
True if the User is a super administrator, i.e. can
administer all tenants.
Returned during Login and Get operations.
Ignored in other cases.
Current number of Memori objects belonging to this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Maximum number of Memori objects this User can create.
If 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Number of session in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Number of valid session in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Number of valid session in the current month for this User, with Deep Thought enabled. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Maximum number of free Memori sessions this User can open per month.
if 0> it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Cost of each new session above the max free sessions threshold.
Number of completions in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Number of completions in the current month for this User, with Deep Thought enabled. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Number of characters imported in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Maximum number of completions for this User per month.
if 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Maximum number of characters that can imported be by this User per month.
if 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
If True means this User has an actual payment
contract in effect and non-free sessions (i.e. sessions above
the max free session threshold) can be performed.
True if the User can create new Memori objects.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Board of Experts feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User access the DCM integration feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
If True this User accepts DCM outcomes and
consequently can receive badges in the Open Badge format.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Deep Thought feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Virtual Spaces feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
User date of birth. Necessary of age-restricted features, such as enabling completions or accessing NSFW content. Used during Registration and Update operations. Returned during Get operations.
Age computed from the birth date. Returned during Get operations. Ignored in other cases.
Terms & Conditions and Privacy Policy acceptance flag. May be reset to False in case of T. & C. and/or P. P. change. When False all operations that imply a change are blocked. Mandatory during Registration. Used during Update operations. Returned during Get operations.
Date of acceptance of Terms & Conditions and Privacy Policy. Returned during Get operations. Ignored in other cases.
Profiling & Commercial Use acceptance flag. May be reset to False in case of T. & C. and/or P. P. change. When False features that require profiling and may imply commercial communication to the User (e.g. Deep Thought) are disabled. Used during Registration and Update operations. Returned during Get operations.
Date of acceptance of Profiling & Commercial Use. Returned during Get operations. Ignored in other cases.
Verification code. May be required during Login or Registration operations if the User has MFA enabled or if a verification code has been sent. Ignored in other cases
Login flow ID. May be required during a Login operation if a previous Login or Registration operation did not succeed due to a challenge (password change, verification code etc.). Ignored in other cases.
Timestamp of creation. Returned during Get operations. Ignored in other cases.
Timestamp of latest change. Returned during Get operations. Ignored in other cases.
Success
Specifications of a User object.
Name of the Tenant this user is associated to. Required during Login and Registration operations. Returned during Get operations. Ignored in other cases.
User ID. Unique and assigned by the system. Returned during Login and Get operations. Ignored in other cases.
User name. Must be unique. Required during Login and Registration operations. Returned during Get operations. Ignored in other cases.
Password. Required during Login and Registration operations. Also required during Update operations if NewPassword is specified. Ignored in other cases.
New password. Used during Update and Login operations, if the user wants or must change password. Ignored in other cases.
E-mail address. Required during Registration operations. Used during Update operations. May be used as an alternative to UserName during Login operations. Returned during Get operations. The address is checked via a verification code.
URL of the avatar image representing the User. May be provided during Registration and Update operations. Returned during Login and Get operations.
URL of the avatar 3D model representing the User. May be provided during Registration and Update operations. Returned during Login and Get operations.
Additional information about the avatar 3D model URL, e.g. if it's a head-only, full-body avatar, custom model etc. Sample possible values are: readyplayerme: the avatar 3D URL points a half-body ReadyPlayerMe GLB model readyplayerme-full: the avatar 3D URL points a full-body ReadyPlayerMe GLB model customglb: the avatar 3D URL points to a custom GLB model
If True during a Creation operation, the automatic
invitation e-mail is not sent, and the temporary password is
returned as part of the operation response.
Used during Creation operations. Ignored in other cases.
Optional referral URL from which the User reached the registration page.
Optional coupon code used by the User during Registration.
True if the e-mail address is subscribed to the newsletter.
Used during Registration and Update operations.
Returned during Get operations.
True if the User is an administrator, i.e. can administer
the tenant they are part of.
Used during Creation and Update operations by a super administrator.
Returned during Login and Get operations.
True if the User is a super administrator, i.e. can
administer all tenants.
Returned during Login and Get operations.
Ignored in other cases.
Current number of Memori objects belonging to this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Maximum number of Memori objects this User can create.
If 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Number of session in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Number of valid session in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Number of valid session in the current month for this User, with Deep Thought enabled. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Maximum number of free Memori sessions this User can open per month.
if 0> it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Cost of each new session above the max free sessions threshold.
Number of completions in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Number of completions in the current month for this User, with Deep Thought enabled. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Number of characters imported in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Maximum number of completions for this User per month.
if 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Maximum number of characters that can imported be by this User per month.
if 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
If True means this User has an actual payment
contract in effect and non-free sessions (i.e. sessions above
the max free session threshold) can be performed.
True if the User can create new Memori objects.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Board of Experts feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User access the DCM integration feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
If True this User accepts DCM outcomes and
consequently can receive badges in the Open Badge format.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Deep Thought feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Virtual Spaces feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
User date of birth. Necessary of age-restricted features, such as enabling completions or accessing NSFW content. Used during Registration and Update operations. Returned during Get operations.
Age computed from the birth date. Returned during Get operations. Ignored in other cases.
Terms & Conditions and Privacy Policy acceptance flag. May be reset to False in case of T. & C. and/or P. P. change. When False all operations that imply a change are blocked. Mandatory during Registration. Used during Update operations. Returned during Get operations.
Date of acceptance of Terms & Conditions and Privacy Policy. Returned during Get operations. Ignored in other cases.
Profiling & Commercial Use acceptance flag. May be reset to False in case of T. & C. and/or P. P. change. When False features that require profiling and may imply commercial communication to the User (e.g. Deep Thought) are disabled. Used during Registration and Update operations. Returned during Get operations.
Date of acceptance of Profiling & Commercial Use. Returned during Get operations. Ignored in other cases.
Verification code. May be required during Login or Registration operations if the User has MFA enabled or if a verification code has been sent. Ignored in other cases
Login flow ID. May be required during a Login operation if a previous Login or Registration operation did not succeed due to a challenge (password change, verification code etc.). Ignored in other cases.
Timestamp of creation. Returned during Get operations. Ignored in other cases.
Timestamp of latest change. Returned during Get operations. Ignored in other cases.
Success
Specifications of a User object.
Name of the Tenant this user is associated to. Required during Login and Registration operations. Returned during Get operations. Ignored in other cases.
User ID. Unique and assigned by the system. Returned during Login and Get operations. Ignored in other cases.
User name. Must be unique. Required during Login and Registration operations. Returned during Get operations. Ignored in other cases.
Password. Required during Login and Registration operations. Also required during Update operations if NewPassword is specified. Ignored in other cases.
New password. Used during Update and Login operations, if the user wants or must change password. Ignored in other cases.
E-mail address. Required during Registration operations. Used during Update operations. May be used as an alternative to UserName during Login operations. Returned during Get operations. The address is checked via a verification code.
URL of the avatar image representing the User. May be provided during Registration and Update operations. Returned during Login and Get operations.
URL of the avatar 3D model representing the User. May be provided during Registration and Update operations. Returned during Login and Get operations.
Additional information about the avatar 3D model URL, e.g. if it's a head-only, full-body avatar, custom model etc. Sample possible values are: readyplayerme: the avatar 3D URL points a half-body ReadyPlayerMe GLB model readyplayerme-full: the avatar 3D URL points a full-body ReadyPlayerMe GLB model customglb: the avatar 3D URL points to a custom GLB model
If True during a Creation operation, the automatic
invitation e-mail is not sent, and the temporary password is
returned as part of the operation response.
Used during Creation operations. Ignored in other cases.
Optional referral URL from which the User reached the registration page.
Optional coupon code used by the User during Registration.
True if the e-mail address is subscribed to the newsletter.
Used during Registration and Update operations.
Returned during Get operations.
True if the User is an administrator, i.e. can administer
the tenant they are part of.
Used during Creation and Update operations by a super administrator.
Returned during Login and Get operations.
True if the User is a super administrator, i.e. can
administer all tenants.
Returned during Login and Get operations.
Ignored in other cases.
Current number of Memori objects belonging to this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Maximum number of Memori objects this User can create.
If 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Number of session in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Number of valid session in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Number of valid session in the current month for this User, with Deep Thought enabled. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Maximum number of free Memori sessions this User can open per month.
if 0> it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Cost of each new session above the max free sessions threshold.
Number of completions in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Number of completions in the current month for this User, with Deep Thought enabled. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Number of characters imported in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Maximum number of completions for this User per month.
if 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Maximum number of characters that can imported be by this User per month.
if 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
If True means this User has an actual payment
contract in effect and non-free sessions (i.e. sessions above
the max free session threshold) can be performed.
True if the User can create new Memori objects.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Board of Experts feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User access the DCM integration feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
If True this User accepts DCM outcomes and
consequently can receive badges in the Open Badge format.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Deep Thought feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Virtual Spaces feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
User date of birth. Necessary of age-restricted features, such as enabling completions or accessing NSFW content. Used during Registration and Update operations. Returned during Get operations.
Age computed from the birth date. Returned during Get operations. Ignored in other cases.
Terms & Conditions and Privacy Policy acceptance flag. May be reset to False in case of T. & C. and/or P. P. change. When False all operations that imply a change are blocked. Mandatory during Registration. Used during Update operations. Returned during Get operations.
Date of acceptance of Terms & Conditions and Privacy Policy. Returned during Get operations. Ignored in other cases.
Profiling & Commercial Use acceptance flag. May be reset to False in case of T. & C. and/or P. P. change. When False features that require profiling and may imply commercial communication to the User (e.g. Deep Thought) are disabled. Used during Registration and Update operations. Returned during Get operations.
Date of acceptance of Profiling & Commercial Use. Returned during Get operations. Ignored in other cases.
Verification code. May be required during Login or Registration operations if the User has MFA enabled or if a verification code has been sent. Ignored in other cases
Login flow ID. May be required during a Login operation if a previous Login or Registration operation did not succeed due to a challenge (password change, verification code etc.). Ignored in other cases.
Timestamp of creation. Returned during Get operations. Ignored in other cases.
Timestamp of latest change. Returned during Get operations. Ignored in other cases.
Success
If found, the User receives a verification code via e-mail.
The code must be sent via the ResetConfirm API, passing the same
User object sent to this API with the addition of the verification code
and the new password.
Specifications of a User object.
Name of the Tenant this user is associated to. Required during Login and Registration operations. Returned during Get operations. Ignored in other cases.
User ID. Unique and assigned by the system. Returned during Login and Get operations. Ignored in other cases.
User name. Must be unique. Required during Login and Registration operations. Returned during Get operations. Ignored in other cases.
Password. Required during Login and Registration operations. Also required during Update operations if NewPassword is specified. Ignored in other cases.
New password. Used during Update and Login operations, if the user wants or must change password. Ignored in other cases.
E-mail address. Required during Registration operations. Used during Update operations. May be used as an alternative to UserName during Login operations. Returned during Get operations. The address is checked via a verification code.
URL of the avatar image representing the User. May be provided during Registration and Update operations. Returned during Login and Get operations.
URL of the avatar 3D model representing the User. May be provided during Registration and Update operations. Returned during Login and Get operations.
Additional information about the avatar 3D model URL, e.g. if it's a head-only, full-body avatar, custom model etc. Sample possible values are: readyplayerme: the avatar 3D URL points a half-body ReadyPlayerMe GLB model readyplayerme-full: the avatar 3D URL points a full-body ReadyPlayerMe GLB model customglb: the avatar 3D URL points to a custom GLB model
If True during a Creation operation, the automatic
invitation e-mail is not sent, and the temporary password is
returned as part of the operation response.
Used during Creation operations. Ignored in other cases.
Optional referral URL from which the User reached the registration page.
Optional coupon code used by the User during Registration.
True if the e-mail address is subscribed to the newsletter.
Used during Registration and Update operations.
Returned during Get operations.
True if the User is an administrator, i.e. can administer
the tenant they are part of.
Used during Creation and Update operations by a super administrator.
Returned during Login and Get operations.
True if the User is a super administrator, i.e. can
administer all tenants.
Returned during Login and Get operations.
Ignored in other cases.
Current number of Memori objects belonging to this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Maximum number of Memori objects this User can create.
If 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Number of session in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Number of valid session in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Number of valid session in the current month for this User, with Deep Thought enabled. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Maximum number of free Memori sessions this User can open per month.
if 0> it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Cost of each new session above the max free sessions threshold.
Number of completions in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Number of completions in the current month for this User, with Deep Thought enabled. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Number of characters imported in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Maximum number of completions for this User per month.
if 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Maximum number of characters that can imported be by this User per month.
if 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
If True means this User has an actual payment
contract in effect and non-free sessions (i.e. sessions above
the max free session threshold) can be performed.
True if the User can create new Memori objects.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Board of Experts feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User access the DCM integration feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
If True this User accepts DCM outcomes and
consequently can receive badges in the Open Badge format.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Deep Thought feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Virtual Spaces feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
User date of birth. Necessary of age-restricted features, such as enabling completions or accessing NSFW content. Used during Registration and Update operations. Returned during Get operations.
Age computed from the birth date. Returned during Get operations. Ignored in other cases.
Terms & Conditions and Privacy Policy acceptance flag. May be reset to False in case of T. & C. and/or P. P. change. When False all operations that imply a change are blocked. Mandatory during Registration. Used during Update operations. Returned during Get operations.
Date of acceptance of Terms & Conditions and Privacy Policy. Returned during Get operations. Ignored in other cases.
Profiling & Commercial Use acceptance flag. May be reset to False in case of T. & C. and/or P. P. change. When False features that require profiling and may imply commercial communication to the User (e.g. Deep Thought) are disabled. Used during Registration and Update operations. Returned during Get operations.
Date of acceptance of Profiling & Commercial Use. Returned during Get operations. Ignored in other cases.
Verification code. May be required during Login or Registration operations if the User has MFA enabled or if a verification code has been sent. Ignored in other cases
Login flow ID. May be required during a Login operation if a previous Login or Registration operation did not succeed due to a challenge (password change, verification code etc.). Ignored in other cases.
Timestamp of creation. Returned during Get operations. Ignored in other cases.
Timestamp of latest change. Returned during Get operations. Ignored in other cases.
Success
Specifications of a User object.
Name of the Tenant this user is associated to. Required during Login and Registration operations. Returned during Get operations. Ignored in other cases.
User ID. Unique and assigned by the system. Returned during Login and Get operations. Ignored in other cases.
User name. Must be unique. Required during Login and Registration operations. Returned during Get operations. Ignored in other cases.
Password. Required during Login and Registration operations. Also required during Update operations if NewPassword is specified. Ignored in other cases.
New password. Used during Update and Login operations, if the user wants or must change password. Ignored in other cases.
E-mail address. Required during Registration operations. Used during Update operations. May be used as an alternative to UserName during Login operations. Returned during Get operations. The address is checked via a verification code.
URL of the avatar image representing the User. May be provided during Registration and Update operations. Returned during Login and Get operations.
URL of the avatar 3D model representing the User. May be provided during Registration and Update operations. Returned during Login and Get operations.
Additional information about the avatar 3D model URL, e.g. if it's a head-only, full-body avatar, custom model etc. Sample possible values are: readyplayerme: the avatar 3D URL points a half-body ReadyPlayerMe GLB model readyplayerme-full: the avatar 3D URL points a full-body ReadyPlayerMe GLB model customglb: the avatar 3D URL points to a custom GLB model
If True during a Creation operation, the automatic
invitation e-mail is not sent, and the temporary password is
returned as part of the operation response.
Used during Creation operations. Ignored in other cases.
Optional referral URL from which the User reached the registration page.
Optional coupon code used by the User during Registration.
True if the e-mail address is subscribed to the newsletter.
Used during Registration and Update operations.
Returned during Get operations.
True if the User is an administrator, i.e. can administer
the tenant they are part of.
Used during Creation and Update operations by a super administrator.
Returned during Login and Get operations.
True if the User is a super administrator, i.e. can
administer all tenants.
Returned during Login and Get operations.
Ignored in other cases.
Current number of Memori objects belonging to this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Maximum number of Memori objects this User can create.
If 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Number of session in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Number of valid session in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Number of valid session in the current month for this User, with Deep Thought enabled. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Maximum number of free Memori sessions this User can open per month.
if 0> it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Cost of each new session above the max free sessions threshold.
Number of completions in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Number of completions in the current month for this User, with Deep Thought enabled. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Number of characters imported in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Maximum number of completions for this User per month.
if 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Maximum number of characters that can imported be by this User per month.
if 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
If True means this User has an actual payment
contract in effect and non-free sessions (i.e. sessions above
the max free session threshold) can be performed.
True if the User can create new Memori objects.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Board of Experts feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User access the DCM integration feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
If True this User accepts DCM outcomes and
consequently can receive badges in the Open Badge format.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Deep Thought feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Virtual Spaces feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
User date of birth. Necessary of age-restricted features, such as enabling completions or accessing NSFW content. Used during Registration and Update operations. Returned during Get operations.
Age computed from the birth date. Returned during Get operations. Ignored in other cases.
Terms & Conditions and Privacy Policy acceptance flag. May be reset to False in case of T. & C. and/or P. P. change. When False all operations that imply a change are blocked. Mandatory during Registration. Used during Update operations. Returned during Get operations.
Date of acceptance of Terms & Conditions and Privacy Policy. Returned during Get operations. Ignored in other cases.
Profiling & Commercial Use acceptance flag. May be reset to False in case of T. & C. and/or P. P. change. When False features that require profiling and may imply commercial communication to the User (e.g. Deep Thought) are disabled. Used during Registration and Update operations. Returned during Get operations.
Date of acceptance of Profiling & Commercial Use. Returned during Get operations. Ignored in other cases.
Verification code. May be required during Login or Registration operations if the User has MFA enabled or if a verification code has been sent. Ignored in other cases
Login flow ID. May be required during a Login operation if a previous Login or Registration operation did not succeed due to a challenge (password change, verification code etc.). Ignored in other cases.
Timestamp of creation. Returned during Get operations. Ignored in other cases.
Timestamp of latest change. Returned during Get operations. Ignored in other cases.
Success
Specifications of a User object.
Name of the Tenant this user is associated to. Required during Login and Registration operations. Returned during Get operations. Ignored in other cases.
User ID. Unique and assigned by the system. Returned during Login and Get operations. Ignored in other cases.
User name. Must be unique. Required during Login and Registration operations. Returned during Get operations. Ignored in other cases.
Password. Required during Login and Registration operations. Also required during Update operations if NewPassword is specified. Ignored in other cases.
New password. Used during Update and Login operations, if the user wants or must change password. Ignored in other cases.
E-mail address. Required during Registration operations. Used during Update operations. May be used as an alternative to UserName during Login operations. Returned during Get operations. The address is checked via a verification code.
URL of the avatar image representing the User. May be provided during Registration and Update operations. Returned during Login and Get operations.
URL of the avatar 3D model representing the User. May be provided during Registration and Update operations. Returned during Login and Get operations.
Additional information about the avatar 3D model URL, e.g. if it's a head-only, full-body avatar, custom model etc. Sample possible values are: readyplayerme: the avatar 3D URL points a half-body ReadyPlayerMe GLB model readyplayerme-full: the avatar 3D URL points a full-body ReadyPlayerMe GLB model customglb: the avatar 3D URL points to a custom GLB model
If True during a Creation operation, the automatic
invitation e-mail is not sent, and the temporary password is
returned as part of the operation response.
Used during Creation operations. Ignored in other cases.
Optional referral URL from which the User reached the registration page.
Optional coupon code used by the User during Registration.
True if the e-mail address is subscribed to the newsletter.
Used during Registration and Update operations.
Returned during Get operations.
True if the User is an administrator, i.e. can administer
the tenant they are part of.
Used during Creation and Update operations by a super administrator.
Returned during Login and Get operations.
True if the User is a super administrator, i.e. can
administer all tenants.
Returned during Login and Get operations.
Ignored in other cases.
Current number of Memori objects belonging to this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Maximum number of Memori objects this User can create.
If 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Number of session in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Number of valid session in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Number of valid session in the current month for this User, with Deep Thought enabled. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user themself.
Maximum number of free Memori sessions this User can open per month.
if 0> it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Cost of each new session above the max free sessions threshold.
Number of completions in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Number of completions in the current month for this User, with Deep Thought enabled. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Number of characters imported in the current month for this User. Returned during Get and Login operations. Ignored in other cases. Visible only to administrators and the user itself.
Maximum number of completions for this User per month.
if 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
Maximum number of characters that can imported be by this User per month.
if 0 it means unlimited.
Used during Creation and Update operations by a super administrator.
Returned during Get and Login operations.
If True means this User has an actual payment
contract in effect and non-free sessions (i.e. sessions above
the max free session threshold) can be performed.
True if the User can create new Memori objects.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Board of Experts feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User access the DCM integration feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
If True this User accepts DCM outcomes and
consequently can receive badges in the Open Badge format.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Deep Thought feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
True if the User can access the Virtual Spaces feature.
Used during Creation and Update operations by an administrator.
Returned during Get and Login operations.
User date of birth. Necessary of age-restricted features, such as enabling completions or accessing NSFW content. Used during Registration and Update operations. Returned during Get operations.
Age computed from the birth date. Returned during Get operations. Ignored in other cases.
Terms & Conditions and Privacy Policy acceptance flag. May be reset to False in case of T. & C. and/or P. P. change. When False all operations that imply a change are blocked. Mandatory during Registration. Used during Update operations. Returned during Get operations.
Date of acceptance of Terms & Conditions and Privacy Policy. Returned during Get operations. Ignored in other cases.
Profiling & Commercial Use acceptance flag. May be reset to False in case of T. & C. and/or P. P. change. When False features that require profiling and may imply commercial communication to the User (e.g. Deep Thought) are disabled. Used during Registration and Update operations. Returned during Get operations.
Date of acceptance of Profiling & Commercial Use. Returned during Get operations. Ignored in other cases.
Verification code. May be required during Login or Registration operations if the User has MFA enabled or if a verification code has been sent. Ignored in other cases
Login flow ID. May be required during a Login operation if a previous Login or Registration operation did not succeed due to a challenge (password change, verification code etc.). Ignored in other cases.
Timestamp of creation. Returned during Get operations. Ignored in other cases.
Timestamp of latest change. Returned during Get operations. Ignored in other cases.
Success