Organization admin requests:

Request Purpose
POST /users Create a user
GET /users Retrieve a list of users and their details
GET /users/<user_id> Retrieve a user’s details
PUT /users/<user_id> Update a user’s details
PATCH /users/<user_id> Selectively edit a user’s details
DELETE /users/<user_id> Delete a user
POST /integrations Create an integration
GET /integrations Retrieve a list of integrations and their details
GET /integrations/<integration_id> Retrieve an integration’s details
PUT /integrations/<integration_id> Update an integration’s details
PATCH /integrations/<integration_id> Selectively edit an integration’s details
DELETE /integrations/<integration_id> Delete an integration

Managing users

Create a user

New in Cloud 4.6, API minor version 7.

To create a user, make an HTTPS POST request to:

/users

This creates a user in the organization.

The body of this request is the request object user. Refer to user request object.

On success this generates a 201 Created response with a Location header field containing the URI of the newly created user resource. The response body is the response object user. Refer to user response object.

Retrieve a list of users and their details

New in Cloud 4.6, API minor version 7.

To retrieve a list of users and their details, make an HTTPS GET request to:

/users

There is no request body. However, there are optional query parameters that you can use in the request to page the response:

  • count: The number of user records that you want returned. If not specified, all the records will be returned.
  • startIndex: When you make the request, the Cloud will skip the user records prior to the number that you specify for startIndex. Use startIndex to get the next set of user records. If not specified, startIndex defaults to 1.

For example, HTTPS GET /users?count=20&startIndex=41 will skip the first 40 users and return the next 20.

On success, this request generates a 200 OK response with a body having the following structure:

{ 
  "itemsPerPage": <integer>,
  "startIndex": <integer>,
  "totalResults": <integer>,
  "users": [
	<user response object>,
	<user response object>,
	...] 
} 	

Field

Description

itemsPerPage

The number of items, which will either be equal to totalResults or if you made the request with count specified, it will be equal to the number you specified.

startIndex

This will be the same as the requested startIndex. If not specified, it will be 1.

totalResults

The total number of user records for the organization.
users A list of user response objects. Refer to user response object.

Retrieve a user’s details

New in Cloud 4.6, API minor version 7.

To retrieve a user’s details, make an HTTPS GET request to:

/users/<user_id>

where <user_id> is the unique identifier user details returned when the user was created.

There is no request body.

On success, this generates a 200 OK response with a body which is the response object user. Refer to user response object.

Update a user’s details

New in Cloud 4.6, API minor version 7.

To edit a user, make an HTTPS PUT request to:

/users/<user_id>

where <user_id> is the unique identifier returned when the user was created.

This request is used to update an existing user. Values that are not provided by the request will be populated with the default settings for those values.

The body of this request is the request object user. Refer to user request object.

On success, this generates a 200 OK response with a body which is the response object user. Refer to user response object.

Selectively edit a user’s details

New in Cloud 4.6, API minor version 7.

To selectively edit a user, make an HTTPS PATCH request to:

/users/<user_id>

where <user_id> is the unique identifier returned when the user was created.

Use this request to update an existing user where only particular settings need to be edited. Where values are not provided the existing settings will persist.

The body of this request is the request object user. Refer to user request object. All fields are optional.

On success, this generates a 200 OK response with a body which is the response object user. Refer to user response object.

Delete a user

New in Cloud 4.6, API minor version 7.

To delete a user, make an HTTPS DELETE request to:

/users/<user_id>

where <user_id> is the unique identifier returned when the user was created.

There is no request body.

On success, this generates a 204 No Content response.

Managing integrations

Create an integration

New in Cloud 4.6, API minor version 7.

An integration can be used to access the API, for example, to create conferences in an organization.

To create an integration in an organization, make an HTTPS POST request to:

/integrations

This creates an integration.

The body of this request is the request object create_integration. Refer to create_integration request object.

On success, this generates a 201 Created response with a body which is the response object integration. Refer to integration response object.

Retrieve a list of integrations and their details

New in Cloud 4.6, API minor version 7.

To retrieve a list of integrations and their details, make an HTTPS GET request to:

/integrations

There is no request body.

On success, this request generates a 200 OK response with a body having the following structure:

[
  <integration response object>,
  <integration response object>,
...]  	

This is a list of integration response objects. Refer to integration response object.

Retrieve an integration’s details

New in Cloud 4.6, API minor version 7.

To retrieve details of an integration, make an HTTP GET request to:

/integrations/<integration_id>

There is no request body.

On success, this generates a 200 OK response with a body which is the response object integration. Refer to integration response object.

Update an integration’s details

New in Cloud 4.6, API minor version 7.

To update an integration, make an HTTPS PUT request to:

/integrations/<integration_id>

where <integration_id> is the unique identifier for the integration returned when the integration was created. Used to update an existing integration. Values that are not provided by the request will be populated with the default settings for those values.

The body of this request is the request object update_integration. Refer to update_integration request object.

On success, this generates a 200 OK response with a body which is the response object integration. Refer to integration response object.

Selectively edit an integration’s details

New in Cloud 4.6, API minor version 7.

To selectively edit an integration, make an HTTPS PATCH request to:

/integrations/<integration_id>

where <integration_id> is the unique identifier for the integration returned when the integration was created.

Use this request to update an existing integration where only particular settings need to be edited. Where values are not provided the existing settings will persist.

The body of this request is the request object update_integration. Refer to update_integration request object. All fields are optional.

On success, this generates a 200 OK response with a body which is the response object integration. Refer to integration response object.

Delete an integration

New in Cloud 4.6, API minor version 7.

To delete an integration, make an HTTPS DELETE request to:

/integrations/<integration_id>

where <integration_id> is the unique identifier returned when the integration was created.

There is no request body.

On success, this generates a 204 No Content response.