Table of Contents | ||||||
---|---|---|---|---|---|---|
|
...
Endpoints and methods | Description | ||||||
---|---|---|---|---|---|---|---|
/domain see below | Get a list of all the domains in a multitenant structure. | ||||||
/domain/{domainName} see below | Get basic information about a given domain in a multitenant structure. | ||||||
/domain/{domainName}/retention see below | Get the price plan retention values of the given multitenant domain. | ||||||
/domain/{domainName}/roles see below | Get details of all the roles in the given domain. | ||||||
/domain/{domainName}/roles/{roleName} see below | Get details of a specific role in a given domain. | ||||||
/domain/{domainName}/policies see below | Get the list of role policies available in a given domain. | ||||||
/domain/{domainName}/applications see below | Get the list of applications available in a given domain. | ||||||
/domain/{domainName}/resources see below | Get the list of role resources available in a given domain. | ||||||
/domain/{domainName}/roles/vaults see below | Get the list of role vaults available in a given domain. | ||||||
/domain/{domainName}/preferences see below | Retrieve the subset of preferences of the given domain. | ||||||
/domain/{domainName}/preferences/limits see below | Retrieve the limits in the preferences of the given domain. | ||||||
/domain/{domainName}/visibility see below | Returns a list of all the domains from which a root domain can access data in a multitenant structure. | ||||||
/domain/{domainName}/auth see below | Returns the configuration info of a multitenant domain. | ||||||
/domain/{domainName}/keys see below | Returns a list of all the API keys associated with to the given domain. | ||||||
/domain/{domainName}/keys/{key} see below | Returns info of a specific API key. | ||||||
/domain see below | Create a new domain in a multitenant structure. | ||||||
/domain/{domainName}/disable see below | Disable a multitenant domain. | ||||||
/domain/{domainName}/enable see below | Enable a multitenant domain. | ||||||
/domain/{domainName}/roles see below | Create a new role in a given domain. | ||||||
/domain/{domainName}/keys see below | Generate a new API key/secret pair in the domain. | ||||||
/domain/{domainName}/plan see below | Change the current plan of a multitenant domain. | ||||||
/domain/{domainName}/retention see below | Update the given domain plan retention configuration. | ||||||
/domain/{domainName}/roles see below | Update a role in a given domain. | ||||||
/domain/{domainName}/roles/{roleName} see below | Update a role. | ||||||
/domain/{domainName}/preferences see below | Update the subset of preferences of a given domain. | ||||||
/domain/{domainName}/preferences/limits see below | Update the limits in the preferences of a given domain. | ||||||
/domain/{domainName}/certificates/download see below | Download a certificate. | ||||||
/domain/{domainName}/auth see below | Update the configuration of a multitenant domain. | ||||||
/domain/{domainName} see below | Delete a domain. | ||||||
/domain/{domainName}/roles/{roleName} see below | Delete a role in a given domain. | ||||||
/domain/{domainName}/keys/{key} see below | Delete a specific API key. |
Endpoints and methods
Anchor | ||||
---|---|---|---|---|
|
/domain
Get a list of all the domains in a multitenant structure. By default, only active domains are retrieved.
...
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}
Get basic information about a given domain in a multitenant structure.
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/retention
...
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/roles
...
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/roles/{roleName}
...
Expand | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Query string parametersQuery string parameters are optionally added after the path parameters, preceded by a question mark (
Find below a request example:
|
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/policies
...
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/applications
...
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/resources
...
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/roles/vaults
...
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/preferences
...
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/preferences/limits
...
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/visibility
...
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/auth
...
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/keys
Returns a list of all the API keys associated with to the given multitenant domain.
...
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/keys/{key}
...
Expand | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
/domain
Create a new domain in a multitenant structure.
Expand | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Request bodyThe request JSON body must include the
Find below a request example:
And this is an example of a request body, including the required JSON object:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/disable
...
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/enable
...
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/roles
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Request bodyThe request JSON body must include the
Currently, these parameters cannot be changed through the API but can be requested:
Find below a request example:
And this is an example of a request body, including the required JSON object:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/keys
...
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/plan
...
Expand | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Query string parametersQuery string parameters are added after the path parameters, preceded by a question mark (
Find below a request example:
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/retention
...
Expand | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Request bodyThe request JSON body must include the
Find below a request example:
And this is an example of a request body, including the required JSON object:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/roles
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Request bodyThe request JSON body must include the
Currently, these parameters cannot be changed through the API but can be requested:
Find below a request example:
And this is an example of a request body, including the required JSON object:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/roles/{roleName}
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Request bodyThe request JSON body must include the
Currently, these parameters cannot be changed through the API but can be requested:
Find below a request example:
And this is an example of a request body, including the required JSON object:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/preferences
...
Expand | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Request bodyThe request JSON body must include the
Find below a request example:
And this is an example of a request body, including the required JSON object:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/preferences/limits
...
Expand | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Request bodyThe request JSON body must include the
Find below a request example:
And this is an example of a request body, including the required JSON object:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/certificates/download
...
Expand | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Query string parametersQuery string parameters are added after the path parameters, preceded by a question mark (
Depending on the parameters given, the behavior will be different:
Find below a request example:
|
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/auth
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Request bodyThe request JSON body must include the SAML
OpenID
Password
Find below a request example:
And these are examples of the required JSON bodies: SAML
OpenID
Password
|
Anchor | ||||
---|---|---|---|---|
|
/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.
...
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
...
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/roles/{roleName}
...
Expand | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
Anchor | ||||
---|---|---|---|---|
|
/domain/{domainName}/keys/{key}
...
Expand | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
Find below a request example:
|
...