Search securables

get

https://{host}/platform/admindata/v1/securables

Returns a list of securables.

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.

This operation supports response filtering based the value of a subset of properties. Depending on the property, you may use a combination of comparison operators, list operators, and logical operators.

🍐
Permissions
To perform this operation, a principal must belong to a group that has been assigned the Data Admin role.
To learn more about role-based permissions in Risk Modeler, see Access Controls.

Query Params

filter

string

Query string to select response data based on property values.

Supported properties: groupId, owner, ownerStatus, securableId, securableName, securableType. Supported logical operators depend on the data type of property:

Property	Type	Comparison	List	Identity
`groupId`	`string`	`=`	`IN`	`IS NULL`, `IS NOT NULL`
`owner`	`string`	`=`	`IN`
`ownerStatus`	`string`	`=`
`securableId`	`number`	`=`	`IN`
`securableName`	`string`	`=`, `LIKE`	`IN`
`securableType`	`string`	`=`	`IN`

The IS NULL and IS NOT NULL filter based on whether or not a securable is assigned to a group or not. See Filtering Responses.

sort

string

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

Supported properties: owner, securableId, securableName, securableType

limit

int32

Number of records to display per page

offset

int32

Number of the page displaying the returned records, starting at 0

Responses

🍐Permissions

200Success

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error

🍐
Permissions