Adds a batch of directory users belonging to the domain or updates the existing directory users.
HTTP Request
POST https://<serviceURL>/api/v1/domains/<domain>/users
Request Parameters
Parameter |
Required |
Description |
---|---|---|
domain |
Yes |
Domain to which you want to add directory users. |
HTTP Request Example
POST https://<serviceURL>/api/v1/domains/sample1.com/users HTTP/1.1 Authorization: Basic c2FtcGxlOmZqZmo0OTBpNGpnaDAzM2dsajQzYXB3ZW1hMzEwdjEwamIxZ2lrM2oz Content-Encoding: gzip, deflate [ { "emailLocalPart":"user1", "displayName":"tom" }, { "emailLocalPart":"user2" } ]
HTTP Request Body
The request body is an array of directory users with detailed information about each one.
Name |
Type |
Length |
Pattern |
Required |
Description |
---|---|---|---|---|---|
emailLocalPart |
String |
255 characters |
^[-a-zA-Z0-9!#$%&\"'+/=?^_`{|}~][-a-zA-Z0-9!#$%&\"'+/=?^_`{|}~.]{0,254}$ |
Yes |
Local part of an email address. |
displayName |
String |
255 characters |
N/A |
No |
Display name of an email address. |
Response
On success, the service sends back an HTTP 204 response with no output; otherwise, the response body contains error details. For more information about errors, see API Response Codes.
Status Code |
Description |
---|---|
204 |
Successful. No content will be returned in the response body. |
Response Example
HTTP/1.1 204