Groups

A group refers to a top level company that sells the services offered by the Fusion platform. A group can only be administrated by a system administrator. A group is the top level container for distributors, resellers or tenants.

API Authorization

These APIs are only available for system administrators.

Get a list of groups

List all groups created on the platform.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/groups

Authorization

Required role

groups.list

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters

URL/Query parameters

Parameter	Type	Description	Required?
`search`	`string`	Used to perform a search through all searchable properties of a group that look like the string passed	no
`sort`	`string`	Allows to specify one searchable property of a group 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
`next`	`string`	A token used to get the next records in the list. This token is taken back from the results of the previous call	no

Response

Status codes

Parameter	Description
`200`	One or more groups found
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`404`	No group 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
`next`	`string`	A token used for infinite scrolling, to be used in the next call to retrieve subsequent records. Only present if the list of groups has to be continued	yes
`groups`	`array`	List containing all group objects in the system	no

Group Object

Parameter	Type	Description	Conditional?	Searchable?
`uuid`	`string`	Universal unique id uniquely identifying the group	no	yes
`name`	`string`	Name the group	no	yes
`draasDomain`	`string`	Global domain used by the group	yes	yes

Example

json

{
    "page": 1,
    "pages": 3,
    "results": 1,
    "next": "cGFnZV9zaXplPTEmcGFnZT0y",
    "groups": [
        {
            "draasDomain": "first.draas.domain",
            "name": "Group 1",
            "uuid": "aaf9dba1-9469-40fa-be50-22298d68010d"
        }
    ]
}

Get a specific group

The following endpoint gives the details of a single group.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/groups/{uuid}

Authorization

Required role

groups.instance.read

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated universal unique ID (UUID) identifying the group for which you want to get its details

URL/Query parameters

N/A

Response

Status codes

Parameter	Description
`200`	The group was found
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`404`	No group found with this uuid
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`uuid`	`string`	Universal unique id uniquely identifying the group	no
`name`	`string`	Name the group	no
`draasDomain`	`string`	Global domain used by the group	yes
`nbOfDisributors`	`integer`	Number of distributors linked to this group	no
`nbOfResellers`	`integer`	Number of resellers linked to this group	no
`nbOfTenants`	`integer`	Number of tenaants linked to this group	no

Example

json

{
    "draasDomain": "first.draas.domain",
    "name": "Group 1",
    "nbOfDistributors": 2,
    "nbOfResellers": 2,
    "nbOfTenants": 2,
    "uuid": "aaf9dba1-9469-40fa-be50-22298d68010d"
}

Create a new group

Use this endpoint to create a new group on the platform.

Request

Endpoint

POST /api/v01/draas/{draas_instance}/groups

Authorization

Required role

groups.create

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters

URL/Query parameters

N/A

Body

Parameter	Type	Description	Required?
`name`	`string`	Name the group	yes
`draasDomain`	`string`	Global domain used by the group	no
`adminEmail`	`string`	Email of an administrator for this group. If present, it will create an administrator as described by this API	no

Example

json

{
  "name": "CBUR Test POST",
  "draasDomain": "my.fusion.domain",
  "adminEmail": "john.doe@netaxis.be"
}

Response

Status codes

Parameter	Description
`200`	The group was created successfully
`400`	Error while creating the group
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`uuid`	`string`	Universal unique id uniquely identifying the group	no

Example

json

{
  "uuid": "e4630c48-46be-416b-b09f-5e2b3a598e0c"
}

Modify an existing group

Update the details of a given group

Request

Endpoint

PUT /api/v01/draas/{draas_instance}/groups/{uuid}

Authorization

Required role

groups.instance.update

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	System generated universal unique ID (UUID) identifying the group for which you want to get its details

URL/Query parameters

N/A

Body

Parameter	Type	Description	Required?
`name`	`string`	New name for the group	no
`draasDomain`	`string`	Global domain used by the group	no

Example

json

{
    "name": "Group 1",
    "draasDomain": "first.fusion.domain"
}

Response

Status codes

Parameter	Description
`200`	The group was updated successfully
`400`	Error while updating the group
`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?
`uuid`	`string`	Universal unique id uniquely identifying the group	no

Example

json

{
  "uuid": "e4630c48-46be-416b-b09f-5e2b3a598e0c"
}

Delete a group

Groups must be empty

It is not possible to delete groups that still have distributors, resellers or tenants attached.

Request

Endpoint

DELETE /api/v01/draas/{draas_instance}/groups/{uuid}

Authorization

Required role

groups.instance.delete

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	System generated universal unique ID (UUID) identifying the group which you would like to delete

URL/Query parameters

N/A

Body

N/A

Response

Status codes

Parameter	Description
`200`	The group was deleted successfully. If the group didn't exist, the delete will be considered as being executed successfully
`400`	Error while deleting the group
`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?
`uuid`	`string`	Universal unique id uniquely identifying the group that has been deleted	no

Example

json

{
  "uuid": "e4630c48-46be-416b-b09f-5e2b3a598e0c"
}

Create an administrator account for a group structure

Create an administrator account for an existing group. The account will be created using an e-mail as user reference. At successful creation, an e-mail will be sent to the newly created administrator address, asking her/him to follow a link to create a valid password and validate the account.

