Resources for managing tenant-level entities
Overview
The Tenant Data API operations collects operations for managing tenant-level operational resources required for integration with Intelligent Risk Platform.
For each licensed application, the tenant is assigned a resource quota that specifies guarantees and limits on access to system resources, and a resource group which enables the tenant to manage and track the allocation of the tenant's quota of platform jobs.
The resource quota represents a fixed share of resources available to the tenant as part of an application package.
These resource quotas specify the number of concurrent primary jobs, the number of concurrent secondary jobs, and the total number of jobs per day. The following sections describe entitlement-based resource quotas, identify the relationship between resource groups and job quotas, and strategies for using resource groups effectively on the Intelligent Risk Platform.
Collections
Tenant Data API operations are organized in five collections: Resource Groups Usages, Tenant Jobs, VPN Connections, and Encryption Keys.
Resource Groups
The Resource Groups collection consists of operations for viewing information about resource groups.
| Operation | Endpoint | Description |
|---|---|---|
| Search Resource Groups | /platform/tenantdata/v1/entitlements/ {entitlement}/resourcegroups | Returns list of the tenant's resource groups by entitlement. |
Usages
The Usages collection consists of operations for viewing resource quota metrics, i.e. information about the percentage of a tenant's quota used by a resource group.
| Operation | Endpoint | Description |
|---|---|---|
| Get Usage Metrics | /platform/tenantdata/v1/entitlements/ {entitlement}/usages | Returns information about resource quota usage. |
| Get Usage Times | /platform/tenantdata/v1/entitlements/ {entitlement}/usages/{usageType}/timevalues | Returns resource usage metrics over time. |
Tenant Jobs
The Tenant Jobs collection consists of operations for managing tenant jobs.
These operation can be used gather information about all jobs run by the tenant across all entitlements and Platform APIs.
| Operation | Endpoint | Description |
|---|---|---|
| Search Tenant Jobs | /platform/tenantdata/v1/jobs | Returns a list of tenant jobs. |
| Update Tenant Jobs | /platform/tenantdata/v1/jobs | Updates the specified tenant job. |
VPN Connections
The VPN Connection collection consisits of operations for managing VPN connections.
A VPN connection defines a secure, encrypted VPN tunnel between a tenant’s on-premise SQL Server instances and that tenant’s Data Bridge cluster. The tenant can use this connection to send a receive data between on-premise SQL Server instances and managed server instances on Data Bridge.
| Operation | Endpoint | Description |
|---|---|---|
| Search VPN Connections | /platform/tenantdata/v1/vpn-connections | Returns list of VPN connections. |
| Get VPN Connection | /platform/tenantdata/v1/vpn-connections/{id} | Returns specified VPN connection. |
| Create VPN Connection | /platform/tenantdata/v1/vpn-connections | Creates VPN connection. |
| Update VPN Connection | /platform/tenantdata/v1/vpn-connections/{id} | Updates VPN connection. |
| Delete VPN Connection | /platform/tenantdata/v1/vpn-connections/{id} | Deletes VPN connection. |
To perform the operations in this collection, the client must have the IC-VPN entitlement.
Encryption Keys.
The Encryption Key collection consists of operations for managing encryption keys.
A VPN encryption key is a type of pre-shared key that (PSK) is shared between the tenant and the Intelligent Risk Platform. Once assigned to a VPN connection, the encryption key is used to secure traffic between on-premise SQL Server instances and managed SQL Server instances on the tenant's Data Bridge cluster.
| Operation | Endpoint | Description |
|---|---|---|
| Search Encryption Keys | /platform/tenantdata/v1/encryption-keys | Returns list of encryption keys. connections. |
| Get VPN Encryption Key | /platform/tenantdata/v1/encryption-keys/{id} | Returns specified encryption key. connection. |
| Create Encryption Key | /platform/tenantdata/v1/encryption-keys | Creates encryption key. connection. |
| Update VPN Encryption Key | /platform/tenantdata/v1/encryption-keys/{id} | Updates encryption key. connection. |
| Delete VPN Encryption Key | /platform/tenantdata/v1/encryption-keys/{id} | Deletes encryption key. connection. |
To perform the operations in this collection, the client must have the IC-VPN entitlement.
Resource Groups
A resource group is a mechanism for allocating Intelligent Risk Platform system resources and for managing resource quotas within an organization.
For each entitlement, the tenant is "seeded" (provisioned) a resource group, which is identified by a unique ID number.
Tenant resource quotas are managed by means of resource groups.
Resource Group Administration
All resource group management tasks must be performed in Admin Center. The Tenant Data API does not support operations for creating resource groups or assigning user group-based access controls to those resource groups.
Using controls in Admin Center, tenant administrators can create, update, and delete resource groups. To learn more, see Resource Group and Application Management in Help Center.
Usages
A resource quota is a fixed share of Intelligent Risk Platform system resources that is allocated to the tenant as part of an entitlement (e.g. RI-RISKMODELER, RI-UNDERWRITEIQ). To learn more about resource quotas see Resource Quota Management.
Usage metrics can be filtered by usageType: ModeledLocations, Jobs, and Storage. All usage metrics are filtered by date. If no date is specified, returns usage metrics for the current date.
Entitlements
Client must be assigned one of the following entitlements to use the Tenant Data API:
IC-VPNRI-DATAADMINRI-EXPOSUREIQRI-RISKMODELERRI-TREATYIQRI-UNDERWRITEIQ