Skip to content

create.md

Latest commit

 

History

History
56 lines (43 loc) · 1.56 KB

create.md

File metadata and controls

56 lines (43 loc) · 1.56 KB
Raw

Role Create

Create a new role in the system.

URL Requires Auth HTTP Method
/api/v1/roles.create yes POST

Note:

  • This endpoint don't update existing roles. For that use roles.update.
  • It's not allowed to create new roles with the same name of existing roles. For example: creating a new role with the admin name is not possible.

Payload

Argument Example Required Description
name newRole Required The name of the new role.
scope Subscriptions Optional Default: Users The scope of the new role.
description Role description Optional A description for the new role.
mandatory2fa true Optional Default: false Whether the role should have a mandatory 2 Factor Authentication.

Example Call

curl -H "Content-type:application/json" \
     -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     http://localhost:3000/api/v1/roles.create \
     -d '{ "name": "newRole" }' \
     -d '{ "scope": "Subscriptions" }' \
     -d '{ "description": "Role description" }' \

Example Result

{
    "role": {
        "_id": "newRole",
        "name": "newRole",
        "scope": "Subscriptions",
        "description": "Role description",
        "_updatedAt": "2018-08-23T03:57:54.603Z"
    },
    "success": true
}

Change Log

Version Description
0.70.0 Added
3.15.0 Is no longer used to update roles