Request

Endpoint

POST /api/v01/draas/{draas_instance}/groups/{uuid}/admins

Authorization

Required role

groups.instance.admins.create

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated universal unique ID (UUID) identifying the group for which you want to create an administrator account

URL/Query parameters

N/A

Body

Parameter	Type	Description	Required?
`adminEmail`	`string`	A valid e-mail address owned by the administrator	yes
`firstName`	`string`	First name of the administrator	no
`lastName`	`string`	Last name of the administrator	no
`mobile`	`string`	Mobile phone number of the administrator	no

Example

json

{
  "adminEmail": "john.doe@netaxis.be",
  "firstName": "John",
  "lastName": "Doe",
  "mobile": "+33613575607"
}

Response

Status codes

Parameter	Description
`200`	The administrator account was successfully created
`400`	Error while creating the administrator account, the specified e-mail address already exists in the system
`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`	`number`	Internal ID of newly created administrator account	no

Example

json

{
  "id": 86
}

Modify an administrator account for a group structure

Modify an existing administrator account for a group. As the e-mail is the administrator reference, it cannot be modified. In case this is needed, administrator has to be deleted and re-created with the new e-mail reference.

Request

Endpoint

PUT /api/v01/draas/{draas_instance}/groups/{uuid}/admins/{username}

Authorization

Required role

groups.instance.admins.update

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated universal unique ID (UUID) identifying the group for which you want to create an administrator account
`username`	`string`	The username that identifies the administrator. This should be the administrator e-mail

URL/Query parameters

N/A

Body

Parameter	Type	Description	Required?
`firstName`	`string`	First name of the administrator	no
`lastName`	`string`	Last name of the administrator	no
`mobile`	`string`	Mobile phone number of the administrator	no
`adminEmail`	`string`	The email of the administrator	yes
`force_reset`	`boolean`	Forces the password reset	yes

Example

json

{
  "firstName": "John",
  "lastName": "Doe",
  "mobile": "+33613575607",
  "adminEmail": "john.doe@netaxis.be"
}

Response

Status codes

Parameter	Description
`200`	The administrator account was successfully modified
`400`	Error while modifying the administrator account
`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`	`number`	Internal ID of modified administrator account	no

Example

json

{
  "id": 86
}

Delete an administrator account for a group structure

Delete an existing administrator account from a group.

Request

Endpoint

DELETE /api/v01/draas/{draas_instance}/groups/{uuid}/admins/{username}

Authorization

Required role

groups.instance.admins.delete

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated universal unique ID (UUID) identifying the group for which you want to create an administrator account
`username`	`string`	The username that identifies the administrator. This should be the administrator e-mail

URL/Query parameters

N/A

Body

N/A

Response

Status codes

Parameter	Description
`204`	The administrator account was successfully deleted
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

N/A

Get a specific rateplan

This endpoint returns a specific rateplan for the group with all different prices that apply (setup + per minute) per destination. This API is mainly to be used by system administrators as a rateplan belongs to a group and at system level, we first have to choose the group for which we will get the list.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/groups/{uuid}/rate_plans/{rate_plan}

Authorization

Required role

