Signup
Signup
Request
POST /access_controls/users/signup.json
Form Data
data[users][user_name]: example@gmail.com
data[users][first_name]: Adam
data[users][last_name]: Smith
data[users][user_password]: SomeSecurePass123
data[users][confirm_password]: SomeSecurePass123
data[users][is_license_agreement_accepted]: 1
data[users][role_id]: 63c7d576-57d0-43f1-ac28-4eedac69033c
data[users][auto_login]: 1
data[action][signup]: Signup
data[users][images][name]: (binary)
data[users][organizations][name]: Some organisation name
data[users][organizations][currency_id]: 20
Get signup info
Request
GET /access_controls/users/signup.json
Response
{
"data": {
"users": {
"related_entity": [],
"addresses": [],
"email_addresses": [],
"phone_numbers": [],
"roles_users": [],
"images": [],
"http": [],
"owned_by": null,
"__owned_by": null
}
},
"errors": [],
"message": [],
"form_permission": 4,
"form": {
"model_class": "",
"template": "",
"labels": [],
"enable_split_layout": 0,
"form_metadata_id": "",
"form_view_href": "/development_base/forms/view/id:",
"field_configurations": [],
"field_request_status": "",
"field_request_message": "",
"href": "access_controls/users/edit?id=&step_number=",
"permission": 2
},
"timezones": {
"America/Adak": "America/Adak",
"America/Anchorage": "America/Anchorage",
"America/Anguilla": "America/Anguilla",
"America/Antigua": "America/Antigua",
"America/Araguaina": "America/Araguaina",
"America/Argentina/Buenos_Aires": "America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca": "America/Argentina/Catamarca",
"America/Argentina/Cordoba": "America/Argentina/Cordoba",
"America/Argentina/Jujuy": "America/Argentina/Jujuy",
"America/Argentina/La_Rioja": "America/Argentina/La_Rioja",
"America/Argentina/Mendoza": "America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos": "America/Argentina/Rio_Gallegos",
"America/Argentina/Salta": "America/Argentina/Salta",
"America/Argentina/San_Juan": "America/Argentina/San_Juan",
"America/Argentina/San_Luis": "America/Argentina/San_Luis",
"America/Argentina/Tucuman": "America/Argentina/Tucuman",
"America/Argentina/Ushuaia": "America/Argentina/Ushuaia",
"America/Aruba": "America/Aruba",
"America/Asuncion": "America/Asuncion",
"America/Atikokan": "America/Atikokan",
"America/Bahia": "America/Bahia",
"UTC": "UTC",
// ...rest
},
"locales": [
{
"text": "English (United States)",
"value": "en_US"
}
],
"user_has_edit_permission": true,
"permissions": [],
"hour_format": {
"12": "12",
"24": "24"
},
"themes": {
"3_panel_fieldset_view": [
{
"text": "blitzer",
"value": "3_panel_fieldset_view/blitzer"
},
{
"text": "cupertino",
"value": "3_panel_fieldset_view/cupertino"
},
{
"text": "flick",
"value": "3_panel_fieldset_view/flick"
},
{
"text": "le-frog",
"value": "3_panel_fieldset_view/le-frog"
},
{
"text": "lightness",
"value": "3_panel_fieldset_view/lightness"
},
{
"text": "redmond",
"value": "3_panel_fieldset_view/redmond"
},
{
"text": "smoothness",
"value": "3_panel_fieldset_view/smoothness"
}
]
},
"primary_key": "id",
"display_field": "name",
"model": "users",
"model_class": "\\module\\access_controls\\model\\users",
"singleton_key": null,
"filterRules": {
"user_name": [
{
"rule": "1024",
"params": {
"options": [
"\\kernel\\validation",
"notEmpty"
]
}
},
{
"rule": "module\\access_controls\\model\\users_domain_logic::validateUserName",
"params": []
}
],
"last_name": [
{
"rule": "1024",
"params": {
"options": [
"\\kernel\\validation",
"notEmpty"
]
}
}
],
"organization_id": [
{
"rule": "\\kernel\\validation::notEmpty",
"params": []
}
],
"name": [
{
"rule": "1024",
"params": {
"options": [
"\\kernel\\transformation",
"name"
]
},
"sanitize": 1
}
],
"currency_id": [
{
"rule": "1024",
"params": {
"options": [
"\\kernel\\validation",
"notEmpty"
]
}
}
],
"is_license_agreement_accepted": [
{
"rule": "required"
},
{
"rule": "1024",
"params": {
"options": [
"\\module\\access_controls\\model\\users_domain_logic",
"isLicenseAgreementAccepted"
]
}
}
],
"role_id": [
{
"rule": "1024",
"params": {
"options": [
"\\kernel\\validation",
"notEmpty"
]
}
},
{
"rule": "1024",
"params": {
"options": [
"\\module\\access_controls\\model\\users_domain_logic",
"isValidSignupRole"
]
}
}
],
"addresses": {
"type": [
{
"rule": "required"
},
{
"rule": "1024",
"params": {
"options": [
"\\kernel\\validation",
"notEmpty"
]
}
}
],
"address_line_1": [
{
"rule": "required"
},
{
"rule": "1024",
"params": {
"options": [
"\\kernel\\validation",
"notEmpty"
]
}
}
],
"city": [
{
"rule": "1024",
"params": {
"options": [
"\\kernel\\validation",
"notEmpty"
]
}
}
],
"state_id": [
{
"rule": "\\kernel\\validation::notEmpty",
"params": []
}
],
"country_id": [
{
"rule": "\\kernel\\validation::notEmpty",
"params": []
}
],
"zip": [
{
"rule": "\\kernel\\validation::notEmpty",
"params": []
}
]
},
"email_addresses": {
"email": [
{
"rule": "required"
},
{
"rule": "1024",
"params": {
"options": [
"\\kernel\\validation",
"notEmpty"
]
}
},
{
"rule": "274",
"params": []
}
],
"type": [
{
"rule": "\\kernel\\validation::notEmpty",
"params": []
}
]
},
"phone_numbers": {
"number": [
{
"rule": "required"
},
{
"rule": "1024",
"params": {
"options": [
"\\kernel\\validation",
"notEmpty"
]
}
}
],
"type": [
{
"rule": "required"
},
{
"rule": "1024",
"params": {
"options": [
"\\kernel\\validation",
"notEmpty"
]
}
}
]
},
"roles_users": {
"role_id": [
{
"rule": "1024",
"params": {
"options": [
"\\kernel\\validation",
"notEmpty"
]
}
}
],
"user_id": [
{
"rule": "1024",
"params": {
"options": [
"\\kernel\\validation",
"notEmpty"
]
}
}
]
},
"images": {
"error": [
{
"rule": 1024,
"params": {
"options": [
"\\module\\document_management_base\\model\\attachments",
"uploadErrorOk"
]
}
},
{
"rule": 1024,
"params": {
"options": [
"\\module\\document_management_base\\model\\attachments",
"uploadErrorIntSize"
]
}
},
{
"rule": 1024,
"params": {
"options": [
"\\module\\document_management_base\\model\\attachments",
"uploadErrorFormSize"
]
}
},
{
"rule": 1024,
"params": {
"options": [
"\\module\\document_management_base\\model\\attachments",
"uploadErrorPartial"
]
}
},
{
"rule": 1024,
"params": {
"options": [
"\\module\\document_management_base\\model\\attachments",
"uploadErrorNoFile"
]
}
},
{
"rule": 1024,
"params": {
"options": [
"\\module\\document_management_base\\model\\attachments",
"uploadErrorNoTmpDir"
]
}
},
{
"rule": 1024,
"params": {
"options": [
"\\module\\document_management_base\\model\\attachments",
"uploadErrorCantWrite"
]
}
},
{
"rule": 1024,
"params": {
"options": [
"\\module\\document_management_base\\model\\attachments",
"uploadErrorExtension"
]
}
}
],
"mime_type": [
{
"rule": 1024,
"params": {
"options": [
"\\module\\document_management_base\\model\\attachments",
"allowedExtensions"
]
}
}
]
}
},
"id": null,
"name": "",
"rebaseline": [],
"allow_comments": 0,
"is_deletable": 0,
"currencies": [
{
"text": "CAD",
"value": "20"
},
// ...rest
],
"signup_roles": [
{
"text": "System Admin",
"value": "63c7d576-57d0-43f1-ac28-4eedac69033c"
}
],
"is_multi_tenant": 1,
"allow_public_signup": 1,
"controllerClass": "\\module\\access_controls\\controller\\users",
"modelClass": "\\module\\access_controls\\model\\users",
"notEmptyField": {
"users": {
"user_name": "user_name",
"last_name": "last_name",
"organization_id": "organization_id",
"currency_id": "currency_id",
"role_id": "role_id",
"addresses": {
"type": "type",
"address_line_1": "address_line_1",
"city": "city",
"state_id": "state_id",
"country_id": "country_id",
"zip": "zip"
},
"email_addresses": {
"email": "email",
"type": "type"
},
"phone_numbers": {
"number": "number",
"type": "type"
},
"roles_users": {
"role_id": "role_id",
"user_id": "user_id"
},
"images": []
},
"addresses": {
"type": "type",
"address_line_1": "address_line_1",
"city": "city",
"state_id": "state_id",
"country_id": "country_id",
"zip": "zip"
},
"email_addresses": {
"email": "email",
"type": "type"
},
"phone_numbers": {
"number": "number",
"type": "type"
},
"roles_users": {
"role_id": "role_id",
"user_id": "user_id"
},
"images": []
},
"organization_name": null,
"organization_id": null,
"user_id": null,
"user_fullname": null
}
License agreement
Request
GET /access_controls/users/license_agreement.json
Response
{
"errors": [],
"message": [],
"license_agreement": " \n <h2>FIYGE ONLINE TERMS & CONDITIONS (SAAS LICENSE AGREEMENT)</h2>\n <p><strong>Effective Date:</strong> 20th April 2024</p>\n\n <p>\n These Fiyge Online Terms & Conditions (the “<strong>Agreement</strong>”) constitute a legally binding agreement between <strong>Fiyge Research Inc.</strong> (“<strong>Provider</strong>,” “<strong>we</strong>,” “<strong>us</strong>,” or “<strong>our</strong>”), a Canadian corporation, \n and the individual or legal entity (“<strong>Client</strong>,” “<strong>you</strong>,” or “<strong>your</strong>”) \n who clicks “Accept,” “Agree,” or a similar button or checkbox indicating acceptance electronically, or who accesses or uses the Services (as defined below). \n By accepting this Agreement, you acknowledge that you have read, understood, and agree to be bound by this Agreement. \n If you do not agree to all of the terms, you must not access or use the Services.\n </p>\n\n <div class=\"section\">\n <div class=\"section-title\">1. DEFINITIONS</div>\n <p><strong>1.1 “Services”</strong><br>\n Means the online, cloud-based, subscription services, including any related functionality, software, documentation, and support, that we make available under this Agreement, commonly referred to as “Fiyge.”</p>\n\n <p><strong>1.2 “Software”</strong><br>\n Means the proprietary Fiyge software application provided by Fiyge Research Inc. as part of the Services, including all related enhancements, updates, and modifications.</p>\n\n <p><strong>1.3 “Client Data”</strong><br>\n Means any data, information, or material that you or your authorized users provide, upload, or generate through your use of the Services.</p>\n\n <p><strong>1.4 “User”</strong><br>\n Means any individual authorized by you to access or use the Services under your account, including employees, contractors, or other personnel.</p>\n </div>\n\n <div class=\"section\">\n <div class=\"section-title\">2. ACCEPTANCE & SCOPE</div>\n <p><strong>2.1 Acceptance of Terms</strong><br>\n By clicking to accept these Terms & Conditions or by using the Services, you represent that you have the authority to enter into this Agreement. \n If you are entering this Agreement on behalf of a company or other legal entity, you represent that you have the authority to bind that entity to these terms.</p>\n\n <p><strong>2.2 Scope</strong><br>\n This Agreement governs your access to and use of the Services. Additional terms may apply to certain features or functionalities of the Services, and such additional terms will become part of this Agreement if you use those features or functionalities.</p>\n </div>\n\n <div class=\"section\">\n <div class=\"section-title\">3. LICENSE GRANT & RESTRICTIONS</div>\n <p><strong>3.1 License Grant</strong><br>\n Subject to your compliance with this Agreement and payment of all applicable fees, we grant you a limited, non-exclusive, non-transferable, non-sublicensable right to access and use the Services for your internal business purposes during the Subscription Term defined in Section 10 below.</p>\n\n <p><strong>3.2 Restrictions</strong><br>\n You agree not to:</p>\n <ul>\n <li>Copy, modify, create derivative works of, or distribute the Software or any part of the Services.</li>\n <li>Reverse engineer, decompile, or otherwise attempt to extract the source code of the Software, except to the extent expressly permitted by applicable law.</li>\n <li>Sell, resell, lease, rent, or otherwise provide the Services to any third party, except as permitted herein.</li>\n <li>Use the Services in any manner that violates any applicable law, regulation, or the intellectual property rights of any third party.</li>\n </ul>\n\n <p><strong>3.3 Reservation of Rights</strong><br>\n All rights not expressly granted under this Agreement are reserved by Fiyge Research Inc. and its licensors.</p>\n </div>\n\n <div class=\"section\">\n <div class=\"section-title\">4. ACCOUNT REGISTRATION & SECURITY</div>\n <p><strong>4.1 Registration</strong><br>\n You must create an account to access the Services. You agree to provide accurate, current, and complete information during the registration process and to keep this information up to date.</p>\n\n <p><strong>4.2 Account Security</strong><br>\n You are responsible for maintaining the confidentiality of your username and password. You will promptly notify us of any unauthorized access or use of your account. You are responsible for all activities that occur under your account.</p>\n\n <p><strong>4.3 Authorized Users</strong><br>\n You may permit your Users to access the Services under your account. You are liable for the acts and omissions of any User who accesses or uses the Services under your account.</p>\n </div>\n\n <div class=\"section\">\n <div class=\"section-title\">5. FEES & PAYMENT</div>\n <p><strong>5.1 Subscription Fees</strong><br>\n You agree to pay all fees in accordance with the subscription plan or order form you select. All fees are stated in [Currency] unless otherwise specified and are non-refundable, except as required by law.</p>\n\n <p><strong>5.2 Payment Terms</strong><br>\n Unless otherwise agreed in writing, all payments shall be due and payable in advance. Late payments may be subject to interest at the rate of [X%] per month, or the maximum rate permitted by applicable law, whichever is less.</p>\n\n <p><strong>5.3 Taxes</strong><br>\n All fees exclude any applicable taxes, duties, or levies imposed by relevant governmental authorities. You are responsible for all such taxes or charges, except for those based on our net income.</p>\n </div>\n\n <div class=\"section\">\n <div class=\"section-title\">6. CLIENT DATA & PRIVACY</div>\n <p><strong>6.1 Data Ownership</strong><br>\n You retain all rights, title, and interest in and to any Client Data you upload or provide. We do not claim ownership of your Client Data.</p>\n\n <p><strong>6.2 Data Use & Protection</strong><br>\n We will process Client Data solely for the purpose of providing the Services in accordance with this Agreement and applicable privacy laws. We will implement appropriate administrative, technical, and organizational measures to protect Client Data against accidental or unlawful destruction, loss, alteration, unauthorized disclosure, or access.</p>\n\n </div>\n\n <div class=\"section\">\n <div class=\"section-title\">7. PROPRIETARY RIGHTS & FEEDBACK</div>\n <p><strong>7.1 Intellectual Property Rights</strong><br>\n Fiyge Research Inc. (and its licensors) retain all intellectual property rights, title, and interest in and to the Software, Services, and any associated materials, including all enhancements, modifications, and derivative works.</p>\n\n <p><strong>7.2 Feedback</strong><br>\n If you provide any suggestions, ideas, or feedback (“<strong>Feedback</strong>”) to us, we may use and incorporate such Feedback without any obligation to you, and you hereby grant us a worldwide, irrevocable, royalty-free, perpetual license to use and incorporate the Feedback.</p>\n </div>\n\n <div class=\"section\">\n <div class=\"section-title\">8. CONFIDENTIALITY</div>\n <p><strong>8.1 Definition</strong><br>\n “<strong>Confidential Information</strong>” means any non-public information disclosed by one party (“<strong>Disclosing Party</strong>”) to the other party (“<strong>Receiving Party</strong>”) that is designated as confidential or that reasonably should be understood to be confidential, including business, technical, or financial information.</p>\n\n <p><strong>8.2 Obligation</strong><br>\n The Receiving Party agrees to use the same degree of care (but not less than a reasonable degree of care) to protect the Disclosing Party’s Confidential Information that it uses to protect its own confidential information. The Receiving Party may use Confidential Information solely to perform its obligations or exercise its rights under this Agreement.</p>\n\n <p><strong>8.3 Exceptions</strong><br>\n Confidential Information does not include information that: (a) is or becomes publicly available without breach of this Agreement; (b) was lawfully known by the Receiving Party without confidentiality obligation; (c) is independently developed by the Receiving Party; or (d) is rightfully obtained from a third party without restriction.</p>\n </div>\n\n <div class=\"section\">\n <div class=\"section-title\">9. WARRANTIES & DISCLAIMERS</div>\n <p><strong>9.1 Mutual Warranties</strong><br>\n Each party warrants that it has the authority to enter into this Agreement and that its performance does not violate any agreement between that party and any third party.</p>\n\n <p><strong>9.2 Disclaimer of Warranties</strong><br>\n Except for the express warranties set forth above, the Services are provided on an “<strong>AS IS</strong>” and “<strong>AS AVAILABLE</strong>” basis. \n To the fullest extent permitted by law, Fiyge Research Inc. disclaims all other warranties, express or implied, \n including warranties of merchantability, fitness for a particular purpose, and non-infringement.</p>\n </div>\n\n <div class=\"section\">\n <div class=\"section-title\">10. TERM & TERMINATION</div>\n <p><strong>10.1 Subscription Term</strong><br>\n Your subscription begins on the Effective Date or the date otherwise indicated in your order form and continues for the subscription period specified (the “<strong>Subscription Term</strong>”). \n Unless otherwise specified, subscriptions renew automatically for successive renewal terms unless either party provides notice of non-renewal at least [30 days] before the end of the then-current term.</p>\n\n <p><strong>10.2 Termination for Breach</strong><br>\n Either party may terminate this Agreement if the other party materially breaches this Agreement and fails to cure such breach within [30 days] of receiving written notice.</p>\n\n <p><strong>10.3 Effect of Termination</strong><br>\n Upon termination:\n </p>\n <ul>\n <li>Your access to the Services immediately ceases.</li>\n <li>We may delete or disable access to any Client Data in our systems unless otherwise required by law.</li>\n <li>Any outstanding fees become immediately due and payable.</li>\n </ul>\n </div>\n\n <div class=\"section\">\n <div class=\"section-title\">11. LIMITATION OF LIABILITY</div>\n <p><strong>11.1 Exclusion of Certain Damages</strong><br>\n To the maximum extent permitted by law, Fiyge Research Inc. shall not be liable for any special, incidental, indirect, \n consequential, or punitive damages, including lost profits or lost data, arising out of or related to this Agreement.</p>\n\n <p><strong>11.2 Liability Cap</strong><br>\n Fiyge Research Inc.’s total liability for any claim under this Agreement shall not exceed the amount paid by you to Fiyge Research Inc. \n in the twelve (12) months preceding the event giving rise to the claim.</p>\n\n <p><strong>11.3 Jurisdictional Limits</strong><br>\n Some jurisdictions do not allow the exclusion of implied warranties or the limitation of liability for incidental or consequential damages, \n so certain limitations may not apply to you.</p>\n </div>\n\n <div class=\"section\">\n <div class=\"section-title\">12. INDEMNIFICATION</div>\n <p><strong>12.1 By Fiyge Research Inc.</strong><br>\n We will defend, indemnify, and hold you harmless from any third-party claim that the Software, as provided, \n infringes any third-party intellectual property right, provided that: (a) you promptly notify us of the claim; \n (b) we have sole control over the defense and settlement; and (c) you provide reasonable assistance.</p>\n\n <p><strong>12.2 By Client</strong><br>\n You will defend, indemnify, and hold Fiyge Research Inc. harmless from any third-party claims arising from or related to your misuse of the Services \n or violation of this Agreement, provided that: (a) we promptly notify you of the claim; (b) you have sole control over the defense and settlement; \n and (c) we provide reasonable assistance.</p>\n\n <p><strong>12.3 Exclusions</strong><br>\n Our indemnification obligations do not apply to claims arising from (a) your modifications to the Software not performed by us, \n (b) combination of the Software with materials not provided or approved by us, or (c) your breach of this Agreement.</p>\n </div>\n\n <div class=\"section\">\n <div class=\"section-title\">13. GOVERNING LAW & DISPUTE RESOLUTION</div>\n <p><strong>13.1 Governing Law</strong><br>\n This Agreement shall be governed by and construed in accordance with the laws of the Province of [Ontario or other province] \n and the federal laws of Canada applicable therein, without reference to conflict of laws principles.</p>\n\n <p><strong>13.2 Venue</strong><br>\n The parties agree that any dispute arising out of or relating to this Agreement shall be resolved in the courts located in the Province of [Ontario or other province], \n and each party irrevocably submits to the exclusive jurisdiction of such courts.</p>\n\n <p><strong>13.3 Dispute Resolution</strong><br>\n Before initiating legal proceedings, the parties agree to engage in good-faith discussions to resolve any disputes. \n If the dispute cannot be resolved informally, either party may seek appropriate legal or equitable remedies in accordance with Section 13.2.</p>\n </div>\n\n <div class=\"section\">\n <div class=\"section-title\">14. FORCE MAJEURE</div>\n <p>\n Neither party will be liable for any failure or delay in performance under this Agreement due to circumstances beyond its reasonable control, \n including acts of God, natural disasters, war, terrorism, civil disturbances, or governmental action.\n </p>\n </div>\n\n <div class=\"section\">\n <div class=\"section-title\">15. MISCELLANEOUS</div>\n <p><strong>15.1 Entire Agreement</strong><br>\n This Agreement (including any applicable order forms or addenda) constitutes the entire agreement between the parties regarding its subject matter \n and supersedes all prior or contemporaneous agreements, understandings, or representations.</p>\n\n <p><strong>15.2 Modifications</strong><br>\n We may modify these Terms & Conditions from time to time. We will provide notice of material changes, \n and your continued use of the Services after any changes become effective constitutes your acceptance of the changes.</p>\n\n <p><strong>15.3 Assignment</strong><br>\n You may not assign this Agreement without our prior written consent. We may assign this Agreement at any time without prior notice to you.</p>\n\n <p><strong>15.4 Severability</strong><br>\n If any provision of this Agreement is held to be invalid or unenforceable, the remaining provisions will remain in full force and effect.</p>\n\n <p><strong>15.5 Waiver</strong><br>\n No waiver of any breach or default under this Agreement shall be effective unless in writing, nor shall it be deemed a waiver of any subsequent breach or default.</p>\n\n <p><strong>15.6 Relationship of the Parties</strong><br>\n Nothing herein shall be deemed to create a partnership, joint venture, or agency relationship between the parties.</p>\n </div>\n\n <div class=\"section\">\n <div class=\"section-title\">16. ACCEPTANCE</div>\n <p>\n By clicking “Accept” (or a similar button or checkbox) or by otherwise accessing or using the Services, \n you acknowledge that you have read, understood, and agree to be bound by these Fiyge Online Terms & Conditions (SaaS License Agreement).\n </p>\n </div>\n <p>\n If you have any questions or concerns about this Agreement, please contact us at \n <strong>info@fiyge.com</strong>.\n </p>",
"controllerClass": "\\module\\access_controls\\controller\\users",
"modelClass": "\\module\\access_controls\\model\\users",
"notEmptyField": [],
"organization_name": null,
"organization_id": null,
"user_id": null,
"user_fullname": null,
"data": []
}
Organisation info
Request
Response