Document toolboxDocument toolbox

Domain operations

Owned by Juan Tomás Alonso Nieto (Deactivated)
May 08, 2023
24 min read
[ 1 Overview ] [ 2 Endpoints and methods ]

Overview

Check the list of available endpoints and methods to modify and update domains (both common and multitenant domains) using the Provisioning API:

Endpoints and methods

Description

Endpoints and methods

Description

GET /domain see below

Get a list of all the domains in a multitenant structure.

GET /domain/{domainName} see below

Get basic information about a given domain in a multitenant structure.

GET /domain/{domainName}/retention see below

Get the price plan retention values of the given multitenant domain.

GET /domain/{domainName}/roles see below

Get details of all the roles in the given domain.

GET /domain/{domainName}/roles/{roleName} see below

Get details of a specific role in a given domain.

GET /domain/{domainName}/policies see below

Get the list of role policies available in a given domain.

GET /domain/{domainName}/applications see below

Get the list of applications available in a given domain.

GET /domain/{domainName}/resources see below

Get the list of role resources available in a given domain.

GET /domain/{domainName}/roles/vaults see below

Get the list of role vaults available in a given domain.

GET /domain/{domainName}/preferences see below

Retrieve the subset of preferences of the given domain.

GET /domain/{domainName}/preferences/limits see below

Retrieve the limits in the preferences of the given domain.

POST /domain see below

Create a new domain in a multitenant structure.

POST /domain/{domainName}/disable see below

Disable a multitenant domain.

POST /domain/{domainName}/enable see below

Enable a multitenant domain.

POST /domain/{domainName}/roles see below

Create a new role in a given domain.

PUT /domain/{domainName}/plan see below

Change the current plan of a multitenant domain.

PUT /domain/{domainName}/retention see below

Update the given domain plan retention configuration.

PUT /domain/{domainName}/roles see below

Update a role in a given domain.

PUT /domain/{domainName}/roles/{roleName} see below

Update a role.

PUT /domain/{domainName}/preferences see below

Update the subset of preferences of a given domain.

PUT /domain/{domainName}/preferences/limits see below

Update the limits in the preferences of a given domain.

PUT /domain/{domainName}/certificates/download see below

Download a certificate.

DELETe /domain/{domainName} see below

Delete a domain.

DELETe /domain/{domainName}/roles/{roleName} see below

Delete a role in a given domain.

Endpoints and methods

GET /domain

Get a list of all the domains in a multitenant structure. By default, only active domains are retrieved.

Query string parameters

Query string parameters are optionally added after the path parameters, preceded by a question mark (?) and separated by an ampersand (&)

Parameter

Type

Description

Parameter

Type

Description

all

boolean

Set this parameter to true if you want to get all the domains, including disabled ones. The default value is false.

Find below a request example:

https://api-us.devo.com/probio/domain

Code

Description and sample body

Code

Description and sample body

200

Successful response. List of domains retrieved.

[ { "name": "domain_1@demo", "plan": "default", "time": 36.0, "volume": 10.0, "status": "Active" }, { "name": "domain_"@demo", "plan": "default", "time": 60.0, "volume": 1.3, "status": "Active" } ]

400

Bad request.

{ "code": { "10": "Invalid signature" }, "message": "string" }

GET /domain/{domainName}

Get basic information about a given domain in a multitenant structure.

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Description

Parameter

Type

Description

domainName required

string

Enter the name of the required domain. Using the format {domainName}@{resellerName} is optional.

Find below a request example:

Code

Description and sample body

Code

Description and sample body

200

Successful response. Domain details retrieved.

400

Bad request.

GET /domain/{domainName}/retention

Get the price plan retention values of the given multitenant domain.

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Description

Parameter

Type

Description

domainName required

string

Enter the name of the required domain. You must enter the full domain name using the format {domainName}@{resellerName}

Find below a request example:

GET /domain/{domainName}/roles

Get details of all the roles in the given domain, including the default ones.

GET /domain/{domainName}/roles/{roleName}

Get details of a specific role in a given domain, either a default or a custom role.

GET /domain/{domainName}/policies

Get the list of role policies (or permissions) available in a given domain.

GET /domain/{domainName}/applications

Get the list of applications available in a given domain.

GET /domain/{domainName}/resources

Get the list of role resources available in a given domain. Resources refer to lookups and activeboards created in the domain.

GET /domain/{domainName}/roles/vaults

Get the list of role vaults available in a given domain.

GET /domain/{domainName}/preferences

Retrieves the subset of preferences of the given domain.

GET /domain/{domainName}/preferences/limits

Retrieve the limits in the preferences of the given domain.

POST /domain

Create a new domain in a multitenant structure.

POST /domain/{domainName}/disable

Disable a multitenant domain.

POST /domain/{domainName}/enable

Enable a multitenant domain.

Domains with the status pending cannot be activated. Also, when you try to disable or enable an already disabled or enabled domain, you will get an error response.

POST /domain/{domainName}/roles

Create a new role in a given domain.

PUT /domain/{domainName}/plan

Change the current plan of a multitenant domain. The new plan must be valid for the multitenant structure and different from the current one.

PUT /domain/{domainName}/retention

Update the price plan configuration (retention & volume) of a given domain. Partial updates are permitted.

PUT /domain/{domainName}/roles

Updates a domain custom role in a given domain.

PUT /domain/{domainName}/roles/{roleName}

Updates a domain custom role.

PUT /domain/{domainName}/preferences

Update the subset of preferences of a given domain.

PUT /domain/{domainName}/preferences/limits

Update the limits in the preferences of a given domain.

PUT /domain/{domainName}/certificates/download

Download the certificates of a given domain.

DELETE /domain/{domainName}

Delete a multitenant domain. This will additionally delete all user domains belonging to the multitenant domain. Any user that ends up without at least one user domain will be deleted as well.

DELETE /domain/{domainName}/roles/{roleName}

Delete a role in a given domain. Note that a role cannot be deleted while it is assigned to a user.

Â