groups.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 group for which you want to get the supported rate plans
`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

json

{
    "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 group

List all properties that make up the group'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}/groups/{uuid}/configurations/general

Authorization

Required role

groups.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 group for which you want to get the properties

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 group 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 group 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

json

{
    "properties": {
        "draas_default_mode": "Direct Routing",
        "draas_dummy_user_name": "Netaxis Dummy Fusion User for E5 Activation",
        "draas_group": "Copaco",
        "draas_main_domain": "teams.cloudnettest.services",
        "draas_oc_calling_profile_id": "b77db179-e055-481d-b11b-0902971d892d",
        "draas_oc_onboarding_confirmation_required": true,
        "draas_porting_cc": "+31",
        "draas_profile_distributor_admin": "draas_distributor_admin",
        "draas_profile_group_admin": "draas_group_admin",
        "draas_profile_reseller_admin": "draas_reseller_admin",
        "draas_profile_system_admin": "draas_system_admin",
        "draas_profile_tenant_admin": "draas_tenant_admin",
        "draas_pstn_usage": "PSTN-Usage-DRAAS",
        "draas_sbc_ip": "152.70.50.133",
        "draas_sbc_port": 5061,
        "draas_tgrp_name": "teams",
        "draas_trunk_context": "testteams.copaco.nl",
        "draas_voice_route": "VR-Fusion",
        "draas_vrp": "World-Fusion",
        "eva_combinations": "STANDARDPACK+MCOCAP,ENTERPRISEPACK+MCOCAP,ENTERPRISEPREMIUM,TEAMS_EXPLORATORY+MCOCAP"
    }
}

Standard Properties

Key	Type	Example
draas_azure_application_name	string	Netaxis Fusion Integration
draas_default_mode	string	direct_routing
draas_dummy_user_name	string	Netaxis Dummy Fusion User for E5 Activation
draas_external_trunkgroup_name	string	Xelion
draas_external_trunkgroup_uuid	string	Xelion02
draas_group	string	Copaco
draas_main_domain	string	teams.cloudnettest.services
draas_oc_calling_profile_id	string	b77db179-e055-481d-b11b-0902971d892d
draas_oc_onboarding_confirmation_required	boolean	true
draas_porting_cc	string	+31
draas_profile_distributor_admin	string	draas_distributor_admin
draas_profile_group_admin	string	draas_group_admin
draas_profile_reseller_admin	string	draas_reseller_admin
draas_profile_system_admin	string	draas_system_admin
draas_profile_tenant_admin	string	draas_tenant_admin
draas_pstn_usage	string	PSTN-Usage-DRAAS
draas_sbc_ip	string	152.70.50.133
draas_sbc_network_interface	string	s0p0:0.4
draas_sbc_parent_realm	string	SIPT-GENERAL
draas_sbc_port	number	5061
draas_tgrp_name	string	teams
draas_trunk_context	string	testteams.copaco.nl
draas_voice_route	string	VR-Fusion
draas_vrp	string	World-Fusion
eva_combinations	string	STANDARDPACK+MCOCAP, ENTERPRISEPACK+MCOCAP, ENTERPRISEPREMIUM
eva_licenses	string	STANDARDPACK, ENTERPRISEPACK, ENTERPRISEPREMIUM,MCOCAP

Create or modify properties in of a group

Use this endpoint to create or modify properties that make up the configuration of a group. 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}/groups/{uuid}/configurations/general

Authorization

Required role

groups.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 group for which you want to add or modify properties

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

json

{
    "properties": {
        "draas_group": "Arrow",
        "draas_default_mode": "Operator Connect",
        "prop_1": "A new property"
    }
}

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 group

Use this endpoint to modify the configurations of a group of the reference user's access level.

Request

Endpoint

PUT /api/v01/draas/{draas_instance}/groups/{uuid}/configurations/general

Authorization

Required role

groups.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 group for which you want to add or modify properties

URL/Query parameters

N/A

Body

A dictionary defining properties as key / value pairs.

Example

json

{
    "properties": {
        "draas_default_mode": "Direct Routing",
        "draas_dummy_user_name": "Netaxis Dummy Fusion User for E5 Activation",
        "draas_group": "Copaco",
        "draas_main_domain": "teams.cloudnettest.services",
        "draas_oc_calling_profile_id": "b77db179-e055-481d-b11b-0902971d892d",
        "draas_oc_onboarding_confirmation_required": true,
        "draas_porting_cc": "+31",
        "draas_profile_distributor_admin": "draas_distributor_admin",
        "draas_profile_group_admin": "draas_group_admin",
        "draas_profile_reseller_admin": "draas_reseller_admin",
        "draas_profile_system_admin": "draas_system_admin",
        "draas_profile_tenant_admin": "draas_tenant_admin",
        "draas_pstn_usage": "PSTN-Usage-DRAAS",
        "draas_sbc_ip": "152.70.50.133",
        "draas_sbc_port": 5061,
        "draas_tgrp_name": "teams",
        "draas_trunk_context": "testteams.copaco.nl",
        "draas_voice_route": "VR-Fusion",
        "draas_vrp": "World-Fusion",
        "eva_combinations": "STANDARDPACK+MCOCAP,ENTERPRISEPACK+MCOCAP,ENTERPRISEPREMIUM,TEAMS_EXPLORATORY+MCOCAP"
    }
}

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 group

Use this endpoint to remove properties that make up the configuration of a group.

Request

Endpoint

DELETE /api/v01/draas/{draas_instance}/groups/{uuid}/configurations/general

Authorization

Required role

groups.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 group from which you want to add remove properties

URL/Query parameters

N/A

Body

Parameter	Type	Description	Required?
`keys`	`array`	An array of keys to remove from the configuration	yes

Example

json

{
    "keys": [
        "prop_1",
        "prop_2",
        "prop_x"
    ]
}

Response

Status codes

Parameter	Description
`204`	The properties were successfully removed the group
`400`	Error while processing the properties for the group
`500`	Uncatched error on server side

Success

Body

N/A

Get the list of pstn usages

The following endpoint gives the list of existing pstn usages for a given group.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/groups/{uuid}/configurations/voice_routing/pstn_usages

Authorization

Required role

groups.instance.configurations.voice_routing.pstn_usages.list

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the group from which you want to add remove properties

URL/Query parameters

Parameter	Type	Description	Required?
`search`	`string`	Used to perform a search through all searchable properties that look like the string passed	no
`sort`	`string`	Allows to specify one searchable property of an order 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`	`integer`	Used for pagination, determines the current page to be shown (defaults to 1)	no
`page_size`	`integer`	Used for pagination, determines the maximum number of records on one page of results (defaults to 10)	no
`next`	`string`	A token used to get the next records in the list. This token is taken back from the results of the previous call	no

Response

Status codes

Parameter	Description
`200`	One or more pstn usages found
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`404`	No of the pstn usage found
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`pstnUsages`	`array`	List containing all pstn usage objects of the group	no
`results`	`string`	Total count of results that match your query	no
`pageSize`	`string`	Results are not provided all at once. This parameter indicates how many results are returned per page.	no
`pages`	`string`	Total count of result pages that are available	no
`page`	`string`	ID of the page that is currently returned	no
`next`	`string`	A token generated as long as there are still pages to display in the list. This token may be used in a subsequent call to get the next page. It contains all query parameter from the request so they may be omitted in subsequent call	yes

