Latest version: v2.52
WhatsApp: 0623684723

Provisioning User

Follow

POST /{EnvironmentName}/User/

Description: Creates a User

Name

Located in

Description

Required

Schema

EnvironmentName

Path

Name of the Environment

Yes

string

User

Body

User to create

Yes

{
EmailAddress:
 string (email)
Email address of the user

FirstName:
 string
First name of the user

IsAdministrator:
 boolean
Whether the user is an Administrator

LastName:
 string
Last name of the user

Password:
 string (password)
Password of the user

CreateInOffice365:
 boolean
Whether the user should be 
created in Office 365
} 

 

Responses

Code

Description

Schema

200

The id of the created User

integer

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

 

404

Resource is not found

500

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

 

Example

POST https://portal.workspace365.net/Provisioning/example/User/ HTTP/1.1
Accept: application/json
Content-Length: 176
Content-Type: application/json
Host: portal.workspace365.net
ProvisioningKey: C7656554-85A2-4AFD-BAB7-18C71593C4D2
X-Requested-With: XMLHttpRequest

{
  "EmailAddress": "userone@example.com",
  "Password": "qwerty",
  "FirstName": "User",
  "LastName": "One",
  "IsAdministrator": false,
  "CreateInOffice365": false
}

 

POST /{EnvironmentName}/User/Validate/

Description: Validates if the given User is valid for creating

Name

Located in

Description

Required

Schema

EnvironmentName

Path

Name of the Environment

Yes

string

User

Body

User to create

Yes

{
EmailAddress:
 string (email)
Email address of the user

FirstName:
 string
First name of the user

IsAdministrator:
 boolean
Whether the user is an Administrator

LastName:
 string
Last name of the user

Password:
 string (password)
Password of the user

CreateInOffice365:
 boolean
Whether the user should be 
created in Office 365 }

 

Responses

Code

Description

Schema

200

The id of the created User

integer

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

 

404

Resource is not found

500

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

 

Example

POST https://portal.workspace365.net/Provisioning/example/User/ HTTP/1.1
Accept: application/json
Content-Length: 176
Content-Type: application/json
Host: portal.workspace365.net
ProvisioningKey: C7656554-85A2-4AFD-BAB7-18C71593C4D2
X-Requested-With: XMLHttpRequest

{
  "EmailAddress": "userone@example.com",
  "Password": "qwerty",
  "FirstName": "User",
  "LastName": "One",
  "IsAdministrator": false,
  "CreateInOffice365": false
}

 

PUT /{EnvironmentName}/User/{EmailAddress}/

Description: Updates a User

Name

Located in

Description

Required

EnvironmentName

Path

Name of the Environment

Yes

string

EmailAddress

Path

Email address of the User

Yes

string

User

Body

User to create

Yes

{
EmailAddress:
 string (email)
Email address of the user

FirstName:
 string
First name of the user

IsAdministrator:
 boolean
Whether the user is an Administrator

LastName:
 string
Last name of the user

Password:
 string (password)
Password of the user
}

 

Responses

Code

Description

Schema

200

The User was updated

 

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

 

404

The resource is not found

 

500

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

 


Example

PUT https://portal.workspace365.net/Provisioning/example/User/userone@example.com/HTTP/1.1
Accept: application/json
Content-Length: 145
Content-Type: application/json
Host: portal.workspace365.net
ProvisioningKey: C7656554-85A2-4AFD-BAB7-18C71593C4D2
X-Requested-With: XMLHttpRequest

{
  "EmailAddress": "userone@example.com",
  "Password": "qwert",
  "FirstName": "User",
  "LastName": "Once",
  "IsAdministrator": false
}

 

PUT /{EnvironmentName}/User/{EmailAddress}/Validate/

Description: Validates if the given User is valid for update

Name

Located in

Description

Required

EnvironmentName

Path

Name of the Environment

Yes

string

EmailAddress

Path

Email address of the User

Yes

string

User

Body

User to update

Yes

{
EmailAddress:
 string (email)
Email address of the user

FirstName:
 string
First name of the user

IsAdministrator:
 boolean
Whether the user is an Administrator

LastName:
 string
Last name of the user

Password:
 string (password)
Password of the user
}

 

Responses

Code

Description

Schema

200

The entered User is valid for update

 

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

 

404

The resource is not found

 

500

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

 


Example

PUT https://portal.workspace365.net/Provisioning/example/User/userone@example.com/HTTP/1.1
Accept: application/json
Content-Length: 145
Content-Type: application/json
Host: portal.workspace365.net
ProvisioningKey: C7656554-85A2-4AFD-BAB7-18C71593C4D2
X-Requested-With: XMLHttpRequest

{
  "EmailAddress": "userone@example.com",
  "Password": "qwert",
  "FirstName": "User",
  "LastName": "Once",
  "IsAdministrator": false
}

 

 

PUT /{EnvironmentName}/User/{EmailAddress}/Activate/

Description: Activates the User

Name

Located in

Description

Required

Schema

EnvironmentName

Path

Name of the Environment

Yes

string

EmailAddress

Path

Email address of the User

Yes

string

 

Responses

Code

Description

Schema

200

The user was set to Active

 

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

 

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/example/User/userone@example.com/Activate/HTTP/1.1
Accept: application/json
Content-Length: 0
Host: portal.workspace365.net
ProvisioningKey: C7656554-85A2-4AFD-BAB7-18C71593C4D2
X-Requested-With: XMLHttpRequest

 

PUT /{EnvironmentName}/User/{EmailAddress}/Deactivate/

Description: Deactivates the User

Name

Located in

Description

Required

Schema

EnvironmentName

Path

Name of the Environment

Yes

string

EmailAddress

Path

Email address of the User

Yes

string

 

Responses

Code

Description

Schema

200

The user was set to Deactivate

 

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

 

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/example/User/userone@example.com/Deactivate/HTTP/1.1
Accept: application/json
Content-Length: 0
Host: portal.workspace365.net
ProvisioningKey: C7656554-85A2-4AFD-BAB7-18C71593C4D2
X-Requested-With: XMLHttpRequest

 

DELETE /{EnvironmentName}/User/{EmailAddress}/

Description: Deletes the User

Name

Located in

Description

Required

Schema

EnvironmentName

Path

Name of the Environment

Yes

string

EmailAddress

Path

Email address of the User

Yes

string

 

Responses

Code

Description

Schema

200

The user was Deleted

 

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

 

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/example/User/userone@example.com/HTTP/1.1
Accept: application/json
Host: portal.workspace365.net
ProvisioningKey: C7656554-85A2-4AFD-BAB7-18C71593C4D2
X-Requested-With: XMLHttpRequest
Have more questions? Submit a request

Comments