OBJECT

User

# GraphQL Schema definition

1type User implements PropertiesInterface, LegacyCustomAttributeInterface, HasModelsInterface {
 
2# stores information about user integrations with authentication providers like
3# auth0, facebook, twitter etc
4authentications: [Authentication!]
 
5# used for twilio click-to-call integraation to verify phone number
6communication: Communication
 
7# timestamp of when the record was created, automatically generated by the system
8created_at: JSONDate
 
9# Arguments
10# name: model schema name
11# user_id: ID of user that created customization
12customizations(name: String, user_id: ID): [Customization!]
 
13# timestamp of when the record was soft delete, populated by delete action. It is
14# also possible to manually set it via update. To undelete change it back to empty
15# value, but please note that associated records would need to be manually
16# undeleted as well.
17deleted_at: JSONDate
 
18email: String!
 
19# Used mainly for import/export, if you want to use third party service as a
20# source of truth
21external_id: String
 
22first_name: String
 
23# ID of an object.
24id: ID
 
25# JWT token that can be used for authentication
26#
27# Arguments
28# algorithm: [Not documented]
29jwt_token(algorithm: JwtAlgorithm): String
 
30# Used by translations to set the language of currently logged in user
31language: String
 
32last_name: String
 
33middle_name: String
 
34name: String
 
35# associated user profiles, which can be used as user role or namespace for
36# certain group of user properties
37#
38# Arguments
39# profile_type: [Not documented]
40profiles(profile_type: String): [Profile!]!
 
41# List of all properties assigned to the object.
42properties: HashObject
 
43# Fetch any property by name and return value as a String; ex: hair_color:
44# property(name: "hair_color")
45#
46# Arguments
47# name: [Not documented]
48property(name: String!): String
 
49# Fetch any property by name and return value as an Array of Strings. ex:
50# todo_list: property_array(name: "todo_list")
51#
52# Arguments
53# name: [Not documented]
54property_array(name: String!): [String!]
 
55# Fetch any property by name and return value as a Boolean; ex: price:
56# property_boolean(name: "enabled")
57#
58# Arguments
59# name: [Not documented]
60property_boolean(name: String!): Boolean
 
61# Fetch any property by name and return value as a Float; ex: price:
62# property_float(name: "price")
63#
64# Arguments
65# name: [Not documented]
66property_float(name: String!): Float
 
67# Fetch any property by name and return value as an Integer; ex: age:
68# property_int(name: "age")
69#
70# Arguments
71# name: [Not documented]
72property_int(name: String!): Int
 
73# Fetch any property by name and return value as a JSON.
74#
75# Arguments
76# name: [Not documented]
77property_json(name: String!): JSONPayload
 
78# Fetch any property by name and returns upload details
79#
80# Arguments
81# expires_in: Defines the number of seconds for which the
82# generated url will be accessible. Must be set if acl was set to private
83# name: [Not documented]
84property_upload(expires_in: Int, name: String!): PropertyUpload
 
85# Defines has-one relation with other model; ex: children: models(model_name:
86# "child" join_on_property: "parent_id" foreign_property: "parent_id") { id }
87#
88# Arguments
89# filter: [Not documented]
90# foreign_property: Load resources with foreign_property ==
91# join_on_property
92# join_on_property: Load resources with foreign_property ==
93# join_on_property
94# model_schema_name: Joins model [formaly customization] with
95# model-schema-name == model_schema_name
96# sort: [Not documented]
97related_model(
98filter: ModelsFilterInput,
99foreign_property: String,
100join_on_property: String!,
101model_schema_name: [String]!,
102sort: [ModelsSortInput!]
103): Model
 
104# Defines has-many relation with other model; ex: children:
105# related_models(model_schema_name: "child", join_on_property: "parent_id",
106# foreign_property: "parent_id") { id }
107#
108# Arguments
109# filter: [Not documented]
110# foreign_property: Load resources with foreign_property ==
111# join_on_property
112# join_on_property: Load resources with foreign_property ==
113# join_on_property
114# limit: [Not documented]
115# model_schema_name: Joins model [formaly customization] with
116# model-schema-name == model_schema_name
117# sort: [Not documented]
118related_models(
119filter: ModelsFilterInput,
120foreign_property: String!,
121join_on_property: String!,
122limit: Int,
123model_schema_name: [String]!,
124sort: [ModelsSortInput!]
125): [Model!]
 
126# Defines relation with other user; ex: invited_by: user(join_on_property:
127# "invited_by_id") { id }
128#
129# Arguments
130# filter: [Not documented]
131# foreign_property: Load resources with foreign_property ==
132# join_on_property
133# join_on_property:
134# sort: [Not documented]
135related_user(
136filter: ModelsFilterInput,
137foreign_property: String,
138join_on_property: String,
139sort: [UsersSortInput!]
140): User
 
141# Defines has-many relation with other user; ex: children: users(join_on_property:
142# "parent_id", foreign_property: "parent_id") { id }
143#
144# Arguments
145# filter: [Not documented]
146# foreign_property: Load resources with foreign_property ==
147# join_on_property
148# join_on_property: Load resources with foreign_property ==
149# join_on_property
150# limit: [Not documented]
151# sort: [Not documented]
152related_users(
153filter: ModelsFilterInput,
154foreign_property: String!,
155join_on_property: String!,
156limit: Int,
157sort: [UsersSortInput!]
158): [User!]
 
159# To be used in the url instead of id for SEO purposes. Must be unique. By default
160# generated based on first-name and last-mame
161slug: String!
 
162# determined based on authentications. For example, if user connects FB account,
163# this will make API call to FB and check, if any of his friends have account on
164# your Site
165#
166# Arguments
167# page: [Not documented]
168# per_page: [Not documented]
169social_friends(page: Int, per_page: Int): UserCollection
 
170# A token valid for desired number of hours, which you can use to authorize the
171# user in third party application. To do it, include it in a header with name
172# UserTemporaryToken. You can also manually verify the token in liquid using
173# is_token_valid filter. Token will be invalidated on password change.
174#
175# Arguments
176# valid_for: Number of hours before the token expires
177temporary_token(valid_for: Int): String
 
178# timestamp of when the record was updated, automatically generated by the system
179updated_at: JSONDate
 
180}

# Required by