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