User Account

Your registered user's identity

User Accounts

User accounts represent authenticated individuals who interact with the application. They are used for identity and access management.

When a user authenticated via Google, Facebook, or another provider attempts to create an access token for the first time, a User Account object is automatically created for them.

UserAccount Object Attributes

Name	Type	Description
id	String	The UserAccount object ID (generated by Objects Grid platform)
disabled	Boolean	Is the Organization disabled
tags	Array of Tag	Array of Tag
accessPoint*	String	The Organization AccessPoint (required attribute)
name*	String	The UserAccount Name (required attribute)
value	String	The UserAccount Value
tags	Array of Tag	Array of Tag Objects
meta	Object Meta	Object's meta data, read only

UserAccountInfo Object

User Account Info object is used for Create User Account requests. It combines the information needed for User Account with the Individual's private information.

Organization Account administrators can create User Accounts, but they must provide the individual's email, issuer (iss), and subject (sub) from their respective identity provider. This is expected to be rarely used, primarily for data imports when a private identity provider is involved. All identity providers must be OIDC-compliant.

Name	Type	Description
email*	string	The User email
givenName	string	The User given name
middleName	string	The User middle name
familyName	string	The User family name
address	string	The User address
countryCode	string	The Organization Country Code in ISO-3166
city	string	The User city
postalCode	integer	The User Postal Code
phone	string	The User phone
iss*	string	External OpenID Provider, ID Token claim 'iss' issuer
sub*	string	External OpenID Provider, ID Token claim 'sub' subject

UserPrivateInformation Object

The UserPrivateInformation object contains the individual's private information. It is separated from the UserAccount, and only stored in this object.

For acting on a Right to be Forgotten (RTBF) request, deleting the User Private Information object is sufficient. (GDPR, CCPA compliance). The Right to be Forgotten is a privacy right that allows individuals to request the deletion of their personal data.

Name	Type	Description
id*	string	The unique identifier for an Object
email	string	The User email
givenName	string	The User given name
middleName	string	The User middle name
familyName	string	The User family name
address	string	The User address
countryCode	string	The Organization Country Code in ISO-3166
city	string	The User city
postalCode	integer	The User Postal Code
phone	string	The User phone
iss	strings	The id token issuer (iss)
sub	string	The id token subject (sub)
tags	Array of Tag	Array of Tag Objects
meta	Object Meta	Object's meta data, read only

---

Contact Support

---