Rules

The following are Autonomous Identity rules endpoints (Updated APIs in this release are marked with :

GET /api/rules/info

GET /api/rules/info

List information and statistics regarding available rules. [Ent Owner, App Owner, Admin]

Endpoint

/api/rules/info

Authorization

<Bearer Token JWT-value>

Params

by       enttowner, appOwner
user     patrick.murphy

Example Request

curl --request GET "https://autoid-api.forgerock.com/api/rules/info?by=appOwner&user=patrick.murphy" \
--header "Content-Type: application/json"

Example Response

{
  "countRules": 0,
  "countAssignments": 0,
  "countApplications": 0,
  "applications": [
    {
      "app_id": "string",
      "app_name": "string",
      "countAssignments": 0,
      "low": 0,
      "medium": 0,
      "high": 0
    }
  ]
}

GET /api/rules

icon:star[fw, role="purple" GET /api/rules

List the available rules for a user. [Ent Owner, App Owner, Admin]

Endpoint

/api/rules/

Authorization

<Bearer Token JWT-value>

Params

by        enttOwner, appOwner
user      david.elliott
cursor    (indicator on where to start a 2+ page list)
filter    (filters to apply when searching)
pageSize  (number of records per page to retrieve)

Example Request

curl --request GET "lowConfidence=true&filter[medConfidence]=true&filter[highConfidence]=true&filter[autoCertify]=true&filter[autoRequest]=true&filter[entitlement]=string" \
--header "Content-Type: application/json"

Example Response

{
  "cursor": "string",
  "totalRulesCount": 0,
  "rules": [
    {
      "entitlement": {
        "owner": "string",
        "ent": "string",
        "ent_name": "string"
      },
      "app": {
        "app_id": "string",
        "app_name": "string",
        "ent": "string"
      },
      "justification": [
        {
          "id": "string",
          "title": "string",
          "value": "string"
        }
      ],
      "assignees": [
        {
          "id": "string",
          "name": "string",
          "properties": [
            {
              "id": "string",
              "title": "string",
              "value": "string"
            }
          ],
          "last_usage": "2021-04-14T19:40:27.740Z"
        }
      ],
      "confidence": 0,
      "countUnassigned": 0,
      "countAssigned": 0,
      "isAutoCertify": true,
      "autoCertifyDate": "2021-04-14T19:40:27.740Z",
      "isAutoRequest": true,
      "autoRequestDate": "2021-04-14T19:40:27.740Z",
      "approvalAuthor": {
        "id": "string",
        "name": "string"
      },
      "requestApprovalReason": "string",
      "certifyApprovalReason": "string"
    }
  ]
}