Appendix B: The ui-config.json File
The ui-config.json file contains configuration properties for the Autonomous Identity user interface and API services that are loaded as key-value pairs into Hashicorp Consul. The values are loaded through the Configuration Service that are shared across Autonomous Identity's microservices.
The process to use the ui-config.json is as follows:
On the target node, run the analytics create-ui-config command to generate the
ui_config.jsonfile in the/data/conf/directory.Make changes to the
ui_config.jsontailored to your deployment and production environment.Run the analytics apply-ui-config command to apply your changes.
The file is used to do the following:
Define DB schemas used by the API to interface with the data layer. These schemas all contain a
table_nameproperty.Defines the organization name property,
OrgNameConf, used for data displaoyed on the Company Overview Dashboard page.Defines various confidence score or count criteria, such as high, medium, and low score threshold levels and a minimum score threshold level to allow auto-certify or auto-request actions. The key properties are:
ConfidenceScorethresholdsConfConfigThresholdsConfMostAssignedHighVolumeHighRiskConf
Defines the permissions that are applied to each Autonomous Identity user group. The key property is
PermissionsConf.Maps database columns to user-friendly titles for fields, labels, and headings in the UI. The key properties are:
UIConfigUIHRDataUIJustifications
Defines the user and entitlement attributes to be used as filters in the UI. The key properties are:
FilteringOptionsConfAllowedAttributesForFiltering
Defines the character delimiter used in the raw justification string data to separate the justification key from its value. The key property is:
JustificationDelimeter.
The following ui-config.json file version is v0.32.0. The file is not expected to change much for each release, but some revision may occur intermittently.
{
"RecommendPredictionsConf": {
"name": "RecommendPredictions",
"modelDefinition": {
"fields": {
"usr_key": "text",
"ent": "text",
"conf": "decimal",
"freq": "decimal",
"frequnion": "decimal",
"rule": {
"type": "list",
"typeDef": "<text>"
},
"last_usage": "text"
},
"key": [
"usr_key",
"ent"
],
"table_name": "recommend_predictions"
}
},
"CompanyViewOverviewConf": {
"name": "CompanyViewOverview",
"modelDefinition": {
"fields": {
"key": "text",
"total_employees": "int",
"employees_wo_manager": "int",
"employees_w_manager": "int",
"entitlements_without_roleowners": "int",
"entitlements_with_roleowners": "int",
"total_entitlements": "int",
"entitlements_covered_by_model": "int",
"entitlements_not_covered": "int",
"entitlements_w_no_users": "int",
"entitlements_w_one_user": "int",
"entitlements_w_zero_to_five_users": "int",
"entitlements_w_five_to_ten_users": "int",
"entitlements_w_ten_to_hundred_users": "int",
"entitlements_w_hundred_to_onek_user": "int",
"entitlements_w_onek_to_tenk_users": "int",
"entitlements_w_tenk_users": "int",
"entitlements_w_hundredk_users": "int"
},
"key": [
"key"
],
"table_name": "company_view_overview"
}
},
"CompanyViewEmployeeTypeConf": {
"name": "CompanyViewEmployeeType",
"EntitlementUserManagerScoresConf": {
"name": "EntitlementUserManagerScores",
"modelDefinition": {
"fields": {
"entitlement": "text",
"entitlement_name": "text",
"user": "text",
"user_name": "text",
"manager": "text",
"score": "float",
"justification": {
"type": "list",
"typeDef": "<text>"
},
"app_id": "text",
"app_name": "text"
},
"key": [
"entitlement",
"score",
"user",
"manager"
],
"table_name": "entitlement_user_manager_scores"
}
},
"GraphByRoleConf": {
"name": "GraphByRole",
"modelDefinition": {
"fields": {
"role": "text",
"entitlement": "text",
"entitlement_name": "text",
"app_id": "text",
"app_name": "text",
"high_risk": "text"
},
"key": [
"entitlement",
"app_id",
"role"
],
"indexes": [
"entitlement_name"
],
"table_name": "graph_by_role"
}
},
"GraphConf": {
"name": "Graph",
"modelDefinition": {
"fields": {
"manager": "text",
"user": "text",
"manager_name": "text",
"RoleOwnerConf": {
"name": "RoleOwner",
"modelDefinition": {
"fields": {
"role": "text",
"role_name": "text",
"entitlement": "text",
"entitlement_name": "text",
"user": "text",
"user_name": "text",
"score": "decimal",
"justification": {
"type": "list",
"typeDef": "<text>"
},
"app_id": "text",
"app_name": "text",
"high_risk": "text"
},
"key": [
"role",
"entitlement",
"score",
"app_id",
"user"
],
"table_name": "usr_scores_by_role"
}
},
"RuleAccessDecisionConf": {
"name": "RuleAccessDecision",
"modelDefinition": {
"fields": {
"entitlement": "text",
"justification": {
"type": "frozen",
"typeDef": "<list<text>>"
},
"is_autocertify": "boolean",
"date_autocertified": "timestamp",
"is_autorequest": "boolean",
"date_autorequested": "timestamp",
"author": "text",
"author_name": "text",
"author_type": "text",
"reason": "text"
},
"key": [
"entitlement",
"justification"
],
"table_name": "rule_access_decisions"
}
},
"RuleAccessDecisionHistoryConf": {
"name": "RuleAccessDecisionHistory",
"modelDefinition": {
"fields": {
"entitlement": "text",
"justification": {
"type": "frozen",
"typeDef": "<list<text>>"
},
"is_autocertify": "boolean",
"date_autocertified": "timestamp",
"is_autorequest": "boolean",
"date_autorequested": "timestamp",
"author": "text",
"author_name": "text",
"author_type": "text",
"reason": "text",
"date_created": "timestamp"
},
"key": [
"entitlement",
"justification",
"date_created"
],
"table_name": "rule_access_decisions_history"
}
},
"UserAccessDecisionConf": {
"name": "UserAccessDecision",
"modelDefinition": {
"fields": {
"user": "text",
"entitlement": "text",
"is_certified": "boolean",
"date_certified": "timestamp",
"is_revoked": "boolean",
"date_revoked": "timestamp",
"is_requested": "boolean",
"date_requested": "timestamp",
"author": "text",
"author_name": "text",
"author_type": "text",
"reason": "text",
"is_processed": "boolean",
"is_archived": "boolean"
},
"key": [
"user",
"entitlement"
],
"table_name": "user_access_decisions"
}
},
"UserAccessDecisionHistoryConf": {
"name": "UserAccessDecisionHistory",
"modelDefinition": {
"fields": {
"user": "text",
"entitlement": "text",
"is_certified": "boolean",
"date_certified": "timestamp",
"is_revoked": "boolean",
"date_revoked": "timestamp",
"is_requested": "boolean",
"date_requested": "timestamp",
"author": "text",
"author_name": "text",
"author_type": "text",
"reason": "text",
"is_processed": "boolean",
"is_archived": "boolean",
"date_created": "timestamp"
},
"key": [
"user",
"entitlement",
"date_created"
],
"table_name": "user_access_decisions_history"
}
},
"UserConf": {
"name": "User",
"modelDefinition": {
"fields": {
"user": "text",
"chiefyesno": "text",
"city": "text",
"costcenter": "text",
"jobcodename": "text",
"lineofbusiness": "text",
"managername": "text",
"usrdepartmentname": "text",
"userdisplayname": "text",
"usremptype": "text",
"usrmanagerkey": "text",
"isactive": "text"
},
"key": [
"user"
],
"table_name": "user"
}
},
"UserScoreConf": {
"name": "UserScore",
"modelDefinition": {
"fields": {
"manager": "text",
"user": "text",
"manager_name": "text",
"user_name": "text",
"score": "decimal",
"entitlement": "text",
"entitlement_name": "text",
"justification": {
"type": "list",
"typeDef": "<text>"
},
"app_id": "text",
"app_name": "text",
"high_risk": "text"
},
"key": [
"app_id",
"manager",
"user",
"entitlement"
],
"table_name": "usr_scores_by_manager"
}
},
"UserEntitlementMappingsConf": {
"name": "UserEntitlementMappings",
"modelDefinition": {
"fields": {
"user": "text",
"ent": "text",
"high_risk": "text",
"is_assigned": "text",
"last_usage": "timestamp"
},
"key": [
"user",
"ent"
],
"table_name": "user_entitlement_mappings"
}
},
"SupervisorAppEnttConf": {
"name": "SupervisorAppEntt",
"modelDefinition": {
"fields": {
"manager": "text",
"entitlement": "text",
"app_id": "text"
},
"key": [
"manager",
"app_id"
],
"table_name": "app_entitlement_by_manager"
}
},
"FilteringOptionsModelConf": {
"name": "FilteringOptions",
"modelDefinition": {
"fields": {
"role": "text",
"type": "text",
"owner_id": "text",
"group": "text",
"id": "text",
"name": "text",
"objects": {
"type": "list",
"typeDef": "<text>"
}
},
"key": [
"id"
],
"table_name": "filtering_options"
}
},
"CompanyViewMostCriticalEnttConf": {
"name": "CompanyViewMostCriticalEntt",
"modelDefinition": {
"fields": {
"org": "text",
"entt_id": "text",
"entt_name": "text",
"high": "int",
"medium": "int",
"seq": "int",
"low": "int",
"total_employees": "int",
"avg_conf_score": "float"
},
"key": [
"org",
"entt_id"
],
"table_name": "company_view_most_critical_entt"
}
},
"AutoprovisionEntitlementResults": {
"name": "AutoprovisionEntitlementResults",
"modelDefinition": {
"fields": {
"decision": "int",
"score": "float",
"threshold": "float",
"app_id": "text",
"app_name": "text",
"entitlement_name": "text",
"entitlement": "text",
"user": "text",
"user_name": "text",
"created": "timestamp",
"updated": "timestamp"
},
"key": [
"decision",
"entitlement",
"user"
],
"table_name": "autoprovision_entitlement_results"
}
},
"EntitlementsCounts": {
"name": "EntitlementsCounts",
"modelDefinition": {
"fields": {
"type": "text",
"count": "int",
"entitlement": "text"
},
"key": [
"type",
"count",
"entitlement"
],
"clustering_order": {
"count": "desc",
"entitlement": "desc"
},
"table_name": "entitlements_counts"
}
},
"MaxScoreEntitlementsUserCount": {
"name": "MaxScoreEntitlementsUserCount",
"modelDefinition": {
"fields": {
"max_score": "float",
"users_count": "int",
"entitlement": "text"
},
"key": [
"max_score",
"users_count",
"entitlement"
],
"table_name": "max_score_entitlements_user_count"
}
},
"MinScoreEntitlementsUserCount": {
"name": "MinScoreEntitlementsUserCount",
"modelDefinition": {
"fields": {
"min_score": "float",
"users_count": "int",
"entitlement": "text"
},
"key": [
"min_score",
"users_count",
"entitlement"
],
"table_name": "min_score_entitlements_user_count"
}
},
"EntitlementDrivingFactorConf": {
"name": "EntitlementDrivingFactor",
"modelDefinition": {
"fields": {
"ent": "text",
"attribute": "text",
"count": "int"
},
"key": [
"ent",
"attribute"
],
"table_name": "entitlement_driving_factor"
}
},
"ReportsConf": {
"RoleMining": "RoleMining",
"Automatic Re-certification Feed": "AutomaticRecertificationFeed",
"Full Output (IDM) Feed": "FullOutputFeed",
"Anomaly Report": "AnomalyReport",
"Recommend Predictions": "RecommendPredictions",
"Event Based Certification": "EventBasedCertification"
},
"RoleMining": {
"name": "RoleMining",
"modelDefinition": {
"fields": {
"policy": {
"type": "frozen",
"typeDef": "<list<text>>"
},
"total_employees": "int",
"entt_id": {
"type": "list",
"typeDef": "<text>"
},
"entt_name": {
"type": "list",
"typeDef": "<text>"
},
"total_entts": "int",
"role": "int"
},
"key": [
"policy"
],
"table_name": "role_mining"
}
},
"AutomaticRecertificationFeed": {
"name": "AutomaticRecertificationFeed",
"modelDefinition": {
"fields": {
"user": "text",
"entitlement": "text",
"app_id": "text",
"app_name": "text",
"auto_recert": "text",
"chiefyesno": "text",
"city": "text",
"costcenter": "text",
"ent_size": "decimal",
"entitlement_name": "text",
"event_recert": "text",
"freq": "decimal",
"frequnion": "decimal",
"jobcodename": "text",
"justification": {
"type": "list",
"typeDef": "<text>"
},
"lineofbusiness": "text",
"lineofbusinesssubgroup": "text",
"managername": "text",
"score": "decimal",
"user_name": "text",
"userdepartmentname": "text",
"userdisplayname": "text",
"usremptype": "text",
"usrmanagerkey": "text"
},
"key": [
"user",
"entitlement"
],
"table_name": "master_feed"
}
},
"FullOutputFeed": {
"name": "FullOutputFeed",
"modelDefinition": {
"fields": {
"user": "text",
"entitlement": "text",
"app_id": "text",
"app_name": "text",
"auto_recert": "text",
"chiefyesno": "text",
"city": "text",
"costcenter": "text",
"ent_size": "decimal",
"entitlement_name": "text",
"event_recert": "text",
"freq": "decimal",
"frequnion": "decimal",
"jobcodename": "text",
"justification": {
"type": "list",
"typeDef": "<text>"
},
"lineofbusiness": "text",
"lineofbusinesssubgroup": "text",
"managername": "text",
"score": "decimal",
"user_name": "text",
"userdepartmentname": "text",
"userdisplayname": "text",
"usremptype": "text",
"usrmanagerkey": "text"
},
"key": [
"user",
"entitlement"
],
"table_name": "master_feed"
}
},
"RecommendPredictions": {
"name": "RecommendPredictions",
"modelDefinition": {
"fields": {
"usr_key": "text",
"ent": "text",
"conf": "decimal",
"freq": "decimal",
"frequnion": "decimal",
"rule": {
"type": "list",
"typeDef": "<text>"
},
"last_usage": "text"
},
"key": [
"usr_key",
"ent"
],
"table_name": "recommend_predictions"
}
},
"AnomalyReport": {
"name": "AnomalyReport",
"modelDefinition": {
"fields": {
"user": "text",
"user_name": "text",
"manager_name": "text",
"entitlement": "text",
"entitlement_name": "text",
"justification": {
"type": "list",
"typeDef": "<text>"
},
"app_name": "text",
"confidence": "float",
"avg_conf_score": "float",
"total_assignees": "int",
"num_below_conf_threshold": "int",
"percent_below_threshold": "float",
"freq": "decimal",
"frequnion": "decimal",
"median": "float",
"last_usage": "timestamp"
},
"key": [
"user_name",
"avg_conf_score"
],
"table_name": "anomaly_report"
}
},
"EventBasedCertification": {
"name": "EventBasedCertification",
"modelDefinition": {
"fields": {
"id": "text",
"type": "text",
"batch_id": "int",
"original": "text",
"update": "text"
},
"key": [
"id",
"type",
"batch_id"
],
"table_name": "event_based_certification"
}
},
"FilteringOptionsConf": {
"filteringOptions": [
{
"groupName": "CITY",
"title": "CITY",
"optionTextField": "id"
}
]
},
"JobStatus": {
"name": "JobStatus",
"modelDefinition": {
"fields": {
"job_name": "text",
"start_time": "text",
"batch_id": "int",
"end_time": "text",
"flag": "text"
},
"key": [
"job_name",
"start_time",
"batch_id"
],
"table_name": "job_status"
}
},
"EntitlementAssignmentConfSummary": {
"name": "EntitlementAssignmentConfSummary",
"modelDefinition": {
"fields": {
"timestamp": "timestamp",
"num_high_conf_assignments": "int",
"num_low_conf_assignments": "int",
"num_med_conf_assignments": "int"
},
"key": [
"timestamp"
],
"table_name": "entitlement_assignment_conf_summary"
}
},
"OrgNameConf": {
"orgName": "test"
},
"ConfidenceScoreThresholdsConf": {
"thresholds": {
"top": 1.01,
"high": 0.75,
"medium": 0.35,
"low": 0,
"autoAccess": 0.5
}
},
"ConfigThresholdsConf": {
"volumeThresholds": {
"high": 90,
"low": 20
}
},
"MostAssigned": {
"count": 100
},
"HighVolume": {
"high": {
"minScore": 0.9,
"minUsersCount": 100
},
"low": {
"maxScore": 0.2,
"minUsersCount": 100
}
},
"UIConfig": {
"userDisplayNameKey": "userdisplayname"
},
"UIHRData": {
"user": "User",
"chiefyesno": "Chief",
"city": "City",
"costcenter": "Cost Center",
"jobcodename": "Job Code Name",
"lineofbusiness": "Line of Business",
"managername": "Manager",
"usrdepartmentname": "Department",
"userdisplayname": "User Display Name",
"usremptype": "Employee Type",
"UIJustifications": {
"USR_KEY": "User",
"CITY": "City",
"USR_DEPARTMENT_NAME": "Department",
"COST_CENTER": "Cost Center",
"JOBCODE_NAME": "Job Code Name",
"LINE_OF_BUSINESS": "Line of Business",
"LINE_OF_BUSINESS_SUBGROUP": "Line of Business Subgroup",
"CHIEF_YES_NO": "Chief",
"USR_EMP_TYPE": "Employee Type",
"MANAGER_NAME": "Manager",
"USR_DISPLAY_NAME": "User Display Name",
"USR_MANAGER_KEY": "Manager Key"
},
"HighRiskConf": {
"filterValue": "1"
},
"JustificationDelimeter": {
"justificationDelimeter": "_"
},
"SearchConf": {
"name": "Search",
"modelDefinition": {
"fields": {
"userdisplayname": "text",
"user": "text",
"isentitlementowner": "boolean",
"issupervisor": "boolean",
"isapplicationowner": "boolean"
},
"indexes": [
"userdisplayname"
],
"key": [
"user"
],
"table_name": "search_user"
}
},
"EntitlementsConf": {
"name": "Entitlements",
"modelDefinition": {
"fields": {
"id": "text",
"app_id": "text",
"app_name": "text",
"entt_id_at_app": "text",
"entt_name": "text"
},
"indexes": [
"entt_name"
],
"key": [
"id"
],
"table_name": "entitlements"
}
},
"PermissionsConf": {
"permissions": {
"Zoran Admin": {
"title": "Admin",
"can": "*"
},
"Zoran Application Owner": {
"title": "Application Owner",
"can": [
"SHOW__APPLICATION_VIEW",
"FILTER__ENTITLEMENTS",
"SEARCH__USER_ENTITLEMENTS",
"SHOW_OVERVIEW_PAGE",
"SHOW__ENTITLEMENT",
"SHOW__ENTITLEMENT_USERS",
"SHOW__FILTER_OPTIONS",
"SHOW__ROLEOWNER_UNSCORED_ENTITLEMENTS",
"SHOW__ROLE_OWNER_PAGE",
"SHOW__ROLE_OWNER_USER_PAGE",
"SHOW__ROLE_OWNER_ENT_PAGE",
"SHOW__ROLE_OWNER_AUTO_DATA",
"SHOW__USER_ENTITLEMENTS",
"SHOW__UNSCORED_ENTITLEMENTS",
"SHOW__RULES_BY_APP_OWNER",
"CERTIFY__ENTITLEMENTS_TO_USERS",
"CERTIFY__USERS_TO_ENTITLEMENTS",
"REVOKE__CERTIFY_ACCESS"
]
},
"Zoran Entitlement Owner": {
"title": "Entitlement Owner",
"can": [
"FILTER__ENTITLEMENTS",
"SEARCH__USER_ENTITLEMENTS",
"SHOW_OVERVIEW_PAGE",
"SHOW__ENTITLEMENT",
"SHOW__ENTITLEMENT_USERS",
"SHOW__FILTER_OPTIONS",
"SHOW__ROLEOWNER_UNSCORED_ENTITLEMENTS",
"SHOW__ROLE_OWNER_PAGE",
"SHOW__ROLE_OWNER_USER_PAGE",
"SHOW__ROLE_OWNER_ENT_PAGE",
"SHOW__ROLE_OWNER_AUTO_DATA",
"SHOW__USER_ENTITLEMENTS",
"SHOW__UNSCORED_ENTITLEMENTS",
"SHOW__RULES_BY_ENTT_OWNER",
"CERTIFY__ENTITLEMENTS_TO_USERS",
"CERTIFY__USERS_TO_ENTITLEMENTS",
"REVOKE__CERTIFY_ACCESS"
]
},
"Zoran Executive": {
"title": "Executive",
"can": [
"SEARCH__USER",
"SHOW__ASSIGNMENTS_STATS",
"SHOW__COMPANY_PAGE",
"SHOW__COMPANY_COVERAGE_PAGE",
"SHOW__COMPANY_ENTITLEMENTS_PAGE",
"SHOW__COMPANY_ENTITLEMENTS_DATA",
"SEARCH__USER",
"FILTER__ENTITLEMENTS",
"SHOW_OVERVIEW_PAGE",
"SHOW__EMPLOYEE",
"SHOW__FILTER_OPTIONS",
"SHOW__SUPERVISOR_PAGE",
"SHOW__SUPERVISOR_DETAILS_PAGE",
"SHOW__SUPERVISOR_ENT_DATA",
"SHOW__SUPERVISOR_USER_DATA",
"SHOW__SUPERVISOR_ENTITLEMENT_USERS",
"SHOW__SUPERVISOR_USER_ENTITLEMENTS",
"SEARCH__SUPERVISOR_USER_ENTITLEMENTS",
"SHOW__SUPERVISOR_UNSCORED_ENTITLEMENTS",
"CERTIFY__ENTITLEMENTS_TO_USERS",
"CERTIFY__USERS_TO_ENTITLEMENTS",
"REVOKE__CERTIFY_ACCESS"
]
},
"Zoran User": {
"title": "User",
"can": [
"SHOW__ENTITLEMENT",
"SHOW__USER",
"SHOW__CERTIFICATIONS"
]
}
}
},
"AllowedAttributesForFiltering": {
"entitlement": [
"risk_level",
"criticality",
"owner"
],
"user": [
"usr_department_name",
"line_of_business_subgroup",
"city",
"jobcode_name",
"usr_emp_type",
"chief_yes_no",
"manager_name",
"line_of_business",
"cost_center"
]
},
"UIJustification": {
"USR_KEY": "User",
"CHIEF_YES_NO": "Chief",
"CITY": "City",
"COST_CENTER": "Cost Center",
"JOBCODE_NAME": "Job Code Name",
"LINE_OF_BUSINESS": "Line of Business",
"MANAGER_NAME": "Manager",
"USR_DEPARTMENT_NAME": "Department",
"USR_DISPLAY_NAME": "User Display Name",
"USR_EMP_TYPE": "Employee Type",
"USR_MANAGER_KEY": "Manager Key",
"IS_ACTIVE": "Active"
}
}