Adding a Role via the REST API

Description

You are able to add a new role to WSO2 EMM using the REST API given below.

Resource Path /

URL /mdm-admin/roles/

HTTP Method POST

Request/Response Format application/json

cURL command

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -d @'<JSON_PAYLOAD>' -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-admin/roles/

For more information on how to generate the <EMM_API_TOKEN>, see Generating the EMM API Token.
Define the path to the JSON file, which includes the required properties to add a role as the <JSON_PAYLOAD> value. For more information, see the Sample JSON Definition.
By default, <EMM_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
By default, <EMM_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

Example:

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -d @'role.json' -k -v https://localhost:9443/mdm-admin/roles/

Sample output

> POST /mdm-admin/roles/ HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 0f963270d06e0859dc8fabeb2b4fa7d1
> Content-Length: 68
< HTTP/1.1 201 Created
< Date: Sun, 06 Mar 2016 13:20:03 GMT
< Content-Length: 0
< Server: WSO2 Carbon Server

Sample JSON Definition

{
  "roleName": "engineer",
  "permissions": [
    "device-mgt/policies/view",
    "device-mgt/users/view"
  ],
  "users": [
    "jim"
  ]
}

Property Definition Data
Type

roleName

Define the name of the role you wish to create. This is a mandatory field.

String

permissions

Provide the permissions that needs to be associated with the role. You can keep this property empty and update it later on.

For more information on the permissions, see permissions associated with the APIs.

String

users Provide the users that belong to the role you are creating. You can keep this property empty and update it later on. String