Get policy recommendations

Response Body

object

• enterpriseId string required
  The enterprise ID.
• recommendations array of objects required
  List of policy recommendations.
  recommendations object

  • recommendationId string required
    Unique identifier for this recommendation.
  • adoptionPercentage number double required
    Adoption rate for this policy pattern.
  • confidenceScore number double required
    Confidence score for this recommendation (0.0 to 1.0).
  • explanation string required
    Human-readable explanation of why this policy is recommended.
  • description string
    Additional description of the recommendation.
  • source string enum 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.
    PEER_POPULARPARAMETER_DRIFTDEFAULT_TEMPLATE
  • enterpriseAdoptionCount integer required
    Number of enterprises that have adopted this policy pattern.
  • totalPeers integer required
    Total number of enterprises considered.
  • title string required
    Short title for the recommendation.
  • template object required
    The recommended policy rule template with scope, touchpoint, conditions, and actions.
    template object

    • name string required
      Name of the template.
    • scopeCondition object required
      The scope condition for the recommended policy rule.
      scopeCondition object

      • name string required
        Name of the scope condition.
      • label string required
        Human-readable label.
      • description string required
        Description of the scope condition.
      • status string enum required
        Status of the scope condition.
        ACTIVEINACTIVE
      • parameters array of objects
        Parameter definitions for the scope condition.
      • adminOnly boolean
        Whether this scope condition is admin-only.

        Defaults to false

      • bitgoManaged boolean
        Whether this scope condition is managed by BitGo.

        Defaults to false

    • touchpoint object required
      The touchpoint (trigger point) for the recommended policy rule.
      touchpoint object

      • id string required
        Unique identifier of the touchpoint.
      • name string required
        Name of the touchpoint.
      • status string enum required
        Status of the touchpoint.
        ACTIVEINACTIVE
      • label string required
        Human-readable label for the touchpoint.
      • description string required
        Description of the touchpoint.
      • adminOnly boolean required
        Whether this touchpoint is admin-only.
    • touchpointConditions array of objects required
      List of conditions for the policy rule.
      touchpointConditions object

      • condition object required
        Metadata for a recommended condition.
        condition object

        • name string required
          Name of the condition.
        • label string required
          Human-readable label.
        • description string required
          Description of the condition.
        • status string enum required
          Status of the condition.
          ACTIVEINACTIVE
        • adminOnly boolean
          Whether this condition is admin-only.

          Defaults to false

        • parameters array of objects required
          Parameter definitions for the condition.
          parameters object

          • name string required
            Name of the parameter.
          • label string required
            Human-readable label.
          • description string required
            Description of the parameter.
          • type string required
            Type of the parameter value.
          • required string enum required
            Whether the parameter is required.
            ALWAYSOPTIONALONE_OR_MORE
          • allowMultiple boolean required
            Whether multiple values can be provided.
          • values array of objects
            List of valid values (empty if free-form).
        • bitgoManaged boolean required
          Whether this condition is managed by BitGo.
      • conditionParameters map
        Recommended parameter values for the condition.
    • touchpointActions array of objects required
      List of actions for the policy rule.
      touchpointActions object

      • action object required
        Metadata for a recommended action.
        action object

        • name string required
          Name of the action.
        • label string required
          Human-readable label.
        • description string required
          Description of the action.
        • status string enum required
          Status of the action.
          ACTIVEINACTIVE
        • adminOnly boolean required
          Whether this action is admin-only.
        • parameters array of objects required
          Parameter definitions for the action.
          parameters object

          • Same shape as RecommendationParameterDef.
        • bitgoManaged boolean required
          Whether this action is managed by BitGo.
      • actionParameters map
        Recommended parameter values for the action.
    • scopeConditionParameters map nullable
      Parameter values for the scope condition.
    • touchpointConditionsOperator string enum nullable
      Logical operator for combining multiple conditions or actions within a clause.
      ANDOR
    • touchpointActionsOperator string enum nullable
      Logical operator for combining multiple conditions or actions within a clause.
      ANDOR

Response Body

object

• code string
• message string
• status integer

Response Body

object

• code string
• message string
• status integer

Response Body

object

• code string
• message string
• status integer

Response Body

object

• code string
• message string
• status integer