1. New: POST /Environment/
2. New v2: POST /Environment/?version=2.0
3. Validate: POST /Environment/Validate/
4. Activate: PUT /Environment/{EnvironmentName}/Activate/
5. Deactivate: PUT /Environment/{EnvironmentName}/Deactivate/
6. Delete: DELETE /Environment/{EnvironmentName}/
7. New empty: POST /Environment/{EnvironmentName}/
8. Get: GET /Environment/

POST /Environment/

Description: Creates an Environment with Administrator user

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

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": "-"
}

Back to top

POST /Environment/?version=2.0

Description: Creates an Environment and user with administrator privileges with temporary password. Version 2

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

Responses

{
Id:
 string (in GUID format)
Id of a newly created environment

EnvironmentName:
 string
Name of the created environment.

TemporaryPassword:
 string
Temporary password of created administrator
}

Example

POST https://portal.workspace365.net/Provisioning/Environment/?version=2.0 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",
  "FirstName": "Admin",
  "LastName": "-"
}

Back to top

POST /Environment/Validate/

Description: Validates if the given Environment is valid for creating an Environment with Administrator user

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

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": "-"
}

Back to top

PUT /Environment/{EnvironmentName}/Activate/

Description: Activates the Environment

Schema

string 

Responses

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

Back to top

PUT /Environment/{EnvironmentName}/Deactivate/

Description: Deactivates the Environment

Responses

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

Back to top

DELETE /Environment/{EnvironmentName}/

Description: Deletes the Environment

Schema

string 

Responses

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

Back to top

POST /Environment/{EnvironmentName}/

Description: Creates an empty Environment

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

 
{

environmentName:
string
The name of the created Environment

registerUrl:
string
The url were the administrator can register

}
                    

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
}

Back to top

GET /Environment/

Description: Gets a list containing the environments

Responses

 
[
Environment {
name:
 string
The name of the environment
isActive:
 boolean
Whether the environment is active
creationDate:
 date
When the environment was created
}
]

                    

Example

GET https://portal.workspace365.net/Provisioning/Environment/ HTTP/1.1
Accept: application/json
Host: portal.workspace365.net
ProvisioningKey: C7656554-85A2-4AFD-BAB7-18C71593C4D2
X-Requested-With: XMLHttpRequest

Back to top