eazy2biz-docs
  1. Global User
eazy2biz-docs
  • Getting Started
  • Overview
  • Authentication
  • Pagination
  • Querying and Sorting
  • Rate Limit
  • Scope
  • Identity
    • Identity Overview
    • Global User Token
    • Global User Offline Token
    • System Local User Offline Token (Company Impersonation)
    • API Client Access Offline Token
  • Activity
    • Create Activity
    • Filter Activities
    • Get All Activities for Entity
    • Get Activity for Entity by ID
    • Patch Activity Attributes for Entity by ID
    • Delete Activity for Entity by ID
  • Analytics
    • Chart
      • Get Charts in Report
      • Get Count of Charts in Report
      • Get Filtered Charts in Report
      • Get Count of Filtered Charts in Report
      • Simulate Chart in Report
      • Create Chart in Report
      • Get Chart in Report by ID
      • Get Chart Data in Report
      • Patch Chart Attributes in Report by ID
      • Delete Chart in Report by ID
    • Report
      • Get All Reports
      • Get Count of Reports
      • Create Report
      • Filter All Reports
      • Count of Filtered All Reports
      • Get Report by ID
      • Patch Report Attributes by ID
      • Delete Report by ID
  • Attachment
    • Create Attachment
    • Get all Attachments
    • Get count of all Attachments
    • Filter All Attachments
    • Count of Filtered Attachments
    • Get Attachment by ID
    • Download Attachment by ID
    • Patch Attachment Attributes by ID
    • Delete Attachment by ID
  • Customer Table
    • Create Customer Table
    • Get All Customer Tables
    • Get Count of All Customer Tables
    • Get Customer Table by ID
    • Patch Customer Table Attributes by ID
    • Delete Customer Table by ID
    • Add header to Customer Table
    • Get all Customer Table Headers
    • Get Customer Table Header by ID
    • Patch Customer Table Header Attributes by ID
    • Delete Customer Table Header by ID
    • Add Record to Customer Table
    • Get All Records in Customer Table
    • Get Count of All Records in Customer Table
    • Get Record in Customer Table by ID
    • Filter Records in Customer Table
    • Count of Filtered Records in Customer Table
    • Patch Record Attributes in Customer Table by ID
    • Delete Record in Customer Table by ID
  • Card
    • Override Stage Completion
    • Override Form Fields
    • Get All Cards In Workflow
    • Get Count of All Cards In Workflow
    • Filter All Cards In Workflow
    • Count of Filtered Cards In Workflow
    • Create Card In Workflow
    • Get Card In Workflow by ID
    • Patch Card Attributes In Workflow by ID
    • Delete Card In Workflow by ID
  • User Invite
    • Invite User To Company
    • Filter All Invites
    • Accept User Invite
    • Reject User Invite Copy
    • Get All User Invites
    • Get User Invite by ID
  • Global User Invite
    • Create Global User Invite
    • Get All Global User Invites
    • Count of all Global User Invites
    • Filter All Global User Invites
    • Count of Filtered Global User Invites
    • Reject Global User Invite
    • Get Global User Invite by ID
    • Delete Global User Invite by ID
  • Identities
    • Company
      • Get All Companies
      • Create Company
      • Get Companies For Global User
      • Get Company by ID
      • Patch Company Attributes
      • Delete company by ID
    • Company Settings
      • Create Company Setting
      • Get All Company Settings
      • Filter All Company Settings
      • Get Company Setting by Type
      • Get Company Setting by ID
      • Patch Company Setting by Type
      • Patch Company Setting by ID
      • Delete Company Setting by Type
      • Delete Company Setting by ID
    • Global User
      • Get All Global Users
        GET
      • Get Count Of All Global Users
        GET
      • Sign Up Global User
        POST
      • Resend Confirmation Passcode
        POST
      • Confirm Sign Up
        POST
      • Sign In
        POST
      • Refresh Token
        POST
      • Change password
        POST
      • Initiate Forward Password
        POST
      • Confirm Forgot Password
        POST
      • Get Global User By Email
        POST
      • Get Global User by Token
        GET
      • Add Mobile App Device Token
        POST
      • Remove Mobile App Device Token
        POST
      • Get Global User By ID
        GET
      • Patch Global User Attributes
        PATCH
      • Delete Global User By ID
        DELETE
    • Local User
      • Get All Local Users
      • Filter Local Users
      • Get Local Users by ID
      • Patch Local User Attributes by ID
      • Delete Local Users by ID
    • Security Group
      • Get all Security Groups
      • Create Security Group
      • Filter Security Groups
      • Add Local User in Security Group
      • Remove Local User in Security Group
      • Add User Group in Security Group
      • Remove User Group in Security Group
      • Check if Local User can perform Action on Feature
      • Check if Local User can perform Action on Feature Batch
      • Get All Actions Local User can perform on feature
      • Get all Security Groups by Feature & Action
      • Get Security Group by ID
      • Get Security Group by ID Copy
    • User Group
      • Get all User Groups
      • Create User Group
      • Filter User Groups
      • Add Local User to User Group
      • Remove Local User from User Group
      • Add User Group to User Group
      • Remove Local User from User Group Copy
      • Check Local User Membership in User Group
      • Get all User Groups a Local User is member of
      • Get all User Groups a Local User is directly member of
      • Get all User Groups a User Group is member of
      • Create User Group by ID
      • Patch User Group Attributes by ID
      • Delete User Group by ID
  • Template
    • WhatsApp
      • Get Status of WhatsApp Template
      • Send WhatsApp Message on Phone Number
    • Create Template
    • Create Template from System Template
    • Get All Templates in Category
    • Get Count of All Templates in Category
    • Filter All Templates in Category
    • Count of Filtered Templates in Category
    • Get Templates by ID in Category
    • Resolve Template by ID
    • Patch Templates Attributes by ID in Category
    • Delete Templates by ID in Category
  • Schedulable Trigger
    • Create Schedulable Trigger
    • Get all Schedulable Triggers
    • Get count of all Schedulable Triggers
    • Filter all Schedulable Triggers
    • Count of Filtered Schedulable Triggers
    • Get Schedulable Trigger by ID
    • Patch Schedulable Trigger Attribute by ID
    • Delete Schedulable Trigger by ID
  • User Todo
    • Create User Todo
    • Get All User Todos
    • Get Count of All User Todos
    • Filter All User Todos
    • Count of Filtered User Todos
    • Complete User Todo
    • Get User Todo by ID
    • Patch User Todo Attributes by ID
    • Delete User Todo by ID
  • Workflow
    • Stages
      • Get Workflow Stages by Workflow ID
      • Get All Workflow Stages by Workflow ID
      • Get Stage Form for Workflow Stage
    • Get All Workflows
    • Create Workflow
    • Filter All Workflows
    • Count of Filtered Workflows
    • Get Workflow by ID
    • Patch Workflow Attributes by ID
    • Delete Workflow by ID
  1. Global User

