Minimum Endpoint Version – Tenant Level Configuration

These APIs enable Administrators to reject endpoints at the tenant level based on:

• ApplicationName. By default, the following Application Names are configured to be rejected:

• VidyoDesktop
• VidyoMobile

• EndpointType. By default, the following endpoints are configured to be rejected:

• V- VidyoRoom HD200 (Windows)
• R- VidyoRoom HD100/HD50 (Windows) 

The reject endpoints created at the tenant level can override the system default.

Rejection occurs during login sequence (LinkEndpoint) and JoinConference. 

Create Tenant Level Rejected Application

URL: /admin/api/v1/tenants{tenantId}/rejections/applications

Method: POST

Parameters

Field	Data type	Mandatory	Description
tenantId	String	Y	The tenantId of tenant or tenant host name.

Request body

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

Error responses

HTTP response code	Error message
400	Bad Request
401	Unauthorized
403	Forbidden
500	Internal server error

Get All Tenant Rejected Applications

URL: /admin/api/v1/tenants{tenantId}/rejections/applications

Method: GET

Parameters

Field	Data type	Mandatory	Description
tenantId	String	Y	The tenantd of tenant or tenant host name.

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

Error responses

HTTP response code	Error message
401	Unauthorized
403	Forbidden
500	Internal server error

Get Tenant Level Rejected Application

URL: /admin/api/v1/tenants{tenantId}/rejections/applications/{rejectedApplicationId}

Method: GET

Parameters

Field	Data type	Mandatory	Description
tenantId	String	Y	The tenantId of tenant or tenant host name.
rejectedApplicationId	Integer	Y	Rejected application id.

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

Error responses

HTTP response code	Error message
400	Bad Request
401	Unauthorized
403	Forbidden
500	Internal server error

Update Tenant Level Rejected Application

URL: /admin/api/v1/tenants{tenantId}/rejections/applications/{rejectedApplicationId}

Method: PUT

Parameters

Field	Data type	Mandatory	Description
tenantId	String	Y	The tenantId of tenant or tenant host name.
rejectedApplicationId	Integer	Y	Rejected application id to update.

Request body

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

Error responses

HTTP response code	Error message
400	Bad Request
401	Unauthorized
403	Forbidden
500	Internal server error

Delete Tenant Level Rejected Application

URL: /admin/api/v1/tenants{tenantId}/rejections/applications/{rejectedApplicationId}

Method: DELETE

Parameters

Field	Data type	Mandatory	Description
tenantId	String	Y	The tenantId of tenant or tenant host name.
rejectedApplicationId	Integer	Y	Rejected application id to delete.

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

Error responses

HTTP response code	Error message
400	Bad Request
401	Unauthorized
403	Forbidden
500	Internal server error

Create Tenant Level Rejected Endpoint Type

URL: /admin/api/v1/tenants{tenantId}/rejections/endpointTypes/

Method: POST

Parameters

Field	Data type	Mandatory	Description
tenantId	String	Y	The tenantId of tenant or tenant host name.

Request body

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

Error responses

HTTP response code	Error message
400	Bad Request
401	Unauthorized
403	Forbidden
500	Internal server error

Get All Tenant Level Rejected Endpoint Types

URL: /admin/api/v1/tenants/{tenantid}/rejections/endpointTypes

Method: GET

Parameters

Field	Data type	Mandatory	Description
tenantId	String	Y	The tenantId of tenant or tenant host name.

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

Error responses

HTTP response code	Error message
401	Unauthorized
403	Forbidden
500	Internal server error

Get Tenant Level Rejected Endpoint Type

URL: /admin/api/v1/tenants/{tenantId}/rejections/endpointTypes/{rejectedEndpointTypeId}

Method: GET

Parameters

Field	Data type	Mandatory	Description
tenantId	String	Y	The tenantId of tenant or tenant host name.
rejectedEndpointTypeId	Integer	Y	Rejected endpoint type id.

Success response  

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

Error responses

HTTP response code	Error message
400	Bad Request
401	Unauthorized
403	Forbidden
500	Internal server error

Update Tenant Level Rejected Endpoint Type

URL: /admin/api/v1/tenants/{tenantId}/rejections/endpointTypes/{rejectedEndpointTypeId}

Method: PUT

Parameters

Field	Data type	Mandatory	Description
tenantId	String	Y	The tenantId of tenant or tenant host name
rejectedEndpointTypeId	Integer	Y	Rejected enpoint type id to update.

Request body

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

Error responses

HTTP response code	Error message
400	Bad Request
401	Unauthorized
403	Forbidden
500	Internal server error

Delete Tenant Level Rejected Endpoint Type

URL: /admin/api/v1/tenants/{tenantId}/rejections/endpointTypes/{rejectedEndpointTypeId}

Method: DELETE

Parameters

Field	Data type	Mandatory	Description
tenantId	String	Y	The tenantId of tenant or tenant host name.
rejectedEndpointTypeId	Integer	Y	Rejected endpoint type id to delete

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

Error responses

HTTP response code	Error message
400	Bad Request
401	Unauthorized
403	Forbidden
500	Internal server error