Templating
Templating is about provisioning a MS Teams user the easy way. Instead of creating or editing a user and set its properties one by one, templating allows you to apply a set of predefined properties all at once. Current supported properties in a template are the following:
- country
- collection of MS licenses
- collection of MS groups
- voice routing policy
You may define as many templates as you want per subscription. A template has a product key, a meaningful name and a description. Through a wizard, you can create new templates and tweak them to your needs. Afterward, all you have to do is applying the template to your MS users to provide them with the required properties.
Get the list of available templates
This API call allows you to retrieve all available templates for a given tenant and subscription.
Default template
A default template with id=0 will always be returned except in case of the search query parameter doesn't match. This template implements the minimum requirements for a Fusion user.
Request
Endpoint
GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/msteams/templates
Authorization
Required role
tenants.instance.subscriptions.instance.msteams.templates.list
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant managing the subscription |
sub_id | integer | Index of a subscription for which you want to retrieve the list of available templates |
URL/Query parameters
| Parameter | Type | Description | Required? |
|---|---|---|---|
search | string | Used to perform a search through all searchable properties of a template that look like the string passed | no |
Body
N/A
Response
Status codes
| Parameter | Description |
|---|---|
200 | List of found templates, with at least the default one |
400 | Error while retrieving the templates |
404 | The path tenant / subscription doesn't exist |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | string | The template ID, 0 for the default template | no |
sku | string | The product reference of the template | no |
name | string | The name of the template | no |
description | string | The description of the template | no |
Example
{
"templates": [
{
"id": 0,
"sku": "DEFAULT",
"name": "Default Fusion Template",
"description": "This template is the default Fusion template to use when no other templates are available"
},
{
"id": 8,
"sku": "BUT1234",
"name": "Belgian User Template",
"description": "This template has been implemented for dev purposes"
},
{
"id": 9,
"sku": "FUT6543",
"name": "French User Template",
"description": "Another template for dev purposes"
}
]
}Get the details of a template
This API call allows you to retrieve the details of a specific template for a given tenant and subscription.
Request
Endpoint
GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/msteams/templates/{template_id}
Authorization
Required role
tenants.instance.subscriptions.instance.msteams.templates.get
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant managing the subscription |
sub_id | integer | Index of a subscription for which you want to retrieve the details of a template |
template_id | integer | Index of the template for which you want to retrieve the details |
URL/Query parameters
N/A
Body
N/A
Response
Status codes
| Parameter | Description |
|---|---|
200 | The found template |
400 | Error while retrieving the template |
404 | The template doesn't exist |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | string | The template ID, 0 for the Default Template | no |
sku | string | The product reference of the template | no |
name | string | The name of the template | no |
description | string | The description of the template | no |
location | string | The country code of the user in ISO 3166 alpha-2 format | no |
voiceEnabled | boolean | Specify if the user will have the ability to make calls | no |
vrp | string | The voice routing policy that will be applied to the user | no |
groups | array | A list of MS groups id as returned by this API call | no |
licenses | array | A list of MS licenses skuId as returned by this API call | no |
customerLicenses | array | A list of Customer licenses | no |
Example
{
"id": 8,
"sku": "BUT1234",
"name": "Belgian User Template",
"description": "This template has been implemented for dev purposes",
"location": "BE",
"voiceEnabled": true,
"vrp": "World-DRaaS",
"groups": [
"488ce848-8b9b-4d14-8e99-90ee50ea150b",
"47a96cc2-a9bb-4abf-97a1-4e675f5b8605"
],
"licenses": [
"18181a46-0d4e-45cd-891e-60aabd171b4e",
"295a8eb0-f78d-45c7-8b5b-1eed5ed02dff"
],
"customerLicenses": [
"test-sku"
]
}Create a new template
This API call allows you to define a template for a given tenant and subscription.
Request
Endpoint
POST /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/msteams/templates
Authorization
Required role
tenants.instance.subscriptions.instance.msteams.templates.create
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant managing the subscription |
sub_id | integer | Index of a subscription for which you want to integrate an Anywhere 365 main site |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required |
|---|---|---|---|
sku | string | The product reference of the template | yes |
name | string | The name of the template | yes |
description | string | The description of the template | yes |
location | string | The country code of the user in ISO 3166 alpha-2 format as returned by this API call | yes |
vrp | string | The voice routing policy that will be applied to the user. It must an existing identity defined in MS Teams voice section and returned by this API call | yes |
groups | array | A list of MS groups id as returned by this API call | no |
licenses | array | A list of MS licenses skuId as returned by this API call | no |
customerLicenses | array | A list of Customer Licenses you want to assign to the user. | no |
Example
{
"sku": "FUT6543",
"name": "French User Template",
"description": "Another template for dev purposes",
"location": "FR",
"vrp": "World-DRaaS",
"groups": [
"47a96cc2-a9bb-4abf-97a1-4e675f5b8605",
"488ce848-8b9b-4d14-8e99-90ee50ea150b"
],
"licenses": [
"295a8eb0-f78d-45c7-8b5b-1eed5ed02dff",
"18181a46-0d4e-45cd-891e-60aabd171b4e"
]
}Response
Status codes
| Parameter | Description |
|---|---|
204 | The template was created successfully |
400 | Error while creating the template |
404 | The path tenant / subscription doesn't exist |
500 | Uncatched error on server side |
Success
Body
N/A
Update a template
This API call allows you to update a template for a given tenant and subscription.
Request
Endpoint
PUT /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/msteams/templates/{template_id}
Authorization
Required role
tenants.instance.subscriptions.instance.msteams.templates.update
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant managing the subscription |
sub_id | integer | Index of a subscription for which you want to integrate an Anywhere 365 main site |
template_id | integer | Index of the template you want to delete |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required |
|---|---|---|---|
name | string | The name of the template | no |
description | string | The description of the template | no |
location | string | The country code of the user in ISO 3166 alpha-2 format as returned by this API call | no |
vrp | string | The voice routing policy that will be applied to the user. It must an existing identity defined in MS Teams voice section and returned by this API call | no |
groups | array | A list of MS groups id as returned by this API call | no |
licenses | array | A list of MS licenses skuId as returned by this API call | no |
customerLicenses | array | A list of Customer Licenses you want to assign to the user. | no |
Example
{
"name": "French User Template",
"description": "Another template for dev purposes",
"location": "FR",
"vrp": "World-DRaaS",
"groups": [
"47a96cc2-a9bb-4abf-97a1-4e675f5b8605",
"488ce848-8b9b-4d14-8e99-90ee50ea150b"
],
"licenses": [
"295a8eb0-f78d-45c7-8b5b-1eed5ed02dff",
"18181a46-0d4e-45cd-891e-60aabd171b4e"
],
"customerLicenses": [
"test-sku"
]
}Response
Status codes
| Parameter | Description |
|---|---|
204 | The template was updated successfully |
400 | Error while creating the template |
404 | The path tenant / subscription doesn't exist |
500 | Uncatched error on server side |
Success
Body
N/A
Delete a template
This API call allows you to delete an existing template for a given tenant and subscription.
Request
Endpoint
DELETE /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/msteams/templates/{template_id}
Authorization
Required role
tenants.instance.subscriptions.instance.msteams.templates.delete
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant managing the subscription |
sub_id | integer | Index of a subscription for which you want to integrate an Anywhere 365 main site |
template_id | integer | Index of the template you want to delete |
URL/Query parameters
N/A
Body
N/A
Response
Status codes
| Parameter | Description |
|---|---|
204 | The template was deleted successfully. If the template didn't exist, the delete will be considered as being executed successfully |
400 | Error while deleting the template |
404 | The path tenant / subscription doesn't exist |
500 | Uncatched error on server side |
Success
Body
N/A