Company View

The following are Autonomous Identity company view endpoints:

GET /api/companyview

GET /api/companyview

Get the data for company overview dashboard data. [Executive, Admin]

Endpoint

/api/companyview

Authorization

<Bearer Token JWT-value>

Example Request

curl --request GET "https://autoid-api.forgerock.com/api/companyview" \
--header "Content-Type: application/json"

Example Response

{
  "companyView": {
    "employeeTypes": [
      {
        "type": "Employee",
        "high": 723,
        "low": 27,
        "medium": 1796,
        "null_conf": 0,
        "total": 2546
      },
      {
        "type": "Non-Employee",
        "high": 867,
        "low": 14,
        "medium": 1768,
        "null_conf": 0,
        "total": 2649
      }
    ],
    "employees_wo_manager": 0,
    "employees_w_manager": 5200,
    "entitlements_without_roleowners": 0,
    "entitlements_with_roleowners": 2456,
    "total_employees": 5200,
    "coverage": {
      "total": 2456,
      "covered": 2456,
      "not_covered": 0
    },
    "entitlementsDistribution": {
      "no_users": 0,
      "one_user": 0,
      "zero_to_five_users": 1,
      "five_to_ten_users": 1064,
      "ten_to_hundred_users": 1549,
      "hundred_to_onek_user": 35,
      "onek_to_tenk_users": 0,
      "tenk_users": 0,
      "hundredk_users": 0
    }
  }
}

GET /api/companyview/allEntitlementsAvgGroups

GET /api/companyview/allEntitlementsAvgGroups

Get the average confidence score list for the company view chart. [Executive, Admin]

Endpoint

/api/companyview/allEntitlementAvgGroups

Authorization

<Bearer Token JWT-value>

Example Request

curl --request GET "https://autoid-api.forgerock.com/api/companyview/allEntitlementAvgGroups" \
--header "Content-Type: application/json"

Example Response

{
  "entitlementList": [
    {
      "start": 0,
      "end": 0.05,
      "entitlementCount": 2
    },
    {
      "start": 0.06,
      "end": 0.1,
      "entitlementCount": 14
    }
  ]
}

GET /api/companyview/mostCriticalEntitlements

GET /api/companyview/mostCriticalEntitlements

Get the most critical entitlements list. [Executive, Admin]

Endpoint

/api/companyview/mostCriticalEntitlements

Authorization

<Bearer Token JWT-value>

Example Request

curl --request GET "https://autoid-api.forgerock.com/api/companyview/mostCriticalEntitlements" \
--header "Content-Type: application/json"

Example Response

[
  {
    "org": "organization",
    "entt_id": "ent1",
    "avg_conf_score": 0.04,
    "entt_name": "Ent 1",
    "high": 0,
    "low": 1,
    "medium": 0,
    "seq": 0,
    "total_employees": 6
  },
  {
    "org": "organization",
    "entt_id": "ent2",
    "avg_conf_score": 0.04571,
    "entt_name": "Ent 2",
    "high": 0,
    "low": 1,
    "medium": 0,
    "seq": 1,
    "total_employees": 7
  }
]

GET /api/companyview/assignmentStats

GET /api/companyview/assignmentStats

Get the total assignments, low/high confidence, high volume and low/high confidence, most assigned [Executive, Admin]

Endpoint

/api/companyview/assignmentsStats

Authorization

<Bearer Token JWT-value>

Params

assignmentLimit  1
highVolumeHighMinScore  0.9
highVolumentHighMinUsersCount 100
highVolumenLowMaxScore  0.2
highVolumeLowMinUsersCount 100

Example Request

curl --request GET "https://autoid-api.forgerock.com/api/companyview/assignmentsStats?assignmentsLimit=5" \
--header "Content-Type: application/json"

Example Response

{
  "total": 47670,
  "high": 13145,
  "low": 4992,
  "unscored": 4986,
  "mostAssigned": [
    {
      "count": 344,
      "entitlement": "ent1"
    }
  ],
  "mostAssignedCount": 35,
  "highVolume": {
    "high": 23,
    "low": 17
  }
}

GET /api/companyview/assignmentHistConfSummary/{year}/{month}

GET /api/companyview/assignmentHistConfSummary/{year}/{month}

Get the number of high, medium, and low confidence assignments for the past 12-month period ending in a given year and month. [Executive, admin]

Endpoint

/api/companyview/assignmentsHistConfSummary/2020/01

Authorization

<Bearer Token JWT-value>

Example Request

curl --request GET "https://autoid-api.forgerock.com/api/companyview/assignmentsHistConfSummary/2020/1" \
--header "Content-Type: application/json"

Example Response

[
  {
    "year": 0,
    "month": 0,
    "highConf": 0,
    "medConf": 0,
    "lowConf": 0,
    "total": 0
  }
]