Skip to main content

Create a new user

POST 
/CreateNewUser

Creates a new user in the account with the provided information.

Request​

Body

required

Add information for the new user.

    newRoleName string

    Possible values: [``, NewUserRole]

    If you have set the toggleButtonValue to create, then please provide the unique role name.

    lastName stringrequired

    Possible values: [Kirstan]

    Last name of the new user.

    newRoles

    object

    If you want to create a new role for the user then please provide the role permission in the form of App Name and its corresponding create, read, update, delete permission.

    Maps

    object

    Maps app permissions

    read boolean

    Possible values: [true, false]

    Provide true to enable the read permission for the Maps app, else provide false.

    create boolean

    Possible values: [true, false]

    Provide true to enable the create permission for the Maps app, else provide false.

    update boolean

    Possible values: [true, false]

    Provide true to enable the update permission for the Maps app, else provide false.

    delete boolean

    Possible values: [true, false]

    Provide true to enable the delete permission for the Maps app, else provide false.

    Warranty

    object

    Warranty app permissions

    read boolean

    Possible values: [true, false]

    Provide true to enable the read permission for the Warranty app, else provide false.

    create boolean

    Possible values: [true, false]

    Provide true to enable the create permission for the Warranty app, else provide false.

    update boolean

    Possible values: [true, false]

    Provide true to enable the update permission for the Warranty app, else provide false.

    delete boolean

    Provide true to enable the update permission for the Warranty app, else provide false.

    Assets

    object

    Assets app permissions

    read boolean

    Possible values: [true, false]

    Provide true to enable the read permission for the Assets app, else provide false.

    create boolean

    Possible values: [true, false]

    Provide true to enable the create permission for the Assets app, else provide false.

    update boolean

    Possible values: [true, false]

    Provide true to enable the update permission for the Assets app, else provide false.

    delete boolean

    Possible values: [true, false]

    Provide true to enable the delete permission for the Assets app, else provide false.

    Video

    object

    Video app permissions

    read boolean

    Possible values: [true, false]

    Provide true to enable the read permission for the Video app, else provide false.

    create boolean

    Possible values: [true, false]

    Provide true to enable the create permission for the Video app, else provide false.

    update boolean

    Possible values: [true, false]

    Provide true to enable the update permission for the Video app, else provide false.

    delete boolean

    Possible values: [true, false]

    Provide true to enable the delete permission for the Video app, else provide false.

    Manuals

    object

    Manuals app permissions

    read boolean

    Possible values: [true, false]

    Provide true to enable the read permission for the Manuals app, else provide false.

    create boolean

    Possible values: [true, false]

    Provide true to enable the create permission for the Manuals app, else provide false.

    update boolean

    Possible values: [true, false]

    Provide true to enable the update permission for the Manuals app, else provide false.

    delete boolean

    Possible values: [true, false]

    Provide true to enable the delete permission for the Manuals app, else provide false.

    Alerts

    object

    Alerts app permissions

    read boolean

    Possible values: [true, false]

    Provide true to enable the read permission for the Alerts app, else provide false.

    create boolean

    Possible values: [true, false]

    Provide true to enable the create permission for the Alerts app, else provide false.

    update boolean

    Possible values: [true, false]

    Provide true to enable the update permission for the Alerts app, else provide false.

    delete boolean

    Possible values: [true, false]

    Provide true to enable the delete permission for the Alerts app, else provide false.

    Devices

    object

    Devices app permissions

    read boolean

    Possible values: [true, false]

    Provide true to enable the read permission for the Devices app, else provide false.

    create boolean

    Possible values: [true, false]

    Provide true to enable the create permission for the Devices app, else provide false.

    update boolean

    Possible values: [true, false]

    Provide true to enable the update permission for the Devices app, else provide false.

    delete boolean

    Possible values: [true, false]

    Provide true to enable the delete permission for the Devices app, else provide false.

    orgName stringrequired

    Possible values: [Prometha]

    Organization name for the new user.

    discountClasses string

    Possible values: [``, {"ClassA":"18","ClassB":"10","ClassC":"0","DefaultClass":"25"}]

    Discount classes for the new user. Generally we provide it in the stringified JSON object format if you don't want to provide any values for now you can keep it as empty value

    fileInfo

    object

    File information for the new user.

    cdnUrl string

    Possible values: [https://ucarecdn.com/6bac5b09-7daf-479a-b665-d107039b0eed/]

    url for the user logo, provide any https urls or upload a file to upload care and store the cdnUrl of it.

    selectedSecurityGroup string[]required

    Please add the id's of the selected security groups for the new user. You must have created the security group before creating user

    userLoginType stringrequired

    Possible values: [COGNITO, SSO]

    Login type for the new user.

    firstName stringrequired

    Possible values: [Garry]

    First name of the new user.

    newRoleDescription string

    Possible values: [``, role created for the new user]

    Description of the new role for the new user. Provide a description for the new role if you are creating the new user and have set the toggleButtonValue to create

    toggleButtonValue string

    Possible values: [select, create]

    Toggle button value set to select if you are selecting the role from the existing available roles otherwise set it to the create to create new role

    userType stringrequired

    Possible values: [Customer, Manufacture, Distributor, SalesCompany]

    Type of the new user.

    selectedRole stringrequired

    Possible values: [UR-customer, ``]

    If you do have the existing role in the account please enter the id of that role, if you looking to create new role you keep this field empty.

    installedAppsData

    object

    required

    Installed apps data for the new user. Add App name as key and installation value either true or false for install or uninstall app respectively

    Training boolean

    Possible values: [true, false]

    set the value either true or false, true to install the app and false to uninstall

    Assets boolean

    Possible values: [true, false]

    set the value either true or false, true to install the app and false to uninstall

    Video boolean

    Possible values: [true, false]

    set the value either true or false, true to install the app and false to uninstall

    Manuals boolean

    Possible values: [true, false]

    set the value either true or false, true to install the app and false to uninstall

    Maintenance boolean

    Possible values: [true, false]

    set the value either true or false, true to install the app and false to uninstall

    Home boolean

    Possible values: [true, false]

    set the value either true or false, true to install the app and false to uninstall

    Systems boolean

    Possible values: [true, false]

    set the value either true or false, true to install the app and false to uninstall

    email stringrequired

    Possible values: [oqadhdta@sharklasers.com]

    Email of the new user.

    parentUser stringrequired

    Possible values: [US-rahul@industrility.com]

    Parent user userId for the new user.

Responses​

200 response

Loading...