PSTN Usage Object

Parameter	Type	Description	Conditional?	Searchable?
`id`	`integer`	Index of the pstn usage	no	no
`name`	`string`	Name of the pstn usage	no	yes

Example

json

{
  "page": 1,
  "pageSize": 10,
  "pages": 1,
  "pstnUsages": [
    {
      "id": 21,
      "name": "PSTN Test name"
    },
    {
      "id": 8,
      "name": "PSTN-Usage-DRAAS"
    }
  ],
  "results": 2
}

Create a new pstn usage

Use this endpoint to create a new pstn usage for a group on the platform.

Request

Endpoint

POST /api/v01/draas/{draas_instance}/groups/{uuid}/configurations/voice_routing/pstn_usages

Authorization

Required role

groups.instance.configurations.voice_routing.pstn_usages.create

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the group

URL/Query parameters

N/A

Body

Parameter	Type	Description	Required
`name`	`string`	Name of the pstn usage	yes

Example

json

{
  "name": "Test PSTN 42"
}

Response

Status codes

Parameter	Description
`204`	The pstn usage was created successfully
`400`	Error while creating the pstn usage
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

N/A

Example

N/A

Modify an existing pstn usage

Use this endpoint to modify an existing pstn usage for a group on the platform.

Request

Endpoint

PUT /api/v01/draas/{draas_instance}/groups/{uuid}/configurations/voice_routing/pstn_usages/{id}

Authorization

Required role

groups.instance.configurations.voice_routing.pstn_usages.instance.update

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the group
`id`	`integer`	Index of an existing pstn usage

URL/Query parameters

N/A

Body

Parameter	Type	Description	Required
`name`	`string`	New name for the pstn usage	yes

Example

json

{
  "name": "Test PSTN 45"
}

Response

Status codes

Parameter	Description
`204`	The pstn usage was updated successfully
`400`	Error while updating the pstn usage
`403`	The API consumer doesn't have sufficient rights to perform this action
`404`	The pstn usage ID does not exist in the database
`500`	Uncatched error on server side

Success

Body

N/A

Example

N/A

Delete a pstn usage

Use this endpoint to delete an existing pstn usage for a group on the platform. A pstn usage can be deleted only if not connected to a voice routing or a voice routing policy.

Request

Endpoint

DELETE /api/v01/draas/{draas_instance}/groups/{uuid}/configurations/voice_routing/pstn_usages/{id}

Authorization

Required role

groups.instance.configurations.voice_routing.pstn_usages.instance.delete

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the group
`id`	`integer`	Index of an existing pstn usage

URL/Query parameters

N/A

Body

N/A

Response

Status codes

Parameter	Description
`204`	The pstn usage was deleted successfully. If the pstn usage didn't exist, the delete will be considered as being executed successfully.
`400`	Error while deleting the pstn usage
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

N/A

Example

N/A

Get the list of voice routes

The following endpoint gives the list of existing voice routes for a given group.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/groups/{uuid}/configurations/voice_routing/voice_routes

Authorization

Required role

groups.instance.configurations.voice_routing.voice_routes.list

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the group from which you want to add remove properties

URL/Query parameters