Sign Up Global User

QAL
QAL
POST
/v1/identityManagement/globalUsers/signup
Create and signup a new global user. The email address for the global user should be unique.

Request

Body Params application/json
name
string 
Name of global user to create
required
Example:
Manupriyam Jindal
email
string <email>
Email of global user to create
required
Example:
manupriyamjindal@gmail.com
password
string 
Password of global user to create
required
profileImageUrl
string 
Public URL for the profile image
optional
defaultLanguage
string 
Default User Locale
required
Default:
en_IN
Match pattern:
^[a-z]{2}_([a-z]{2}|[A-Z]{2})$
defaultTimezone
string 
Timezone for the global user
required
Default:
Asia/Kolkata
Example:
Asia/Kolkata
phoneNumber
object (PhoneNumberContact) 
Phone Number of the global user
optional
countryCode
string 
Country code
required
Default:
91
Example:
91
Match pattern:
/^(\+?\d{1,3}|\d{1,4})$/
phoneNumber
string 
Mobile Number
required
Example:
9355923751
Match pattern:
/^(\+\d{1,3}[- ]?)?\d{10}$/
mobileAppDeviceTokens
array[object (MobileAppDeviceToken) {3}] 
Mobile app device tokens of the global user
optional
mobileAppPlatform
enum<string> 
required
Allowed values:
IOSANDROID
deviceToken
string 
required
tokenCreationDate
string <date-time>
Timestamp of token creation
required
Example
{
  "name": "Manupriyam Jindal",
  "email": "manupriyamjindal@gmail.com",
  "password": "string",
  "profileImageUrl": "string",
  "defaultLanguage": "en_IN",
  "defaultTimezone": "Asia/Kolkata",
  "phoneNumber": {
    "countryCode": "91",
    "phoneNumber": "9355923751"
  },
  "mobileAppDeviceTokens": [
    {
      "mobileAppPlatform": "IOS",
      "deviceToken": "string",
      "tokenCreationDate": "2019-08-24T14:15:22Z"
    }
  ]
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.qal.eazy2biz.com/v1/identityManagement/globalUsers/signup' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200Success
application/json
Body
_id
string 
ID of the global user
optional
name
string 
optional
email
string 
optional
profileImageUrl
string 
optional
defaultLanguage
string 
optional
defaultTimezone
string 
optional
phoneNumber
object 
PhoneNumberContact
optional
countryCode
string 
Country code
required
Default:
91
Example:
91
Match pattern:
/^(\+?\d{1,3}|\d{1,4})$/
phoneNumber
string 
Mobile Number
required
Example:
9355923751
Match pattern:
/^(\+\d{1,3}[- ]?)?\d{10}$/
companyMemberships
array[object (GlobalUserCompanyMembership) {3}] 
optional
companyId
number 
required
localUserId
string 
required
localUserEnabled
boolean 
required
awsCognitoUserId
string 
optional
mobileAppDeviceTokens
array[object (MobileAppDeviceToken) {3}] 
optional
mobileAppPlatform
enum<string> 
MobileAppPlatform
required
Allowed values:
IOSANDROID
deviceToken
string 
required
tokenCreationDate
string <date-time>
Timestamp of token creation
required
details
object 
Details
required
name
string 
required
companyId
number 
required
description
string 
optional
metaData
object 
MetaData
required
createdBy
string 
required
lastUpdatedBy
string 
required
createdDate
string <date-time>
required
lastUpdatedDate
string <date-time>
required
version
number 
required
enabled
boolean 
required
Example
{
  "_id": "string",
  "name": "string",
  "email": "string",
  "profileImageUrl": "string",
  "defaultLanguage": "string",
  "defaultTimezone": "string",
  "phoneNumber": {
    "countryCode": "91",
    "phoneNumber": "9355923751"
  },
  "companyMemberships": [
    {
      "companyId": 0,
      "localUserId": "string",
      "localUserEnabled": true
    }
  ],
  "awsCognitoUserId": "string",
  "mobileAppDeviceTokens": [
    {
      "mobileAppPlatform": "IOS",
      "deviceToken": "string",
      "tokenCreationDate": "2019-08-24T14:15:22Z"
    }
  ],
  "details": {
    "name": "string",
    "companyId": 0,
    "description": "string"
  },
  "metaData": {
    "createdBy": "string",
    "lastUpdatedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastUpdatedDate": "2019-08-24T14:15:22Z",
    "version": 0
  },
  "enabled": true
}
Modified at 2024-07-07 14:23:02
Previous
Get Count Of All Global Users
Next
Resend Confirmation Passcode
Built with