Latest version:
Submit Support Request
WhatsApp: +31 (0)623684723

Articles in this section

Other Sections

Provisioning Environment

Follow
Created:
Updated:
 
Note: The provisioning User License is deprecated from v.3.3.0 om 23/08/2019
  1. New: POST /Environment/
  2. Validate: POST /Environment/Validate/
  3. Activate: PUT /Environment/{EnvironmentName}/Activate/
  4. Deactivate: PUT /Environment/{EnvironmentName}/Deactivate/
  5. Delete: DELETE /Environment/{EnvironmentName}/
  6. New empty: POST /Environment/{EnvironmentName}/
  7. Get: GET /Environment/

 

POST /Environment/

Description: Creates an Environment with Administrator user

NOTE: Is NOT available when UseEmptyEnvironment is configured to True or when UseUserLicenses is configured to True. The terms and conditions will automatically be accepted if using this function.

 

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.
The Provisioning API is not enabled in the configuration.
The Provisioning Key in the header does not match the configured value

  

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

 

Back to top

 

POST /Environment/Validate/

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

NOTE: Is NOT available when UseEmptyEnvironment is configured to True or when UseUserLicenses is configured to True

 

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.
The Provisioning API is not enabled in the configuration.
The Provisioning Key in the header does not match the configured value

 

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

 

Back to top

 

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.
The Provisioning API is not enabled in the configuration.
The Provisioning Key in the header does not match the configured value

[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

 

Back to top

 

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.
The Provisioning API is not enabled in the configuration.
The Provisioning Key in the header does not match the configured value

[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

 

Back to top

 

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.
The Provisioning API is not enabled in the configuration.
The Provisioning Key in the header does not match the configured value

[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

 

Back to top

 

POST /Environment/{EnvironmentName}/

Description: Creates an empty Environment

NOTE: Is NOT available when UseEmptyEnvironment is configured to False

 

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.
The Provisioning API is not enabled in the configuration.
The Provisioning Key in the header does not match the configured value

  
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
}

 

Back to top

 

GET /Environment/

Description: Gets a list containing the environments

Responses

Code

Description

Schema

200

The environments

 
 
[
Environment {
name:
 string
The name of the environment
isActive:
 boolean
Whether the environment is active
creationDate:
 date
When the environment was created
}
]
403 The Provisioning Key in the configuration is not defined or empty.
The Provisioning API is not enabled in the configuration.
The Provisioning Key in the header does not match the configured value		  

500

 Internal server error. This could be caused by passing an incorrect data object  

 

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

Was this article helpful?

Have more questions? Submit a request