Provisioning Environment
FollowPOST /Environment/
Description: Creates an Environment with Administrator user
|
Name |
Located in |
Description |
Required |
|
Environment |
Body |
Environment to create |
Yes |
Schema
{ EmailAddress:
string (email)
Email address of the admin
EnvironmentName:
string
Name of the environment
FirstName:
string
First name of the admin
LastName:
string
Last name of the admin
Password:
string (password)
Password of the admin }
Responses
|
Code |
Description |
Schema |
|
200 |
Name of the created Environment. This value can differ with the entered data since it is sanitized. |
string |
|
400 |
Array of Validation Results |
[ValidationResult] |
|
403 |
The Provisioning Key in the configuration is not defined or empty. |
|
|
500 |
Internal server error. This could be caused by passing an incorrect data object |
Example
POST https://portal.workspace365.net/Provisioning/Environment/ HTTP/1.1
Accept: application/json
Content-Length: 148
Content-Type: application/json
ProvisioningKey: C7656554-85A2-4AFD-BAB7-18C71593C4D2
Host: portal.workspace365.net
X-Requested-With: XMLHttpRequest {
"EnvironmentName": "Example",
"EmailAddress": "admin@example.com",
"Password": "qwerty",
"FirstName": "Admin",
"LastName": "-"
}
POST /Environment/Validate/
Description: Validates if the given Environment is valid for creating an Environment with Administrator user
|
Name |
Located in |
Description |
Required |
|
Environment |
Body |
Environment to create |
Yes |
Schema
{ EmailAddress:
string (email)
Email address of the admin
EnvironmentName:
string
Name of the environment
FirstName:
string
First name of the admin
LastName:
string
Last name of the admin
Password:
string (password)
Password of the admin }
Responses
|
Code |
Description |
Schema |
|
200 |
Name of the created Environment |
string |
|
400 |
Array of Validation Results |
[ValidationResult] |
|
403 |
The Provisioning Key in the configuration is not defined or empty. |
|
|
500 |
Internal server error. This could be caused by passing an incorrect data object |
|
Example
POST https://portal.workspace365.net/Provisioning/Environment/Validate/ HTTP/1.1
Accept: application/json Content-Length: 148 Content-Type: application/json ProvisioningKey: C7656554-85A2-4AFD-BAB7-18C71593C4D2 Host: portal.workspace365.net X-Requested-With: XMLHttpRequest { "EnvironmentName": "Example", "EmailAddress": "admin@example.com", "Password": "qwerty", "FirstName": "Admin", "LastName": "-" }
PUT /Environment/{EnvironmentName}/Activate/
Description: Activates the Environment
|
Name |
Located in |
Description |
Required |
|
EnvironmentName |
Path |
Name of the Environment |
Yes |
Schema
string
Responses
|
Code |
Description |
Schema |
|
200 |
The Environment was set to active |
string |
|
403 |
The Provisioning Key in the configuration is not defined or empty. |
[ValidationResult] |
|
404 |
The resource is not found |
|
|
411 |
The header “Content-Length: 0” is missing |
|
|
500 |
Internal server error. This could be caused by passing an incorrect data object |
Example
PUT https://portal.workspace365.net/Provisioning/Environment/example/Activate/HTTP/1.1 Accept: application/json Content-Length: 0 ProvisioningKey: C7656554-85A2-4AFD-BAB7-18C71593C4D2 Host: portal.workspace365.net X-Requested-With: XMLHttpRequest
PUT /Environment/{EnvironmentName}/Deactivate/
Description: Deactivates the Environment
|
Name |
Located in |
Description |
Required |
|
EnvironmentName |
Path |
Name of the Environment |
Yes |
Responses
|
Code |
Description |
Schema |
|
200 |
The Environment was set to active |
string |
|
403 |
The Provisioning Key in the configuration is not defined or empty. |
[ValidationResult] |
|
404 |
The resource is not found |
|
|
411 |
The header “Content-Length: 0” is missing |
|
|
500 |
Internal server error. This could be caused by passing an incorrect data object |
Example
PUT https://portal.workspace365.net/Provisioning/Environment/example/Deactivate/HTTP/1.1 Accept: application/json Content-Length: 0 ProvisioningKey: C7656554-85A2-4AFD-BAB7-18C71593C4D2 Host: portal.workspace365.net X-Requested-With: XMLHttpRequest
DELETE /Environment/{EnvironmentName}/
Description: Deletes the Environment
|
Name |
Located in |
Description |
Required |
|
EnvironmentName |
Path |
Name of the Environment |
Yes |
Schema
string
Responses
|
Code |
Description |
Schema |
|
200 |
The Environment was deleted |
string |
|
403 |
The Provisioning Key in the configuration is not defined or empty. |
[ValidationResult] |
|
404 |
The resource is not found |
|
| 500 | Internal server error. This could be caused by passing an incorrect data object |
Example
DELETE https://portal.workspace365.net/Provisioning/Environment/example/HTTP/1.1 Accept: application/json ProvisioningKey: C7656554-85A2-4AFD-BAB7-18C71593C4D2 Host: portal.workspace365.net X-Requested-With: XMLHttpRequest
POST /Environment/{EnvironmentName}/
Description: Creates an empty Environment
|
Name |
Located in |
Description |
Required |
|
EnvironmentName |
Body |
Environment to create |
Yes |
Schema
{
EmailAddress:
string (email)
Email address to send the admin registration link to
EnvironmentName:
string
Name of the environment
LicenseCount:
integer
The total number of purchased User Licenses
}
Responses
|
Code |
Description |
Schema |
|
200 |
Information about the created Environment |
{
environmentName:
string
The name of the created Environment
registerUrl:
string
The url were the administrator can register
}
|
|
400 |
Array of Validation Results |
[ValidationResult] |
|
403 |
The Provisioning Key in the configuration is not defined or empty. |
|
| 500 | Internal server error. This could be caused by passing an incorrect data object |
Example
POST https://portal.workspace365.net/Provisioning/Environment/ HTTP/1.1
Accept: application/json
Content-Length: 99
Content-Type: application/json
Host: portal.workspace365.net
ProvisioningKey: C7656554-85A2-4AFD-BAB7-18C71593C4D2
X-Requested-With: XMLHttpRequest
{
"EnvironmentName": "example",
"EmailAddress": "admin@example.com",
"LicenseCount": 99
}