Ctrl+K

Get policy recommendations

get/api/policy/v1/enterprises/{enterpriseId}/recommendations

Returns policy recommendations for an enterprise.

Authorization: Caller must have read-policy permissions, be an admin, or be a member of the enterprise.

Path Parameters

  • enterpriseIdstringRequired
    Your Enterprise Id.

Query Parameters

  • limitintegerDefault: 3
    Number of recommendations to return. Default: 3, Minimum: 1, Maximum: 50.
    Minimum: >= 1
    Maximum: <= 50

200 Response

enterpriseId string required
The enterprise ID.
Example: 5d1a5f2c8f0a9c001a5f2c8f0ad00000
recommendations array[object] required
A recommended policy configuration for the enterprise.
recommendationId string required
Unique identifier for this recommendation.
Example: rec-abc123
adoptionPercentage number <double>required
Adoption rate for this policy pattern.
Example: 0.75
confidenceScore number <double>required
Confidence score for this recommendation (0.0 to 1.0).
Example: 0.85
explanation string required
Human-readable explanation of why this policy is recommended.
Example: 75% of similar enterprises enforce a spending limit on segregated wallet transfers.
description string
Additional description of the recommendation.
Example: Protect against unauthorized large transfers by requiring approval above a threshold.
source string required
The source of the recommendation. * `PEER_POPULAR` - Based on popular adoption among enterprises. * `PARAMETER_DRIFT` - Based on differences from common parameter configurations. * `DEFAULT_TEMPLATE` - Based on a default best-practice template.
Allowed values: PEER_POPULAR PARAMETER_DRIFT DEFAULT_TEMPLATE
Example: PEER_POPULAR
enterpriseAdoptionCount integer required
Number of enterprises that have adopted this policy pattern.
Example: 150
totalPeers integer required
Total number of enterprises considered.
Example: 200
title string required
Short title for the recommendation.
Example: Add spending limit on wallet transfers
template object required
The recommended policy rule template with scope, touchpoint, conditions, and actions.

401 Response

code string
message string
status integer

403 Response

code string
message string
status integer

404 Response

code string
message string
status integer

500 Response

code string
message string
status integer