Parameter	Type	Description	Required?
`search`	`string`	Used to perform a search through all searchable properties that look like the string passed	no
`sort`	`string`	Allows to specify one searchable property of an order 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`	`integer`	Used for pagination, determines the current page to be shown (defaults to 1)	no
`page_size`	`integer`	Used for pagination, determines the maximum number of records on one page of results (defaults to 10)	no
`next`	`string`	A token used to get the next records in the list. This token is taken back from the results of the previous call	no

Response

Status codes

Parameter	Description
`200`	One or more voice routes found
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`404`	No of the voice route found
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`voiceRoutes`	`array`	List containing all voice route objects of the group	no
`results`	`string`	Total count of results that match your query	no
`pageSize`	`string`	Results are not provided all at once. This parameter indicates how many results are returned per page.	no
`pages`	`string`	Total count of result pages that are available	no
`page`	`string`	ID of the page that is currently returned	no
`next`	`string`	A token generated as long as there are still pages to display in the list. This token may be used in a subsequent call to get the next page. It contains all query parameter from the request so they may be omitted in subsequent call	yes

Voice Route Object

Parameter	Type	Description	Conditional?	Searchable?
`id`	`integer`	Index of the voice route	no	no
`name`	`string`	Name of the voice route	no	yes
`pattern`	`string`	Pattern	no	no
`priority`	`integer`	Priority	no	no
`pstnUsages`	`array`	Array of pstn usage objects connected connected to the voice route	no	no

Example

json

{
  "page": 1,
  "pageSize": 10,
  "pages": 1,
  "results": 2,
  "voiceRoutes": [
    {
      "id": 7,
      "name": "VR-DRaaS",
      "pattern": ".*",
      "priority": 1,
      "pstnUsages": []
    },
    {
      "id": 21,
      "name": "VR-DRaaS New",
      "pattern": ".*",
      "priority": 5,
      "pstnUsages": [
        {
          "id": 8,
          "name": "DRaaS-New-PSTN-Usage 3"
        },
        {
          "id": 21,
          "name": "PSTN Test name"
        }
      ]
    }
  ]
}

Create a new voice route

Use this endpoint to create a new voice route for a group on the platform.

Request

Endpoint

POST /api/v01/draas/{draas_instance}/groups/{uuid}/configurations/voice_routing/voice_routes

Authorization

Required role

groups.instance.configurations.voice_routing.voice_routes.create

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the group

URL/Query parameters

N/A

Body

Parameter	Type	Description	Required
`name`	`string`	Name of the voice route	yes
`pattern`	`string`	Pattern	yes
`priority`	`integer`	Priority	yes
`pstnUsages`	`array`	Array of PSTN Usages ids (as integer values) to be connected to the voice route	no

Example

json

{
  "name": "VR-DRaaS new",
  "priority": 5,
  "pattern": ".*",
  "pstnUsages": [
    8,
    21
  ]
}

Response

Status codes

Parameter	Description
`204`	The voice route was created successfully
`400`	Error while creating the voice route
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

N/A

Example

N/A

Modify an existing voice route

Use this endpoint to modify an existing voice route for a group on the platform.

Request

Endpoint

PUT /api/v01/draas/{draas_instance}/groups/{uuid}/configurations/voice_routing/voice_routes/{id}

Authorization

Required role

groups.instance.configurations.voice_routing.voice_routes.instance.update

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the group
`id`	`integer`	Index of an existing voice route

URL/Query parameters

N/A

Body

Parameter	Type	Description	Required
`name`	`string`	Name of the voice route	no
`pattern`	`string`	Pattern	no
`priority`	`integer`	Priority	no
`pstnUsages`	`array`	Array of PSTN Usages ids (as integer values) to be connected to the voice route. The missing entries will be disconnected.	no

Example

json

{
  "name": "VR-DRaaS modified",
  "pstnUsages": [
    21
  ]
}

Response

Status codes

Parameter	Description
`204`	The voice route was updated successfully
`400`	Error while updating the voice route
`403`	The API consumer doesn't have sufficient rights to perform this action
`404`	The voice route ID does not exist in the database
`500`	Uncatched error on server side

Success

Body

N/A

Example

N/A

Delete a voice route

Use this endpoint to delete an existing voice route for a group on the platform. A voice route can be deleted only if not connected to a voice routing or a voice routing policy.

Request

Endpoint

DELETE /api/v01/draas/{draas_instance}/groups/{uuid}/configurations/voice_routing/voice_routes/{id}

Authorization

Required role

groups.instance.configurations.voice_routing.voice_routes.instance.delete

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the group
`id`	`integer`	Index of an existing voice route

URL/Query parameters

N/A

Body

N/A

Response

Status codes

Parameter	Description
`204`	The voice route was deleted successfully. If the voice route didn't exist, the delete will be considered as being executed successfully.
`400`	Error while deleting the voice route
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

N/A

Example

N/A

Get the list of voice routing policies

The following endpoint gives the list of existing voice routing policies for a given group.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/groups/{uuid}/configurations/voice_routing/voice_routing_policies

Authorization

Required role

groups.instance.configurations.voice_routing.voice_routing_policies.list

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the group from which you want to add remove properties

URL/Query parameters

Parameter	Type	Description	Required?
`search`	`string`	Used to perform a search through all searchable properties that look like the string passed	no
`sort`	`string`	Allows to specify one searchable property of an order 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`	`integer`	Used for pagination, determines the current page to be shown (defaults to 1)	no
`page_size`	`integer`	Used for pagination, determines the maximum number of records on one page of results (defaults to 10)	no
`next`	`string`	A token used to get the next records in the list. This token is taken back from the results of the previous call	no

Response

Status codes

Parameter	Description
`200`	One or more voice routing policies found
`400`	Error while processing the request
`403`	The API consumer doesn't have sufficient rights to perform this action
`404`	No of the voice routing policies found
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`voiceRoutingPolicies`	`array`	List containing all voice routing policy objects of the group	no
`results`	`string`	Total count of results that match your query	no
`pageSize`	`string`	Results are not provided all at once. This parameter indicates how many results are returned per page.	no
`pages`	`string`	Total count of result pages that are available	no
`page`	`string`	ID of the page that is currently returned	no
`next`	`string`	A token generated as long as there are still pages to display in the list. This token may be used in a subsequent call to get the next page. It contains all query parameter from the request so they may be omitted in subsequent call	yes

Voice Routing Policy Object

Parameter	Type	Description	Conditional?	Searchable?
`id`	`integer`	Index of the voice routing policy	no	no
`name`	`string`	Name of the voice routing policy	no	yes
`pstnUsages`	`array`	Array of pstn usage objects connected to the voice routing policy	no	no

Example

json

{
  "page": 1,
  "pageSize": 10,
  "pages": 1,
  "results": 1,
  "voiceRoutingPolicies": [
    {
      "id": 7,
      "name": "World-DRaaS",
      "pstnUsages": [
        {
          "id": 8,
          "name": "DRaaS-New-PSTN-Usage 3"
        },
        {
          "id": 21,
          "name": "PSTN Test name"
        }
      ]
    }
  ]
}

