Sending Enrollment Invitations to Users

Description

Send the users a mail inviting them to download the EMM mobile application on their devices using the REST API given below.

Before running the REST API command to send the enrollment invitations to users make sure to configure WSO2 EMM as explained in step 4, under general server configurations.

Resource Path

/email-invitation

URL /mdm-admin/users/email-invitation

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/users/email-invitation

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 invite a user 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 @'user.json' -k -v https://localhost:9443/mdm-admin/users/email-invitation

Sample output

> POST /mdm-admin/users/email-invitation HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 15e588fd526efa07ce3b4825fd86cdc5
> Content-Length: 25
< HTTP/1.1 200 OK
< Date: Sun, 06 Mar 2016 17:10:20 GMT
< Content-Type: application/json
< Content-Length: 88
< Server: WSO2 Carbon Server
{"statusCode":200,"messageFromServer":"Email invitation was successfully sent to user."}

Sample JSON Definition

[
  "jim",
  "tom",
  "kim"
]

Property	Definition	Data Type
`username`	Name of the user. Multiple user names can be added by using comma separated values.	String