User Properties¶
When a user registers with an application, he provides information which establishes user's identity. For one application these properties may include name, phone number and email address, for another it could be user id, age and gender. Backendless User Service allows each application to have a custom set of properties associated with the user entity.
Retrieving properties with the API¶
Endpoint URL¶
The xxxx.backendless.app
is a subdomain assigned to your application. For more information see the Client-side Setup section of this documentation.
https://xxxx.backendless.app/api/users/<user_objectId>?props=propname1,propname2
where:
Argument | Description |
---|---|
<user_objectId> |
objectId of the user object for which to load the values of the specified properties. |
propname1, propname2 |
names of the properties for which to load the corresponding values. |
Request Body¶
None
Response Body¶
{
"propName1" : value,
"propName2": value,
}
Defining properties with Console¶
User property management is available in the schema editor of the Users
table. To open the schema editor:
- Login to Backendless Console and select your application.
- Click the Data icon, and select the Users table.
- Click the Schema menu.
There are built-in user properties, such as email
, name
and password
. The email
and name
properties can be deleted if they do not apply to your app, although it is recommended to keep the email
property, since it is used for other purposes (for instance, password recovery). The password
property cannot be deleted.
Identity Property/Column¶
It is required that one of the properties is marked as identity. This is the property Backendless uses for the Login and Restore Password operations. As users register, Backendless ensures the value for the identity property is unique.
Password Property/Column¶
"password"
is a special property/column. Backendless automatically adds the column when an application is created. The following rules apply to the password column:
- Password cannot be removed from the application.
- Password cannot be used as identity.
- Password is a required property