Tenant API
Version: 6.0.2
API Endpoints
| Request | Summary |
|---|---|
| GET /v1/tenants/servicesSummary | Returns the Service summary. |
| GET /v1/tenants/servicesSummaryFile | Returns the Service summary file. |
| POST /v1/tenants | Create a Tenant. |
| DELETE /v1/tenants/{id} | Delete the Tenant |
| GET /v1/tenants/usageReport | Returns the Tenant usage report file. |
| GET /v1/tenants/{id}/admin | Returns details for the identified Tenant's Primary Administrator. |
| GET /v1/tenants/{id}/children | Returns a list of the identified Parent Tenant's existing Child Tenant IDs. |
| GET /v1/tenants/{id}/hostname | Returns hostname of the requested Tenant ID. |
| GET /v1/tenants/logo | Returns logo image for the targeted host. |
| GET /v1/tenants/{id}/logo | Returns the logo image for the targeted Tenant. |
| GET /v1/tenants/{id}/quotas | Returns the quota information for the requested Tenant ID. |
| GET /v1/tenants/{id} | Returns details for the specified Tenant. |
| GET /v1/tenants/hierarchy | Returns a tree representation of the Tenant hierarchy. |
| GET /v1/tenants/settings | Returns Tenant settings. |
| GET /v1/tenants/usageDetails | Returns the usage details for all the Tenants. |
| GET /v1/tenants | Returns a list of Tenants. |
| PUT /v1/tenants/{id}/logo | Set logo image for the targeted Tenant. |
| PATCH /v1/tenants/{id} | Update an existing Tenant. |
| PATCH /v1/tenants/settings | Update Tenant settings. |
Authorization
OAuth2
For more information about authorization see Getting Started Using the DPoD API.
- Type: OAuth
- Scopes:
- dpod.tenant.spadmin: Service Provider Administrator user role. Used to access the user interface.
- dpod.tenant.admin: Tenant Administrator user role. Used to access the user interface.
- dpod.tenant.appowner: Application Owner user role. Used to access the user interface.
- dpod.tenant.spadmin.unverified: Unverified Service Provider Administrator temporary user role. Used to access the user interface during account verification.
- dpod.tenant.admin.unverified: Unverified Tenant Administrator temporary user role. Used to access the user interface during account verification.
- dpod.tenant.appowner.unverified: Unverified Application Owner temporary user role. Used to access the user interface during account verification.
- dpod.tenant.api_spadmin: Service Provider Administrator API role. Used for application authentication over the API, the API role provides a subset of dpod.tenant.spadmin permissions to an application.
- dpod.tenant.api_appowner: Tenant Administrator and Application Owner API role. Used for application authentication over the API, the API role provides a subset of dpod.tenant.appowner and dpod.tenant.admin permissions to an application.
- dpod.tenant.api_service: Service API role. Used for application authentication over the API, the API role provides a subset of dpod.tenant.appowner and dpod.tenant.admin permissions to an application.