Subscriptions
A tenant can have 1 or more subscriptions on the Fusion platform. These are subscriptions that really drive the service.
Get a list of subscriptions
The following endpoint gives the list of existing subscriptions for a given tenant and some of their characteristics.
Request
Endpoint
GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions
Authorization
Required role
tenants.instance.subscriptions.list
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant for which you want to get its subscriptions |
URL/Query parameters
| Parameter | Type | Description | Required? |
|---|---|---|---|
search | string | Used to perform a search through all searchable properties of a distributor that look like the string passed | no |
sort | string | Allows to specify one searchable property of a distributor to apply a sorting operation | no |
dir | string | When performing a sort operation, specifies the type. Allowed values are asc for ascending (default) or desc for descending | no |
page_size | integer | Used for pagination, determines the maximum number of records on one page of results (defaults to 10) | no |
page | integer | Used for pagination, determines the returned page from the collection of result pages (defaults to 1) | no |
Response
Status codes
| Parameter | Description |
|---|---|
200 | One or more subscriptions found |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | No subscription found |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
results | integer | Total number of results from the query | no |
pages | integer | Total number of pages according to pagination settings | no |
page | integer | Current displayed page from the set of pages | no |
subscriptions | array | List containing all subscription objects for the tenant | no |
Subscription Object
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | integer | Index of the subscription | no |
name | string | Name of the subscription | no |
billingId | string | External ID used in CDR as billing reference (unique per Group). | no |
licenses | object | List containing all licenses assigned to this subscription | no |
suspensionProfileId | string | Barring profile ID of the suspension profile | yes |
uc | string | UC of the subscription. See UC values. | no |
Licenses
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
msTeamsUsers | integer | Amount of MS Teams users for which a number can be provisioned under this subscription | no |
sipTrunkChannels | integer | Maximum amount of simultaneous SIP trunk calls (in+out) that can be setup by this subscription | no |
UC values
Possible values are:
msteams,webex,zoom.
Example
{
"results": 2,
"pages": 1,
"page": 1,
"subscriptions": [
{
"id": 5,
"billingId": "cloudblue::tenant::67",
"name": "Another Test Subscription",
"licenses": {
"msTeamsUsers": 10,
"sipTrunkChannels": 0
},
"suspensionProfileId": "suspended_5",
"uc": "webex"
},
{
"id": 4,
"billingId": "cloudblue::tenant::34",
"name": "Test Subscription",
"licenses": {
"msTeamsUsers": 20,
"sipTrunkChannels": 50
},
"uc": "msteams"
}
]
}Get a specific subscription
The following endpoint returns a specific subscription for a given tenant together with its characteristics.
Request
Endpoint
GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}
Authorization
Required role
tenants.instance.subscriptions.read
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant for which you want to get its subscriptions |
id | integer | Index of an existing subscription |
URL/Query parameters
N/A
Response
Status codes
| Parameter | Description |
|---|---|
200 | The subscription if found |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | No subscription found |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | integer | Index of the subscription | no |
name | string | Name of the subscription | no |
billingId | string | External ID used in CDR as billing reference (unique per Group). | no |
licenses | object | List containing all licenses assigned to this subscription | no |
msteamsAdmin | object | Information about the MS Teams administrator if any | yes |
msteamsTenant | object | Information about the MS Teams tenant if any | yes |
numberOfUsers | integer | The number of MS Teams users that have onboarded Fusion service (equal to the number of effective users that are linked to a phone number from the subscription) | no |
numberOfTrunkgroups | integer | The number of SIP trunk channels that have been subscribed | no |
phoneNumbers | object | Information about the amount of phone numbers that belong to the subscription and their assignments to different usages | no |
suspensionProfileId | string | Barring profile ID of the suspension profile | yes |
isDeletable | boolean | Set to true if the subscription might be deleted, meaning no object is linked to it in any way, false otherwise | no |
assignedEntities | array | List containing the assigned entities blocking for delete. See Assigned Entities. | no |
uc | string | UC of the subscription. See UC values. | no |
MS Teams Administrator Object
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
msUsername | string | Principal name of the MS Teams administrator as found in Azure AD | no |
name | string | Indicates if the administrator account is valid and allowed to use powershell integration | no |
MS Teams Tenant Object
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | string | UUID of the MS Teams tenant as found in Azure AD | no |
mode | string | Indicates the mode of integrations of the tenant. Returned values are either direct_routing or operator_connect | no |
Phone Numbers Amount Object
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
total | integer | Total amount of phone numbers linked to the subscription | no |
free | integer | From total, fraction of phone numbers that are still free for assignment (excluding Operator Connect ones) | yes |
linkedToUsers | integer | From total, fraction of phone numbers that are linked to MS Teams users | yes |
linkedToTrunkgroups | integer | From total, fraction of phone numbers that are linked to trunkgroups | yes |
linkedToOperatorConnect | integer | From total, fraction of phone numbers that are reserved for Operator Connect, ready for MS Teams user assignment | yes |
Assigned Entities values
Possible values are:
MS Admin,MS Tenant,MS Users,Trunkgroups,Phone numbers,Anywhere,Templates.
Example
{
"id": 175,
"name": "O365Subscription",
"billingId": "1",
"licenses": {
"msTeamsUsers": 5,
"sipTrunkChannels": 0
},
"msteamsAdmin": {
"msUsername": "john.doe@netaxistest.onmicrosoft.com",
"status": "active"
},
"msteamsTenant": {
"id": "5555b1dc-3add-428d-a0e4-cd0261be23b7",
"mode": "direct_routing"
},
"numberOfUsers": 6,
"numberOfTrunkgroups": 10,
"phoneNumbers": {
"total": 52,
"free": 47,
"linkedToUsers": 5,
"linkedToTrunkgroups": 0,
"linkedToOperatorConnect": 0
},
"isDeletable": false,
"assignedEntities": [
"MS Admin",
"MS Tenant",
"MS Users",
"Trunkgroups",
"Phone numbers",
"Templates"
],
"uc": "webex"
}Create a new subscription
Use this endpoint to create a new subscription for a tenant on the platform.
Request
Endpoint
POST /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions
Authorization
Required role
tenants.instance.subscriptions.create
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant for which you want to create a subscription |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required |
|---|---|---|---|
name | string | Name the subscription | yes |
billingId | string | External ID used in CDR as billing reference (unique per Group). | yes |
uc | string | UC of the subscription. See UC values. | no |
Example
{
"name": "Test Subscription 46",
"billingId": "cloudblue::distributor::163",
"uc": "webex"
}Response
Status codes
| Parameter | Description |
|---|---|
200 | The subscription was created successfully |
400 | Error while creating the subscription |
403 | The API consumer doesn't have sufficient rights to perform this action |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional |
|---|---|---|---|
id | integer | Index of the created subscription | no |
Example
{
"id": 12
}Modify an existing subscription
Use this endpoint to modify an existing subscription for a tenant on the platform.
Request
Endpoint
PUT /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}
Authorization
Required role
tenants.instance.subscriptions.instance.update
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant for which you want to modify the subscription |
id | integer | Index of an existing subscription |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required |
|---|---|---|---|
name | string | New name for the subscription | no |
billingId | string | New external ID used in CDR as billing reference (unique per Group). | no |
suspensionProfileId | integer | Index of the suspension profile as returned by this endpoint or null if you want to remove any suspension | yes |
Example
{
"name": "CBUR Test Subscription 45",
"billingId": "cloudblue::distributor::162",
"suspensionProfileId": 2
}Response
Status codes
| Parameter | Description |
|---|---|
200 | The subscription was updated successfully |
400 | Error while updating the subscription |
403 | The API consumer doesn't have sufficient rights to perform this action |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional |
|---|---|---|---|
id | integer | Index of the modified subscription | no |
Example
{
"id": 12
}Delete a subscription
Use this endpoint to delete an existing subscription for a tenant on the platform.
Request
Endpoint
DELETE /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}
Authorization
Required role
tenants.instance.subscriptions.instance.update
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant for which you would like to delete a subscription |
id | integer | Index of an existing subscription |
URL/Query parameters
N/A
Body
N/A
Response
Status codes
| Parameter | Description |
|---|---|
200 | The subscription was deleted successfully. If the subscription didn't exist, the delete will be considered as being executed successfully |
400 | Error while deleting the subscription |
403 | The API consumer doesn't have sufficient rights to perform this action |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional |
|---|---|---|---|
id | integer | Index of the deleted subscription | no |
Example
{
"id": 12
}List all the rate plans supported by the subscription
Currently the platform only distinguishes between MS Teams and SIP Trunking calls. However, this might change in the future. This endpoint returns the actual price plans supported by the subscription.
Request
Endpoint
GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/rate_plans
Authorization
Required role
tenants.instance.subscriptions.instance.rate_plans.list
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant for which you want to get the supported rate plans |
id | integer | Index of an existing subscription |
URL/Query parameters
N/A
Response
Status codes
| Parameter | Description |
|---|---|
200 | One or more rate plans found |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
currency | string | The currency code, accordingly to the currency setting. | no |
ratePlans | array | List containing the rate plans supported by the platform. | no |
Example
{
"currency": "EUR",
"ratePlans": [
{
"id": "msteams",
"name": "MS Teams",
"description": "Applicable for all calls made from a MS Teams account"
},
{
"id": "trunking",
"name": "SIP trunking",
"description": "Applicable for all calls made from a SIP trunk"
}
]
}Get a specific rateplan
This endpoint returns a specific rateplan for the susbcription with all different prices that apply (setup + per minute) per destination.
Request
Endpoint
GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/rate_plans/{rate_plan}
Authorization
Required role
tenants.instance.subscriptions.instance.rate_plans.instance.read
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant for which you want to get the supported rate plans |
id | integer | Index of an existing subscription |
rate_plan | string | Refers to the rateplan for which you want to get the pricing. See also rate plans |
URL/Query parameters
N/A
Response
Status codes
| Parameter | Description |
|---|---|
200 | One or more prices found |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
prices | array | List containing the latest price objects for any dial plan groups. | no |
Example
{
"prices": [
{
"activeSince": "2022-08-06 00:00:00",
"destination": "Italy",
"destinationId": 177,
"international": {
"duration": 0,
"setup": 0
},
"national": {
"duration": 0,
"setup": 0
},
"nextUpdate": "2022-08-11 00:00:00"
},
{
"activeSince": "2022-08-04 00:00:00",
"destination": "Belgium Freephone",
"destinationId": 427,
"international": {
"duration": 4.68,
"setup": 5.78
},
"national": {
"duration": 2.43,
"setup": 5.8
},
"nextUpdate": "2022-08-10 00:00:00"
},
{
"activeSince": "2022-08-02 00:00:00",
"destination": "Croatia Premium",
"destinationId": 450,
"international": {
"duration": 7.51,
"setup": 6.24
},
"national": {
"duration": 4.97,
"setup": 3.7
}
},
{
"activeSince": "2022-07-12 00:00:00",
"destination": "Austria Freephone",
"destinationId": 414,
"international": {
"duration": 4.68,
"setup": 3.47
},
"national": {
"duration": 2.31,
"setup": 1.16
}
},
{
"activeSince": "2022-07-09 00:00:00",
"destination": "Azerbaijan Mobile",
"destinationId": 28,
"international": {
"duration": 4.68,
"setup": 3.47
},
"national": {
"duration": 2.31,
"setup": 1.16
}
}
]
}Get the configuration of a subscription
List all properties that make up the subscription's configuration. Properties are made up of key / value pairs. Properties may be extended or reduced at will, knowing that a basic set of properties has to be present for application correct behaviour. For the basic set of properties that have to be set, please see this list. All property names containing password or token will be returned masked as ********.
Request
Endpoint
GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/configurations/general
Authorization
Required role
subscriptions.instance.configurations.general.list
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant |
id | integer | Index of an existing subscription |
URL/Query parameters
| Parameter | Type | Description | Required? |
|---|---|---|---|
keys | string | A comma seperated list of keys used to restrict the returned properties to the specified keys | no |
search | string | Used to perform a search through all searchable configurations keys of a subscription that look like the string passed | no |
Response
Status codes
| Parameter | Description |
|---|---|
200 | Properties list has been correctly returned |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | No subscription found |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
properties | dictionary | A dictionary returning the read properties as key / value pairs | no |
Example
{
"properties": {
"max_calls": 30
}
}Standard Properties
| Key | Type | Example |
|---|---|---|
| draas_example | string | Example value |
Create or modify properties in of a subscription
Use this endpoint to create or modify properties that make up the configuration of a subscription. This API is an upsert one, meaning that a non-existing property will be added and an existing one will be updated.
Request
Endpoint
POST /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/configurations/general
Authorization
Required role
subscriptions.instance.configurations.general.create
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant |
id | integer | Index of an existing subscription |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required? |
|---|---|---|---|
properties | dictionary | A dictionary defining properties as key / value pairs. Non-existing keys will be added to the configuration, existing ones will be updated with the new value | yes |
Example
{
"properties": {
"max_calls": 30
}
}Response
Status codes
| Parameter | Description |
|---|---|
204 | The properties were successfully added or modified to the group |
400 | Error while processing the properties for the group |
500 | Uncatched error on server side |
Success
Body
N/A
Modify the configurations of a subscription
Use this endpoint to modify the configurations of a subscription of the reference user's access level.
Request
Endpoint
PUT /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/configurations/general
Authorization
Required role
subscriptions.instance.configurations.general.update
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant |
id | integer | Index of an existing subscription |
URL/Query parameters
N/A
Body
A dictionary defining properties as key / value pairs.
Example
{
"properties": {
"max_calls": 25
}
}Response
Status codes
| Parameter | Description |
|---|---|
204 | The properties were successfully modified |
400 | Error while processing the properties |
500 | Uncatched error on server side |
Success
Body
N/A
Remove properties from a subscription
Use this endpoint to remove properties that make up the configuration of a subscription.
Request
Endpoint
DELETE /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/configurations/general
Authorization
Required role
subscriptions.instance.configurations.general.delete
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant |
id | integer | Index of an existing subscription |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required? |
|---|---|---|---|
keys | array | An array of keys to remove from the configuration | yes |
Example
{
"keys": [
"prop_1",
"prop_2",
"prop_x"
]
}Response
Status codes
| Parameter | Description |
|---|---|
204 | The properties were successfully removed the subscription |
400 | Error while processing the properties for the subscription |
500 | Uncatched error on server side |
Success
Body
N/A
Get the configurations branding general
List of the configurations branding general of the reference user's access level.
Request
Endpoint
GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/configurations/branding/general
Authorization
Required role
subscriptions.instance.configurations.branding.general.list
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant |
id | integer | Index of an existing subscription |
URL/Query parameters
| Parameter | Type | Description | Required? |
|---|---|---|---|
full | boolean | Forces to return the full configurations keys ignoring any other parameters | no |
keys | string | A comma seperated list of keys used to restrict the returned properties to the specified keys | no |
search | string | Used to perform a search through all searchable configurations keys of a tenant that look like the string passed | no |
Response
Status codes
| Parameter | Description |
|---|---|
200 | Properties has been correctly returned |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | No tenant found |
500 | Uncatched error on server side |
Success
Body
A dictionary defining properties as key / value pairs.
Example
{}Modify the configurations branding general
Use this endpoint to modify the configurations of branding general of the reference user's access level.
Request
Endpoint
PUT /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/configurations/general
Authorization
Required role
subscriptions.instance.configurations.branding.general.update
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant |
id | integer | Index of an existing subscription |
URL/Query parameters
N/A
Body
A dictionary defining properties as key / value pairs.
Example
{}Response
Status codes
| Parameter | Description |
|---|---|
204 | The properties were successfully modified |
400 | Error while processing the properties |
500 | Uncatched error on server side |
Success
Body
N/A
Get the configurations of branding pages
List of the configurations of branding pages of the reference user's access level.
Request
Endpoint
GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/configurations/branding/pages
Authorization
Required role
subscriptions.instance.configurations.branding.pages.list
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant |
id | integer | Index of an existing subscription |
URL/Query parameters
| Parameter | Type | Description | Required? |
|---|---|---|---|
full | boolean | Forces to return the full configurations keys ignoring any other parameters | no |
keys | string | A comma seperated list of keys used to restrict the returned properties to the specified keys | no |
search | string | Used to perform a search through all searchable configurations keys of a tenant that look like the string passed | no |
Response
Status codes
| Parameter | Description |
|---|---|
200 | Properties has been correctly returned |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | No tenant found |
500 | Uncatched error on server side |
Success
Body
A dictionary defining properties as key / value pairs.
Example
{
"subscription": {
"subscriptionNumbers": {
"tabs": {
"myNumbers": {
"enabled": true
},
"porting": {
"enabled": true
},
"releasedNumbers": {
"enabled": true
},
"reservedNumbers": {
"enabled": true
}
}
}
}
}Modify the configurations branding pages
Use this endpoint to modify the configurations of branding pages of the reference user's access level.
Request
Endpoint
PUT /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/configurations/pages
Authorization
Required role
subscriptions.instance.configurations.branding.pages.update
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant |
id | integer | Index of an existing subscription |
URL/Query parameters
N/A
Body
A dictionary defining properties as key / value pairs.
Example
{
"subscription": {
"subscriptionNumbers": {
"tabs": {
"myNumbers": {
"enabled": true
},
"porting": {
"enabled": true
},
"releasedNumbers": {
"enabled": true
},
"reservedNumbers": {
"enabled": true
}
}
}
}
}Response
Status codes
| Parameter | Description |
|---|---|
204 | The properties were successfully modified |
400 | Error while processing the properties |
500 | Uncatched error on server side |
Success
Body
N/A
Get the configurations of branding styling
List of the configurations of branding styling of the reference user's access level.
Request
Endpoint
GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/configurations/branding/styling
Authorization
Required role
subscriptions.instance.configurations.branding.pages.list
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant |
id | integer | Index of an existing subscription |
URL/Query parameters
| Parameter | Type | Description | Required? |
|---|---|---|---|
full | boolean | Forces to return the full configurations keys ignoring any other parameters | no |
keys | string | A comma seperated list of keys used to restrict the returned properties to the specified keys | no |
search | string | Used to perform a search through all searchable configurations keys of a tenant that look like the string passed | no |
type | string | The type of styling asset. Possible values are:
| yes |
Response
Status codes
| Parameter | Description |
|---|---|
200 | Properties has been correctly returned |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | No tenant found |
500 | Uncatched error on server side |
Success
Body
A dictionary defining properties as key / value pairs.
Example type=font
{
"allowed": [
"Avenir Next Cyr",
"Roboto",
"Ubuntu",
"Montserrat"
],
"name": "Avenir Next Cyr"
}Example type=image
{
"favicon": "/branding/default/favicon/favicon.ico",
"login": {
"bg": "/branding/default/img/Loginbackground.png",
"logo": "/branding/default/img/LoginLogo.svg"
},
"main": {
"bg": "/branding/default/img/MainBackground.png",
"logo": "/branding/default/img/Logo.svg"
}
}Example type=theme
{
"allowed": [
"blue",
"red",
"green"
],
"selected": "blue",
"themes": {
"blue": "/branding/default/theme.blue.json",
"green": "/branding/default/theme.green.json",
"red": "/branding/default/theme.red.json"
}
}Modify the configurations branding styling
Use this endpoint to modify the configurations of branding styling of the reference user's access level.
Request
Endpoint
PUT /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/configurations/pages
Authorization
Required role
subscriptions.instance.configurations.branding.pages.update
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the tenant |
id | integer | Index of an existing subscription |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required? |
|---|---|---|---|
type | string | The type of styling asset. Possible values are:
| yes |
And a dictionary defining properties as key / value pairs.
Example type=font
{
"type": "font",
"allowed": [
"Avenir Next Cyr",
"Roboto",
"Ubuntu",
"Montserrat"
],
"name": "Avenir Next Cyr"
}Example type=image
{
"type": "image",
"favicon": "/branding/default/favicon/favicon.ico",
"login": {
"bg": "/branding/default/img/Loginbackground.png",
"logo": "/branding/default/img/LoginLogo.svg"
},
"main": {
"bg": "/branding/default/img/MainBackground.png",
"logo": "/branding/default/img/Logo.svg"
}
}Example type=theme
{
"type": "theme",
"allowed": [
"blue",
"red",
"green"
],
"selected": "red",
"themes": {
"blue": "/branding/default/theme.blue.json",
"green": "/branding/default/theme.green.json",
"red": "/branding/default/theme.red.json"
}
}Response
Status codes
| Parameter | Description |
|---|---|
204 | The properties were successfully modified |
400 | Error while processing the properties |
500 | Uncatched error on server side |
Success
Body
N/A