Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
Description

You are able to add users to the role while creating a new role. At the point of creating a new role defining the users to a role is optional, therefore you are able to update the users that belong to a given role after you have created a role using the REST API given below.

Example: Your Organization hires 30 new engineers. Updating the role details for each user can be cumbersome, therefore you can define all the new eployees that belong to the engineer role using this API.

URL/mdm-admin/roles/users?rolename={rolename}
HTTP MethodPUT
Request/Response Formatapplication/json
cURL command
Code Block
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/users?rolename={rolename} 
  • 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 update the 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.
  • Provide the name of the role you wish to update as the value for {rolename}.

Example:

Code Block
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -d @'role.json' -k -v https://localhost:9443/mdm-admin/roles/users?rolename=engineer 
 Sample output
Code Block
> PUT /mdm-admin/roles/users?rolename=engineer HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 13dd6b016e72a41e5905e0c28a791da133392fb365b3ac693b405b565ddc8a3a
> Content-Length: 25
< HTTP/1.1 200 OK
< Cache-Control: private
< Expires: Thu, 01 Jan 1970 05:30:00 IST
< Date: Sun, 06 Mar 2016 13:45:02 GMT
< Content-Length: 0
< Server: WSO2 Carbon Server
Anchor
sampleUpdateRoleUsers
sampleUpdateRoleUsers
Sample JSON Definition 
Code Block
[
  "jim",
  "tom",
  "kim"
]
PropertyDefinitionData
Type 
usersDefine the users that belong to the role. Multiple users can be added to a role by using comma separated values. String