Create a new voice routing policy

Use this endpoint to create a new voice routing policy for a group on the platform.

Request

Endpoint

POST /api/v01/draas/{draas_instance}/groups/{uuid}/configurations/voice_routing/voice_routing_policies

Authorization

Required role

groups.instance.configurations.voice_routing.voice_routing_policies.create

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the group

URL/Query parameters

N/A

Body

Parameter	Type	Description	Required
`name`	`string`	Name of the voice routing policy	yes
`pstnUsages`	`array`	Array of PSTN Usages ids (as integer values) to be connected to the voice routing policy	no

Example

json

{
  "name": "VR-DRaaS new",
  "pstnUsages": [
    8,
    21
  ]
}

Response

Status codes

Parameter	Description
`204`	The voice route was created successfully
`400`	Error while creating the voice route
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

N/A

Example

N/A

Modify an existing voice routing policy

Use this endpoint to modify an existing voice routing policy for a group on the platform.

Request

Endpoint

PUT /api/v01/draas/{draas_instance}/groups/{uuid}/configurations/voice_routing/voice_routing_policies/{id}

Authorization

Required role

groups.instance.configurations.voice_routing.voice_routing_policies.instance.update

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the group
`id`	`integer`	Index of an existing voice routing policy

URL/Query parameters

N/A

Body

Parameter	Type	Description	Required
`name`	`string`	Name of the voice route	no
`pstnUsages`	`array`	Array of PSTN Usages ids (as integer values) to be connected to the voice routing policy. The missing entries will be disconnected.	no

Example

json

{
  "name": "VR-DRaaS modified",
  "pstnUsages": [
    21
  ]
}

Response

Status codes

Parameter	Description
`204`	The voice routing policy was updated successfully
`400`	Error while updating the voice routing policy
`403`	The API consumer doesn't have sufficient rights to perform this action
`404`	The voice routing policy ID does not exist in the database
`500`	Uncatched error on server side

Success

Body

N/A

Example

N/A

Delete a voice routing policy

Use this endpoint to delete an existing voice route for a group on the platform. A voice route can be deleted only if not connected to a voice routing or a voice routing policy.

Request

Endpoint

DELETE /api/v01/draas/{draas_instance}/groups/{uuid}/configurations/voice_routing/voice_routing_policies/{id}

Authorization

Required role

groups.instance.configurations.voice_routing.voice_routing_policies.instance.delete

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the group
`id`	`integer`	Index of an existing voice routing policy

URL/Query parameters

N/A

Body

N/A

Response

Status codes

Parameter	Description
`204`	The voice routing policy was deleted successfully. If the voice route didn't exist, the delete will be considered as being executed successfully.
`400`	Error while deleting the voice routing policy
`403`	The API consumer doesn't have sufficient rights to perform this action
`500`	Uncatched error on server side

Success

Body

N/A

Example

N/A

Send a welcome email to a group admin

Use this endpoint to send a welcome email to a group admin.

Request

Endpoint

POST /api/v01/draas/{draas_instance}/groups/{uuid}/admins/welcome

Authorization

Required role

groups.instance.admins.welcome.create

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the group

URL/Query parameters

N/A

Body

Parameter	Type	Description	Required?
`adminEmail`	`string`	Email of an administrator for this group	yes

Example

json

{
  "adminEmail": "john.doe@netaxis.be"
}

Response

Status codes

Parameter	Description
`200`	The welcome email has been sent successfully
`400`	Error while sending the welcome email
`500`	Uncatched error on server side

Success

Body

N/A

Example

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}/groups/{uuid}/configurations/branding/general

Authorization

Required role

groups.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 group for which you want to get the properties

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 group 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 group found
`500`	Uncatched error on server side

Success

Body

A dictionary defining properties as key / value pairs.

Example

json

{
    "apiVersion": "api/v01",
    "appTitle": "Fusion",
    "authentication": {
        "customLogOut": {
            "enabled": false,
            "route": "/forgot-password"
        },
        "emailID": "en",
        "keepUserLoggedIn": true
    },
    "backendUrl": "https://apio-dev.fusion.netaxis.cloud",
    "customTranslations": false,
    "draasInstance": "draas/draas_fusion_dev",
    "guideLink": "https://fusion.docs.netaxis.solutions/guides/onboarding/",
    "languages": [
        "en",
        "de",
        "fr"
    ],
    "modes": {
        "admin": {
            "sso": [
                {
                    "enabled": true,
                    "icon": "/branding/default/img/GoogleLogo.svg",
                    "mode": "oidc",
                    "name": "Google",
                    "state": "https://portal-dev.fusion.netaxis.cloud/login"
                },
                {
                    "enabled": true,
                    "icon": "/branding/default/img/Office365Logo.svg",
                    "mode": "oidc",
                    "name": "Office 365",
                    "state": "https://portal-dev.fusion.netaxis.cloud/login"
                },
                {
                    "enabled": false,
                    "icon": "/branding/default/img/ExponentialELogo.svg",
                    "mode": "oidc",
                    "name": "Exponential-e",
                    "state": "https://portal-dev.fusion.netaxis.cloud/login"
                }
            ]
        }
    },
    "msTeamInterval": 15000,
    "name": "DRaaS"
}

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}/groups/{uuid}/configurations/general

