User
No description
type User implements HasModelsInterface, HasRecordsInterface, LegacyCustomAttributeInterface, PropertiesInterface {
address(name: String!): CustomAddrress
addresses(name: String): [CustomAddrress!]
attachment(name: String!): PrivateFile
attachments(name: String): [PrivateFile!]
authenticate: Authenticate!
authentications: [Authentication!]
communication: Communication
created_at: JSONDate
custom_address(name: String!): CustomAddrress
custom_addresses(name: String): [CustomAddrress!]
custom_attachment(name: String!): PrivateFile
custom_attachments(name: String): [PrivateFile!]
custom_image(name: String!): Image
custom_images(name: String): [Image!]
customizations(name: String, user_id: ID): [Customization!]
deleted_at: JSONDate
email: String!
encrypted_password: String
external_id: String
first_name: String
id: ID
image(name: String!): Image
images(name: String): [Image!]
jwt_token(algorithm: JwtAlgorithm = HS256): String
language: String
last_name: String
middle_name: String
model(
filter: ModelsFilterInput
foreign_property: String = "id"
join_on_property: String!
model_name: [String]!
sort: [ModelsSortInput!]
): Model
models(
foreign_property: String!
join_on_property: String!
limit: Int
model_name: [String]!
sort: [ModelsSortInput!]
): [Model!]
name: String
otp: Otp!
profile(profile_type: String!): Profile
profiles(profile_type: String): [Profile!]!
properties: HashObject
property(name: String!): String
property_array(name: String!): [String!]
property_boolean(name: String!): Boolean
property_float(name: String!): Float
property_int(name: String!): Int
property_json(name: String!): JSONPayload
property_object(name: String!): HashObject
property_upload(expires_in: Int, name: String!): PropertyUpload
related_model(
filter: ModelsFilterInput
foreign_property: String = "id"
join_on_property: String!
model_schema_name: [String]!
sort: [ModelsSortInput!]
): Model
related_models(
filter: ModelsFilterInput
foreign_property: String!
join_on_property: String!
limit: Int
model_schema_name: [String]!
sort: [ModelsSortInput!]
): [Model!]
related_record(
filter: RecordsFilterInput
foreign_property: String = "id"
join_on_property: String!
sort: [RecordsSortInput!]
table: [String]!
): Record
related_records(
filter: RecordsFilterInput
foreign_property: String!
join_on_property: String!
limit: Int
sort: [RecordsSortInput!]
table: [String]!
): [Record!]
related_user(
filter: ModelsFilterInput
foreign_property: String = "id"
join_on_property: String = "user_id"
sort: [UsersSortInput!]
): User
related_users(
filter: ModelsFilterInput
foreign_property: String!
join_on_property: String!
limit: Int
sort: [UsersSortInput!]
): [User!]
slug: String!
social_friends(page: Int = 1, per_page: Int = 20): UserCollection
temporary_token(expires_in: Float = 48, valid_for: Int): String
transactables: [Transactable!]
updated_at: JSONDate
user(
foreign_property: String = "id"
join_on_property: String = "user_id"
sort: [UsersSortInput!]
): User
users(
foreign_property: String!
join_on_property: String!
limit: Int
sort: [UsersSortInput!]
): [User!]
}
Fields
address (CustomAddrress)
Fetch address by name; ex: address: address(name: "office_address")
-
name(String)
addresses (CustomAddrress)
Fetch all addresses, optionally you can filter results by name; ex: home_address: addresses(name: "home")
-
name(String)
attachment (PrivateFile)
Fetch attachment by name; ex: sales_report: attachment(name: "sales_report")
-
name(String)
attachments (PrivateFile)
Fetch all attachments, optionally you can filter results by name; ex: sales_reports: attachments(name: "sales_report")
-
name(String)
authenticate (Authenticate)
Validate user credentials
authentications (Authentication)
stores information about user integrations with authentication providers like auth0, facebook, twitter etc
communication (Communication)
used for twilio click-to-call integraation to verify phone number
created_at (JSONDate)
timestamp of when the record was created, automatically generated by the system
custom_address (CustomAddrress)
Fetch address by name; ex: address: custom_address(name: "office_address")
-
name(String)
custom_addresses (CustomAddrress)
Fetch all addresses, optionaly you can filter results by name; ex: home: custom_addresses(name: "home")
-
name(String)
custom_attachment (PrivateFile)
Fetch attachment by name; ex: sales_report: custom_attachment(name: "sales_report")
-
name(String)
custom_attachments (PrivateFile)
Fetch all attachments, optionally you can filter results by name; ex:
sales_reports: custom_attachments(name: "sales_report")
-
name(String)
custom_image (Image)
Fetch image by name; ex: header: custom_image(name: "header")
-
name(String)
custom_images (Image)
Fetch all images, optionaly you can filter results by name; ex: cat_images: custom_images(name: "cat")
-
name(String)
customizations (Customization)
-
name(String)
model schema name
-
user_id(ID)
ID of user that created customization
deleted_at (JSONDate)
timestamp of when the record was soft delete, populated by delete action. It
is also possible to manually set it via update. To undelete change it back to
empty value, but please note that associated records would need to be manually
undeleted as well.
email (String)
encrypted_password (String)
external_id (String)
Used mainly for import/export, if you want to use third party service as a source of truth
first_name (String)
id (ID)
ID of an object.
image (Image)
Fetch image by name; ex: header: image(name: "header")
-
name(String)
images (Image)
Fetch all images, optionally you can filter results by name; ex: cat_images: images(name: "cat")
-
name(String)
jwt_token (String)
JWT token that can be used for authentication
-
algorithm(JwtAlgorithm)
language (String)
Used by translations to set the language of currently logged in user
last_name (String)
middle_name (String)
model (Model)
Defines has-one relation with other model, e.g: children: models(model_name:
"child" join_on_property: "parent_id" foreign_property: "parent_id") { id }
-
filter(ModelsFilterInput) -
foreign_property(String)
Load resources with foreign_property == join_on_property
-
join_on_property(String)
Load resources with foreign_property == join_on_property
-
model_name(String)
Joins model [formaly customization] with model-schema-name == model_name
-
sort(ModelsSortInput)
models (Model)
Defines has-many relation with other model; ex: children: models(model_name:
"child", join_on_property: "parent_id", foreign_property: "parent_id") { id }
-
foreign_property(String)
Load resources with foreign_property == join_on_property
-
join_on_property(String)
Load resources with foreign_property == join_on_property
Joins model [formaly customization] with model-schema-name == model_name
-
sort(ModelsSortInput)
name (String)
otp (Otp)
Two factor authentication with TOTP(time based one time password)
profile (Profile)
-
profile_type(String)
profiles (Profile)
associated user profiles, which can be used as user role or namespace for certain group of user properties
-
profile_type(String)
properties (HashObject)
List of all properties assigned to the object.
property (String)
Fetch any property by name and return value as a String; ex: hair_color: property(name: "hair_color")
-
name(String)
property_array (String)
Fetch any property by name and return value as an Array of Strings. ex: todo_list: property_array(name: "todo_list")
-
name(String)
property_boolean (Boolean)
Fetch any property by name and return value as a Boolean; ex: price: property_boolean(name: "enabled")
-
name(String)
property_float (Float)
Fetch any property by name and return value as a Float; ex: price: property_float(name: "price")
-
name(String)
property_int (Int)
Fetch any property by name and return value as an Integer; ex: age: property_int(name: "age")
-
name(String)
property_json (JSONPayload)
Fetch any property by name and return value as a JSON string.
-
name(String)
property_object (HashObject)
Fetch any property by name, parse it as a JSON and return object
-
name(String)
property_upload (PropertyUpload)
Fetch any property by name and returns upload details
-
expires_in(Int)
Defines the number of seconds for which the generated url will be accessible. Must be set if acl was set to private
-
name(String)
related_model (Model)
Defines has-one relation with other model; ex: children: models(model_name:
"child" join_on_property: "parent_id" foreign_property: "parent_id") { id }
-
filter(ModelsFilterInput) -
foreign_property(String)
Load resources with foreign_property == join_on_property
-
join_on_property(String)
Load resources with foreign_property == join_on_property
-
model_schema_name(String)
Joins model [formaly customization] with model-schema-name == model_schema_name
-
sort(ModelsSortInput)
related_models (Model)
Defines has-many relation with other model; ex: children:
related_models(model_schema_name: "child", join_on_property: "parent_id",
foreign_property: "parent_id") { id }
-
filter(ModelsFilterInput) -
foreign_property(String)
Load resources with foreign_property == join_on_property
-
join_on_property(String)
Load resources with foreign_property == join_on_property
Joins model [formaly customization] with model-schema-name == model_schema_name
-
sort(ModelsSortInput)
related_record (Record)
Defines has-one relation with other record; ex: children: records(table:
"child" join_on_property: "parent_id" foreign_property: "parent_id") { id }
-
filter(RecordsFilterInput) -
foreign_property(String)
Load resources with foreign_property == join_on_property
-
join_on_property(String)
Load resources with foreign_property == join_on_property
-
sort(RecordsSortInput) -
table(String)
Joins record [formaly customization] with record-schema-name == table
related_records (Record)
Defines has-many relation with other records; ex: children:
related_records(table: "children", join_on_property: "parent_id",
foreign_property: "parent_id") { id }
-
filter(RecordsFilterInput) -
foreign_property(String)
Load resources with foreign_property == join_on_property
-
join_on_property(String)
Load resources with foreign_property == join_on_property
-
limit(Int) -
sort(RecordsSortInput) -
table(String)
Define table name which should be used as a source for related records
related_user (User)
Defines relation with other user; ex: invited_by: related_user(join_on_property: "invited_by_id") { id }
-
filter(ModelsFilterInput) -
foreign_property(String)
Load resources with foreign_property == join_on_property
-
join_on_property(String) -
sort(UsersSortInput)
related_users (User)
Defines has-many relation with other user; ex: children:
users(join_on_property: "parent_id", foreign_property: "parent_id") { id }
-
filter(ModelsFilterInput) -
foreign_property(String)
Load resources with foreign_property == join_on_property
-
join_on_property(String)
Load resources with foreign_property == join_on_property
-
limit(Int) -
sort(UsersSortInput)
slug (String)
To be used in the url instead of id for SEO purposes. Must be unique. By
default generated based on first-name and last-mame
social_friends (UserCollection)
determined based on authentications. For example, if user connects FB account,
this will make API call to FB and check, if any of his friends have account on your Site
temporary_token (String)
A token valid for desired number of hours, which you can use to authorize the
user in third party application. To do it, include it in a header with name
UserTemporaryToken. You can also manually verify the token with users{
authenticate { temporary_token(..) } } query. Token will be invalidated on
password change.
-
expires_in(Float)
Number of hours after which the token expire
-
valid_for(Int)
deprecated, use expires_in
transactables (Transactable)
updated_at (JSONDate)
timestamp of when the record was updated, automatically generated by the system
user (User)
Defines relation with other user; ex: invited_by: user(join_on_property: "invited_by_id") { id }
-
foreign_property(String)
Load resources with foreign_property == join_on_property
-
join_on_property(String) -
sort(UsersSortInput)
users (User)
Defines has-many relation with other user; ex: children:
users(join_on_property: "parent_id", foreign_property: "parent_id") { id }
-
foreign_property(String)
Load resources with foreign_property == join_on_property
-
join_on_property(String)
Load resources with foreign_property == join_on_property
-
limit(Int) -
sort(UsersSortInput)