Guides

Resource Groups

A resource group is a mechanism for allocating Intelligent Risk Platform resources and for managing resource quotas within an organization tenant.

A business may license multiple Intelligent Risk Platform applications that utilize the Risk Intelligent Platform and allocate different resource quotas for each of these applications.

Resource groups enable the Intelligent Risk Platform to determine which application is utilizing platform resources and ensure that compute capacity is correctly allocated to the applications used within in a tenant's organization.

When do I pass a resource group ID?

Client applications making use of platform resources must pass a resource group ID in the header of requests that initiate a job job.

The custom X-Rms-Resource-Group-Idheader accepts a resource group ID that identifies the application making the request and thereby enables the Intelligent Risk Platform to determine which resource quota to "charge" for performing the API call.

It is advised to passX-Rms-Resource-Group-Idheader in any call to keep the context of the application in the end-to-end flow and avoid the necessity to be aware of which call mandates the header and which ones do not.

Step 1: Obtain resource group ID

The Tenant Data API enables clients to retrieve the resource group IDs assigned to a tenant.

As with all Intelligent Risk Platform requests, you must specify a host in the resource URL and provide a valid API key or User Authorization Token in the request header. The {host} variable identifies the environment hosting your application instance (one of api-euw1.rms.com or api-use1.rms.com) and the apiKey specifies an API key token.

curl --location --request GET "https://{host}/platform/tenantdata/v1/entitlements/{entitlement}/resourcegroups" 
    --header "Authorization: {api_key}"

The entitlement path parameter specifies the licensed Intelligent Risk Intelligence application. One of RI-RISKMODELER or RI-UNDERWRITEIQ or RI-EXPOSUREIQ.

Step 2: Pass resource group ID in the request header

All Intelligent Risk Platform endpoints that create platform jobs now require the custom header X-Rms-Resource-Group-Id, in which the client may pass a resource group ID. The Intelligent Risk Platform uses this resource group ID to identify which application's resources are utilized.

For example, to Create Import Job for a tenant that has licensed both the Risk Modeler and ExposureIQ applications, the appropriate resource group ID in the X-Rms-Resource-Group-Id header must be specified to determine which resource quota to use.

curl --location --request POST 'https://{host}/platform/import/v1/jobs' \
--header 'Authorization: {api_key}' \
--header 'Content-Type: application/json' \
--header 'X-Rms-Resource-Group-Id: 080c4d42-beeb-40d2-b10d-22a3f0d5b5b4' \
--data '{
	"importType": "CEDE",
	"resourceUri": "/platform/riskdata/v1/exposuresets/1234",
	"settings": {
        "folderId": "1111",
        "exposureName": "test-database",
        "cedeSchemaVersion": "10.0"
	}
}'

Updated about 1 year ago