Authorization

Required role

groups.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 group for which you want to add or modify properties

URL/Query parameters

N/A

Body

A dictionary defining properties as key / value pairs.

Example

json

{
    "apiVersion": "api/v01",
    "appTitle": "Fusion",
    "authentication": {
        "customLogOut": {
            "enabled": false,
            "route": "/forgot-password"
        },
        "emailID": "en",
        "keepUserLoggedIn": true
    },
    "backendUrl": "https://apio-dev.fusion.netaxis.cloud",
    "customTranslations": false,
    "draasInstance": "draas/draas_fusion_dev",
    "guideLink": "https://fusion.docs.netaxis.solutions/guides/onboarding/",
    "languages": [
        "en",
        "de",
        "fr"
    ],
    "modes": {
        "admin": {
            "sso": [
                {
                    "enabled": true,
                    "icon": "/branding/default/img/GoogleLogo.svg",
                    "mode": "oidc",
                    "name": "Google",
                    "state": "https://portal-dev.fusion.netaxis.cloud/login"
                },
                {
                    "enabled": true,
                    "icon": "/branding/default/img/Office365Logo.svg",
                    "mode": "oidc",
                    "name": "Office 365",
                    "state": "https://portal-dev.fusion.netaxis.cloud/login"
                },
                {
                    "enabled": false,
                    "icon": "/branding/default/img/ExponentialELogo.svg",
                    "mode": "oidc",
                    "name": "Exponential-e",
                    "state": "https://portal-dev.fusion.netaxis.cloud/login"
                }
            ]
        }
    },
    "msTeamInterval": 15000,
    "name": "DRaaS"
}

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}/groups/{uuid}/configurations/branding/pages

Authorization

Required role

groups.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 group for which you want to get the properties

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 group 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 group found
`500`	Uncatched error on server side

Success

Body

A dictionary defining properties as key / value pairs.

Example

json

