Create new role

POST 
/CreateNewRole

Creates a new role with the specified permissions and details in the graph database.

Request

application/json

Body

required

Add information for creating a new role.

newRoleName stringrequired

Possible values: [new-user-role]

Name of the new role.

newRoles

object

required

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.

newRoleDescription stringrequired

Possible values: [role created for the new user]

Description of the new role.

Responses

201

201 response

application/json

Schema

Schema

data

object[]

Array [

label string

id string

]

roleName string

Possible values: [new-user-role]

Name of the newly created role.

roleDescription string

Possible values: [role created for the new user]

Description of the newly created role.

Example (from schema)

{
  "data": [
    {
      "label": "string",
      "id": "string"
    }
  ],
  "roleName": "new-user-role",
  "roleDescription": "role created for the new user"
}

400

400 response

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

401

401 response

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "string"
}

502

502 response

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "string"
}

504

504 response

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "string"
}

Loading...