Securables
Use securables to manage access to Intelligent Risk Platform data
Overview
A securable is a logical container of data that is owned by a group or principal. The owner of a securable has exclusive access to that securable and all child data. For example, the owner of an exposure set controls access to the exposures, analysis results, and variations in that exposure set.
The Intelligent Risk Platform supports the following types of securables:
- Exposure Set
- Program Set
- Business Hierarchy Set
The owner of a securable or a Data Admin can share access to that securable (and its child data) with user groups.
Exposure Sets
An exposure set is a securable that controls access rights to a collection of exposure, hazard, and financial information and analysis based on that data.
An exposure set controls access to exposures, analysis results, and exposure variations.
The Exposure Sets collection in the Risk Data API exposes operations that enable Intelligent Risk Platform principals to manage exposure sets.
| Operation | Path | Description |
|---|---|---|
| Search Exposure Sets | GET /platform/riskdata/v1/exposuresets | Returns list of exposure sets. |
| Create Exposure Set | POST /platform/riskdata/v1/exposuresets | Creates a exposure set. |
| Get Exposure Set | GET /platform/riskdata/v1/exposuresets/{id} | Gets the specified exposure set. |
| Update Exposure Set | PATCH /platform/riskdata/v1/exposuresets/{id} | Updates the specified exposure set. |
The creator of the exposure set is the owner of that exposure set and has exclusive access to the exposure set and its child data (exposures, exposure variations, and exposure analysis).
The owner of the exposure set or Data Admin may grant access rights to a exposure set to user groups.
Program Sets
A program set is a collection of programs, which are representations of reinsurance deals that consist of multiple program treaties. The programs within a program set share the same cedant, underwriter, and cedence type (Inward or Outward). These programs are also defined by a common set of program set settings.
A program set controls access to programs, analysis results, and program variations.
The Program Sets collection in the Risk Data API exposes operations that enable Intelligent Risk Platform principals to manage program sets.
| Operation | Path | Description |
|---|---|---|
| Create Program Set | POST /platform/riskdata/v1/programsets | Verbs a program set. |
| Search Program Sets | GET /platform/riskdata/v1/programsets | Returns a list of program sets. |
| Update Program Set | PATCH /platform/riskdata/v1/programsets/{id} | Updates a program set. |
| Get Program Set | GET /platform/riskdata/v1/programsets/{id} | Gets a program set. |
| Delete Program Set | DELETE /platform/riskdata/v1/programsets/{id} | Updates a program set. |
The owner of the program set or Data Admin may grant access rights to a program set to user groups.
Business Hierarchy Sets
A business hierarchy set is a securable that controls access rights to a collection of business hierarchies, business hierarchy variations, and business hierarchy analyses. Each business hierarchy represents a collection of primary insurance policies and reinsurance contracts.
The Business Hierarchy Sets collection in the Risk Data API exposes operations that enable Intelligent Risk Platform principals to manage business hierarchy sets.
| Operation | Path | Description |
|---|---|---|
| Create Program Set | POST /platform/riskdata/v1/businesshierarchysets | Verbs a business hierarchy. |
| Search Program Sets | GET /platform/riskdata/v1/businesshierarchysets | Returns a list of business hierarchy. |
| Update Program Set | PATCH /platform/riskdata/v1/businesshierarchysets/{id} | Updates a business hierarchy. |
| Get Program Set | GET /platform/riskdata/v1/businesshierarchysets/{id} | Gets a business hierarchy. |
| Delete Program Set | DELETE /platform/riskdata/v1/businesshierarchysets/{id} | Updates a business hierarchy. |
The owner of the business hierarchy set or Data Admin may grant access rights to a business hierarchy set to user groups.
Securable Administration
A data administrator is a principal that has been assigned to a group that has the Data Administrator role. Data administrators may manage their storage consumption, relocate data, change data access permissions, change ownership for data entities when previous owners leave companies, and deal with orphaned data.
Principals assigned the Data Admin role may administer access to a securable using the Admin Data API.
The Securables collection in the Admin Data API exposes operations that enable data admins to manage securables.
| Operation | Path | Description |
|---|---|---|
| Search Securables | GET /platform/admindata/v1/securables | Returns a list of securables. |
| Get Securable | GET /platform/admindata/v1/securables/{id} | Gets the specified securable. |
| Update Securable | PATCH /platform/admindata/v1/securables/{id} | Updates the specified securable. |
| Delete Securable | DELETE /platform/admindata/v1/securables/{id} | Deletes the specified securable. |
| Archive Securable | POST /platform/admindata/v1/securables/{id} | Archives the specified securable. |
Data Admins may grant access rights to securables (exposure sets, program sets, and business hierarchy sets) to user groups using the Update Securable operation.
The Search Securable operation enables the client to define query parameters that return lists of securables based on securable properties. This operation supports queries that use the IS NULL and IS NOT NULL identity operations to identify securables that have and have not been shared with user groups.
Updated 6 days ago