{
    "distributor": {
        "distributorAdmins": {
            "enabled": true
        },
        "distributorLicenseConsumption": {
            "enabled": false
        },
        "distributorProfile": {
            "enabled": false
        },
        "distributorRatePlan": {
            "enabled": true
        },
        "distributorResellers": {
            "enabled": true
        },
        "distributorTenants": {
            "enabled": true
        }
    },
    "group": {
        "groupAdmins": {
            "enabled": true
        },
        "groupDistributors": {
            "enabled": true
        },
        "groupOrders": {
            "enabled": true
        },
        "groupProducts": {
            "enabled": true
        },
        "groupRatePlan": {
            "enabled": true
        },
        "groupResellers": {
            "enabled": true
        },
        "groupSettings": {
            "enabled": true
        },
        "groupTenants": {
            "enabled": true
        }
    },
    "groupSettings": {
        "groupSettingsConfiguration": {
            "enabled": true
        },
        "groupSettingsVoiceRouting": {
            "enabled": true
        }
    },
    "reseller": {
        "resellerAdmins": {
            "enabled": true
        },
        "resellerLicenseConsumption": {
            "enabled": false
        },
        "resellerProfile": {
            "enabled": false
        },
        "resellerRatePlan": {
            "enabled": true
        },
        "resellerTenants": {
            "enabled": true
        }
    },
    "subscription": {
        "subscriptionNumbers": {
            "tabs": {
                "myNumbers": {
                    "enabled": true
                },
                "porting": {
                    "enabled": true
                },
                "releasedNumbers": {
                    "enabled": true
                },
                "reservedNumbers": {
                    "enabled": true
                }
            }
        }
    },
    "system": {
        "systemGroupSettings": {
            "enabled": true
        },
        "systemGroups": {
            "enabled": true
        }
    },
    "tenant": {
        "tenantAdmins": {
            "enabled": true
        },
        "tenantOrders": {
            "enabled": true
        },
        "tenantProfile": {
            "enabled": true
        },
        "tenantRatePlan": {
            "enabled": true
        },
        "tenantSubscriptions": {
            "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}/groups/{uuid}/configurations/pages

Authorization

Required role

groups.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 group for which you want to add or modify properties

URL/Query parameters

N/A

Body

A dictionary defining properties as key / value pairs.

Example

json

{
    "distributor": {
        "distributorAdmins": {
            "enabled": true
        },
        "distributorLicenseConsumption": {
            "enabled": false
        },
        "distributorProfile": {
            "enabled": false
        },
        "distributorRatePlan": {
            "enabled": true
        },
        "distributorResellers": {
            "enabled": true
        },
        "distributorTenants": {
            "enabled": true
        }
    },
    "group": {
        "groupAdmins": {
            "enabled": true
        },
        "groupDistributors": {
            "enabled": true
        },
        "groupOrders": {
            "enabled": true
        },
        "groupProducts": {
            "enabled": true
        },
        "groupRatePlan": {
            "enabled": true
        },
        "groupResellers": {
            "enabled": true
        },
        "groupSettings": {
            "enabled": true
        },
        "groupTenants": {
            "enabled": true
        }
    },
    "groupSettings": {
        "groupSettingsConfiguration": {
            "enabled": true
        },
        "groupSettingsVoiceRouting": {
            "enabled": true
        }
    },
    "reseller": {
        "resellerAdmins": {
            "enabled": true
        },
        "resellerLicenseConsumption": {
            "enabled": false
        },
        "resellerProfile": {
            "enabled": false
        },
        "resellerRatePlan": {
            "enabled": true
        },
        "resellerTenants": {
            "enabled": true
        }
    },
    "subscription": {
        "subscriptionNumbers": {
            "tabs": {
                "myNumbers": {
                    "enabled": true
                },
                "porting": {
                    "enabled": true
                },
                "releasedNumbers": {
                    "enabled": true
                },
                "reservedNumbers": {
                    "enabled": true
                }
            }
        }
    },
    "system": {
        "systemGroupSettings": {
            "enabled": true
        },
        "systemGroups": {
            "enabled": true
        }
    },
    "tenant": {
        "tenantAdmins": {
            "enabled": true
        },
        "tenantOrders": {
            "enabled": true
        },
        "tenantProfile": {
            "enabled": true
        },
        "tenantRatePlan": {
            "enabled": true
        },
        "tenantSubscriptions": {
            "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}/groups/{uuid}/configurations/branding/styling

Authorization

Required role

groups.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 group for which you want to get the properties

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 group that look like the string passed	no
`type`	`string`	The type of styling asset. Possible values are: `font`, `image`, `theme`.	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 group found
`500`	Uncatched error on server side

Success

Body

A dictionary defining properties as key / value pairs.

Example `type=font`

json

{
    "allowed": [
        "Avenir Next Cyr",
        "Roboto",
        "Ubuntu",
        "Montserrat"
    ],
    "name": "Avenir Next Cyr"
}

Example `type=image`

json

{
    "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`

json

{
    "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}/groups/{uuid}/configurations/pages

Authorization

Required role

groups.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 group for which you want to add or modify properties

URL/Query parameters

N/A

Body

Parameter	Type	Description	Required?
`type`	`string`	The type of styling asset. Possible values are: `font`, `image`, `theme`.	yes

And a dictionary defining properties as key / value pairs.

Example `type=font`

json

{
    "type": "font",
    "allowed": [
        "Avenir Next Cyr",
        "Roboto",
        "Ubuntu",
        "Montserrat"
    ],
    "name": "Avenir Next Cyr"
}

Example `type=image`

json

{
    "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`

json

{
    "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

Get the enabled UCs of a group

List the enabled UCs of a group.

Request

Endpoint

GET /api/v01/draas/{draas_instance}/groups/{uuid}/enabled_ucs

Authorization

Required role

groups.instance.enabled_ucs.list

Path Parameters

Parameter	Type	Description
`draas_instance`	`string`	See common parameters
`uuid`	`string`	A system generated unique ID (UUID) identifying the group for which you want to get the properties

URL/Query parameters

N/A

Response

Status codes

Parameter	Description
`200`	Enabled UCs 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 group found
`500`	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
`enabled_ucs`	`array`	A list containing all the enabled UCs of a group.	no

Example

json

{
    "enabled_ucs": [
        "msteams"
        "zoom",
    ]
}

Groups ​

Get a list of groups ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

URL/Query parameters ​

Response ​

Status codes ​

Success ​

Body ​

Group Object ​

Example ​

Get a specific group ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

URL/Query parameters ​

Response ​

Status codes ​

Success ​

Body ​

Example ​

Create a new group ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

URL/Query parameters ​

Body ​

Example ​

Response ​

Status codes ​

Success ​

Body ​

Example ​

Modify an existing group ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

URL/Query parameters ​

Body ​

Example ​

Response ​

Status codes ​

Success ​

Body ​

Example ​

Delete a group ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

URL/Query parameters ​

Body ​

Response ​

Status codes ​

Success ​

Body ​

Example ​

Create an administrator account for a group structure ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

URL/Query parameters ​

Body ​

Example ​

Response ​

Status codes ​

Success ​

Body ​

Example ​

Modify an administrator account for a group structure ​

Request ​

Endpoint ​

Authorization ​

Path Parameters ​

Groups

Get a list of groups

Request

Endpoint

Authorization

Path Parameters

URL/Query parameters

Response

Status codes

Success

Body

Group Object

Example

Get a specific group

Request

Endpoint

Authorization

Path Parameters

URL/Query parameters

Response

Status codes

Success

Body

Example

Create a new group

Request

Endpoint

Authorization

Path Parameters

URL/Query parameters

Body

Example

Response

Status codes

Success

Body

Example

Modify an existing group

Request

Endpoint

Authorization

Path Parameters

URL/Query parameters

Body

Example

Response

Status codes

Success

Body

Example

Delete a group

Request

Endpoint

Authorization

Path Parameters

URL/Query parameters

Body

Response

Status codes

Success

Body

Example

Create an administrator account for a group structure

Request

Endpoint

Authorization

Path Parameters

URL/Query parameters

Body

Example

Response

Status codes

Success

Body

Example

Modify an administrator account for a group structure

Request

Endpoint

Authorization

Path Parameters