Versions Compared

Old Version 9

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

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

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

Resource Path/
URL/mdm-admin/users/
HTTP MethodPOST
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/users/
  • 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 user as 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:

Code Block
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -d @'user.json' -k -v https://localhost:9443/mdm-admin/users/
 Sample output
Code Block
> POST /mdm-admin/users/ HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a
> Content-Length: 131
< HTTP/1.1 201 Created
< Date: Sat, 05 Mar 2016 09:12:23 GMT
< Content-Type: application/json
< Content-Length: 94
< Server: WSO2 Carbon Server
{"statusCode":201,"messageFromServer":"User by username: PRIMARY/kim was successfully added."}
Anchor
sample
sample
Sample JSON Definition 
Code Block
{  
   "username":"PRIMARY/kim",
   "firstname":"Kim",
   "lastname":"Bar",
   "emailAddress":"kim@gmail.com",
   "roles":[  
      "Marketing"
   ]
}
PropertyDefinitionData
Type 
username

Provide a preferred username for the user. The user name should be provided in the following format: <USER_STORE>/<USER_NAME>.

Example: Adding a user If where the users are managed via a Primary user store.

PRIMARY/username123

String
firstnameProvide the first name of the user.String
lastnameProvide the last name of the user.String
emailAddress

Provide the email address of the user.

Info

You need to ensure that you provide a valid email address as an email containing the URL to download the EMM mobile application will be sent to the user once the user is added successfully.

String
roles

Provide the user roles for the respective user. For more information on the roles you have created, see getting details of user roles.

Note

All roles starting with  Application/  are created for Service Providers (i.e., Application/admin_emm ). These roles only have permission to subscribe to the respective Service-provider application. Therefore make sure not to assign users to the roles starting with Application/.

String