{ "info":{ "contact":{ "email":"oimdevsup_ww_grp@oracle.com" }, "description":"Describes the REST APIs for Oracle Identity Role Intelligence", "license":{ "name":"Embedded Software License (ESL)", "url":"https://www.oracle.com/a/ocom/docs/corporate/oracle-software-licensing-basics.pdf" }, "title":"REST APIs for Oracle Identity Role Intelligence", "version":"2021.04.29", "x-summary":"Describes the REST APIs for Oracle Identity Role Intelligence" }, "openapi":"3.0", "tags":[ { "name":"Authentication", "description":"Authentication API's" }, { "name":"Candidate Role", "description":"Candidate Role API's" }, { "name":"ETL Jobs", "description":"ETL jobs API's" }, { "name":"Published Candidate Role", "description":"published candidate role API's" }, { "name":"Role", "description":"Role API's" }, { "name":"Role Mining Task", "description":"CRUD API's for Role Mining Task" }, { "name":"Task Resources", "description":"Task Resources API's" }, { "name":"User", "description":"The operations from the User category." }, { "name":"Utility", "description":"Utility API's" } ], "paths":{ "/oiri/api/v1/entity/{entityType}/attributes":{ "get":{ "tags":[ "Utility" ], "summary":"Get entity metadata", "operationId":"getEntityMetaData", "parameters":[ { "in":"path", "name":"entityType", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"searchable", "required":false, "schema":{ "type":"string" } }, { "in":"query", "name":"displayable", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "type":"object", "properties":{ "attributeName":{ "type":"string" }, "displayName":{ "type":"string" }, "dataType":{ "type":"string" }, "exprAttrName":{ "type":"string" }, "searchable":{ "type":"boolean" }, "displayable":{ "type":"boolean" }, "uniqueness":{ "type":"boolean" }, "supportAnalytics":{ "type":"boolean" }, "custom":{ "type":"boolean" }, "oiiColumnName":{ "type":"string" } } } } } } } }, "x-internal-id":"oiri-api-v1-entity-{entityType}-attributes-get", "x-filename-id":"oiri-api-v1-entity-entitytype-attributes-get" } }, "/oiri/api/v1/published-candidate-role/{publishedCandidateRoleId}/applications":{ "get":{ "tags":[ "Published Candidate Role" ], "summary":"List applications for a published candidate role", "operationId":"listPublishedCandidateRoleApplications", "parameters":[ { "in":"path", "name":"publishedCandidateRoleId", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"limit", "schema":{ "default":10, "format":"int32", "type":"integer" } }, { "in":"query", "name":"offset", "schema":{ "default":0, "format":"int32", "type":"integer" } }, { "in":"query", "name":"sortBy", "schema":{ "default":"applicationName", "type":"string" } }, { "in":"query", "name":"sortOrder", "schema":{ "default":"ASC", "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PublishedCandidateRoleApplicationResponse" } } } } }, "x-internal-id":"oiri-api-v1-published-candidate-role-{publishedCandidateRoleId}-applications-get", "x-filename-id":"oiri-api-v1-published-candidate-role-publishedcandidateroleid-applications-get" } }, "/oiri/api/v1/published-candidate-role/{publishedCandidateRoleId}/entitlements/.search":{ "post":{ "tags":[ "Published Candidate Role" ], "summary":"List entitlements for a published candidate role", "operationId":"listPublishedCandidateRoleEntitlements", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SearchRequest" } } } }, "parameters":[ { "in":"path", "name":"publishedCandidateRoleId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PublishedCandidateRoleListResponse" } } } } }, "x-internal-id":"oiri-api-v1-published-candidate-role-{publishedCandidateRoleId}-entitlements-.search-post", "x-filename-id":"oiri-api-v1-published-candidate-role-publishedcandidateroleid-entitlements-search-post" } }, "/oiri/api/v1/published-candidate-role/{publishedCandidateRoleId}/users/.search":{ "post":{ "tags":[ "Published Candidate Role" ], "summary":"List users for a published candidate role", "operationId":"listPublishedCandidateRoleUsers", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SearchRequest" } } } }, "parameters":[ { "in":"path", "name":"publishedCandidateRoleId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PublishedCandidateRoleListResponse" } } } } }, "x-internal-id":"oiri-api-v1-published-candidate-role-{publishedCandidateRoleId}-users-.search-post", "x-filename-id":"oiri-api-v1-published-candidate-role-publishedcandidateroleid-users-search-post" } }, "/oiri/api/v1/published-candidate-role/.search":{ "post":{ "tags":[ "Published Candidate Role" ], "summary":"List published candidate roles", "operationId":"listPublishedCandidateRoles", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SearchRequest" } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PublishedCandidateRoleListResponse" } } } } }, "x-internal-id":"oiri-api-v1-published-candidate-role-.search-post", "x-filename-id":"oiri-api-v1-published-candidate-role-search-post" } }, "/oiri/api/v1/published-candidate-role/{publishedCandidateRoleId}":{ "get":{ "tags":[ "Published Candidate Role" ], "summary":"Get an existing published candidate role by Id", "operationId":"getPublishedCandidateRole", "parameters":[ { "in":"path", "name":"publishedCandidateRoleId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PublishedCandidateRoleDTO" } } } } }, "x-internal-id":"oiri-api-v1-published-candidate-role-{publishedCandidateRoleId}-get", "x-filename-id":"oiri-api-v1-published-candidate-role-publishedcandidateroleid-get" } }, "/oiri/api/v1/criteria/convert/scimtoui":{ "post":{ "tags":[ "Utility" ], "summary":"SCIM to UI util", "operationId":"scimtoui", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UIToScimResponse" } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UIToScimRequest" } } } } }, "x-internal-id":"oiri-api-v1-criteria-convert-scimtoui-post", "x-filename-id":"oiri-api-v1-criteria-convert-scimtoui-post" } }, "/oiri/api/v1/criteria/convert/uitoscim":{ "post":{ "tags":[ "Utility" ], "summary":"UI to SCIM util", "operationId":"uitoscim", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UIToScimRequest" } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UIToScimResponse" } } } } }, "x-internal-id":"oiri-api-v1-criteria-convert-uitoscim-post", "x-filename-id":"oiri-api-v1-criteria-convert-uitoscim-post" } }, "/oiri/api/v1/resources/counts":{ "get":{ "tags":[ "Utility" ], "summary":"Get counts of all resources", "operationId":"getAllResourcesCounts", "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "properties":{ "StringStringMap":{ "type":"object", "properties":{ "value":{ "type":"string" } } } } } } } } }, "x-internal-id":"oiri-api-v1-resources-counts-get", "x-filename-id":"oiri-api-v1-resources-counts-get" } }, "/oiri/api/v1/task/resources/{resourceType}/category/{categoryType}/.search":{ "post":{ "tags":[ "Task Resources" ], "summary":"Search Resources Based On Category & Criteria", "operationId":"searchResourcesByCategory", "parameters":[ { "in":"path", "name":"categoryType", "required":true, "schema":{ "type":"string", "example":"organization / country / jobCode/ role / manager" } }, { "in":"path", "name":"resourceType", "required":true, "schema":{ "type":"string", "example":"user" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TaskCategorySearchRequest" } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TaskCategorySearchResponse" } } } } }, "x-internal-id":"oiri-api-v1-task-resources-{resourceType}-category-{categoryType}-.search-post", "x-filename-id":"oiri-api-v1-task-resources-resourcetype-category-categorytype-search-post" } }, "/oiri/api/v1/task/resources/{resourcetype}/.search":{ "post":{ "tags":[ "Task Resources" ], "summary":"Search Resources Based On Criteria", "operationId":"searchResources", "parameters":[ { "in":"path", "name":"resourcetype", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceTypeSearchRequest" } } } }, "responses":{ "200":{ "description":"Successful Operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceTypeSearchResponse" } } } } }, "x-internal-id":"oiri-api-v1-task-resources-{resourcetype}-.search-post", "x-filename-id":"oiri-api-v1-task-resources-resourcetype-search-post" } }, "/oiri/api/v1/task/resources/{resourcetype}/count":{ "post":{ "tags":[ "Task Resources" ], "summary":"Task Resources Counts Based On Criteria", "operationId":"getResourceCounts", "parameters":[ { "in":"path", "name":"resourcetype", "required":true, "schema":{ "type":"string", "example":"user/application/entitlement" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceCriteria" } } }, "required":true }, "responses":{ "200":{ "description":"Successful Operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TaskResourceCountsResponse" } } } } }, "x-internal-id":"oiri-api-v1-task-resources-{resourcetype}-count-post", "x-filename-id":"oiri-api-v1-task-resources-resourcetype-count-post" } }, "/api/v1/tasks/{taskId}/users/.search":{ "post":{ "tags":[ "Task Resources" ], "summary":"Task Users search Based On Criteria", "operationId":"searchTaskUsers", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SearchRequest" } } }, "required":true }, "responses":{ "200":{ "description":"Successful Operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GenericListResponse" } } } } }, "x-internal-id":"api-v1-tasks-{taskId}-users-.search-post", "x-filename-id":"api-v1-tasks-taskid-users-search-post" } }, "/api/v1/tasks/{taskId}/entitlements/.search":{ "post":{ "tags":[ "Task Resources" ], "summary":"Task Entitlements search Based On Criteria", "operationId":"searchTaskEntitlements", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SearchRequest" } } }, "required":true }, "responses":{ "200":{ "description":"Successful Operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GenericListResponse" } } } } }, "x-internal-id":"api-v1-tasks-{taskId}-entitlements-.search-post", "x-filename-id":"api-v1-tasks-taskid-entitlements-search-post" } }, "/oiri/api/v1/authenticate/{mode}":{ "post":{ "tags":[ "Authentication" ], "summary":"Authenticate user", "description":"and return user information and JWT token.Additionally when mode is set to session then session ID is returned in a cookie named `JSESSIONID`.", "operationId":"authenticate", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Credentials" } } }, "required":true }, "parameters":[ { "in":"path", "name":"mode", "required":true, "schema":{ "type":"string", "enum":[ "session", "token" ] }, "description":"Mode type: * `session` - On successful user authentication return session ID in a cookie named JSESSIONID * `token` - On successful user authentication return JWT token" } ], "responses":{ "200":{ "description":"Successfully authenticated. If mode in request is session then session ID is returned in a cookie named `JSESSIONID`. You need to include this cookie in subsequent requests. If mode in request is set to token return Token.", "headers":{ "Set-Cookie":{ "schema":{ "type":"string", "example":"JSESSIONID=abcde12345; Path=/; HttpOnly" } } }, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AuthenticationResponse" } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"oiri-api-v1-authenticate-{mode}-post", "x-filename-id":"oiri-api-v1-authenticate-mode-post" } }, "/oiri/api/v1/logout":{ "get":{ "security":[ { "cookieAuth":[ ] } ], "tags":[ "Authentication" ], "summary":"Logout user", "description":"api logs out user by invalidating the `JSESSIONID` cookie.", "operationId":"logout", "responses":{ "200":{ "description":"OK. If response is OK, HTTP status code 200 is returned. Logout operation ends users session.", "headers":{ "Set-Cookie":{ "schema":{ "type":"string", "example":"JSESSIONID=none; Path=/; HttpOnly" } } }, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "message":{ "type":"string" } } } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"oiri-api-v1-logout-get", "x-filename-id":"oiri-api-v1-logout-get" } }, "/oiri/api/v1/sessionInfo":{ "get":{ "security":[ { "cookieAuth":[ ] } ], "tags":[ "Authentication" ], "summary":"Get Session Infomation", "description":"Gets a session information user's name and idleSessionTimeout for the session.", "operationId":"getSessionInfo", "responses":{ "200":{ "description":"OK. If response is OK, HTTP status code 200 is returned.Current user's name and idleSessionTimeout for the session is returned.", "headers":{ "Set-Cookie":{ "schema":{ "type":"string", "example":"JSESSIONID=none; Path=/; HttpOnly" } } }, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SessionInfoResp" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"oiri-api-v1-sessionInfo-get", "x-filename-id":"oiri-api-v1-sessioninfo-get" } }, "/oiri/api/v1/etl/jobs/search":{ "post":{ "tags":[ "ETL Jobs" ], "summary":"ETL job search API", "operationId":"searchEtlJobs", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SearchRequest" } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EtlJobSearchResponse" } } } } }, "x-internal-id":"oiri-api-v1-etl-jobs-search-post", "x-filename-id":"oiri-api-v1-etl-jobs-search-post" } }, "/oiri/api/v1/etl/jobs/{jobId}":{ "get":{ "tags":[ "ETL Jobs" ], "summary":"Get ETL Job By ID", "operationId":"getEtlJobById", "parameters":[ { "in":"path", "name":"jobId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ETLJobDetails" } } } } }, "x-internal-id":"oiri-api-v1-etl-jobs-{jobId}-get", "x-filename-id":"oiri-api-v1-etl-jobs-jobid-get" } }, "/oiri/api/v1/etl/jobs/last-run-status":{ "get":{ "tags":[ "ETL Jobs" ], "summary":"Get Status Details for Last ETL Job Run", "operationId":"getLastEtlJobStatus", "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ETLJobStatusResponse" } } } } }, "x-internal-id":"oiri-api-v1-etl-jobs-last-run-status-get", "x-filename-id":"oiri-api-v1-etl-jobs-last-run-status-get" } }, "/oiri/api/v1/roles/.search":{ "post":{ "tags":[ "Role" ], "summary":"Search role details", "operationId":"searchRoles", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SearchRequest" } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EntityListResponse" } } } } }, "x-internal-id":"oiri-api-v1-roles-.search-post", "x-filename-id":"oiri-api-v1-roles-search-post" } }, "/oiri/api/v1/roles/{roleId}":{ "get":{ "tags":[ "Role" ], "summary":"List role details", "operationId":"getRoleDetailsByRoleId", "parameters":[ { "in":"path", "name":"roleId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RoleDTO" } } } } }, "x-internal-id":"oiri-api-v1-roles-{roleId}-get", "x-filename-id":"oiri-api-v1-roles-roleid-get" } }, "/oiri/api/v1/roles/{roleId}/applications":{ "get":{ "tags":[ "Role" ], "summary":"List applications for a role", "operationId":"listRoleApplications", "parameters":[ { "in":"path", "name":"roleId", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"limit", "schema":{ "default":10, "format":"int32", "type":"integer" } }, { "in":"query", "name":"offset", "schema":{ "default":0, "format":"int32", "type":"integer" } }, { "in":"query", "name":"totalResults", "schema":{ "default":-1, "format":"int32", "type":"integer" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EntityListResponse" } } } } }, "x-internal-id":"oiri-api-v1-roles-{roleId}-applications-get", "x-filename-id":"oiri-api-v1-roles-roleid-applications-get" } }, "/oiri/api/v1/roles/{roleId}/entitlements/.search":{ "post":{ "tags":[ "Role" ], "summary":"List entitlements for a role", "operationId":"listRoleEntitlements", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SearchRequest" } } } }, "parameters":[ { "in":"path", "name":"roleId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EntityListResponse" } } } } }, "x-internal-id":"oiri-api-v1-roles-{roleId}-entitlements-.search-post", "x-filename-id":"oiri-api-v1-roles-roleid-entitlements-search-post" } }, "/oiri/api/v1/roles/{roleId}/users/.search":{ "post":{ "tags":[ "Role" ], "summary":"List user members for a role", "operationId":"listRoleUsers", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SearchRequest" } } } }, "parameters":[ { "in":"path", "name":"roleId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EntityListResponse" } } } } }, "x-internal-id":"oiri-api-v1-roles-{roleId}-users-.search-post", "x-filename-id":"oiri-api-v1-roles-roleid-users-search-post" } }, "/oiri/api/v1/roles/{roleId}/nestedRoles/.search":{ "post":{ "tags":[ "Role" ], "summary":"List nested roles for a role", "operationId":"listNestedRoles", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SearchRequest" } } } }, "parameters":[ { "in":"path", "name":"roleId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EntityListResponse" } } } } }, "x-internal-id":"oiri-api-v1-roles-{roleId}-nestedRoles-.search-post", "x-filename-id":"oiri-api-v1-roles-roleid-nestedroles-search-post" } }, "/oiri/api/v1/users/{userId}":{ "get":{ "tags":[ "User" ], "summary":"List user details for a given userId", "description":"List user details", "operationId":"getUserById", "parameters":[ { "in":"path", "name":"userId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserDetailDTO" } } } } }, "x-internal-id":"oiri-api-v1-users-{userId}-get", "x-filename-id":"oiri-api-v1-users-userid-get" } }, "/oiri/api/v1/users/username/{username}":{ "get":{ "tags":[ "User" ], "summary":"List user details for a given username", "operationId":"getUserByUserName", "parameters":[ { "in":"path", "name":"username", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserDetailDTO" } } } } }, "x-internal-id":"oiri-api-v1-users-username-{username}-get", "x-filename-id":"oiri-api-v1-users-username-username-get" } }, "/oiri/api/v1/users/{userId}/applications":{ "get":{ "tags":[ "User" ], "summary":"List applications assigned to a user", "operationId":"listUserApplications", "parameters":[ { "in":"path", "name":"userId", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"limit", "schema":{ "default":10, "format":"int32", "type":"integer" } }, { "in":"query", "name":"offset", "schema":{ "default":0, "format":"int32", "type":"integer" } }, { "in":"query", "name":"recordCount", "schema":{ "default":-1, "format":"int32", "type":"integer" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EntityListResponse" } } } } }, "x-internal-id":"oiri-api-v1-users-{userId}-applications-get", "x-filename-id":"oiri-api-v1-users-userid-applications-get" } }, "/oiri/api/v1/users/{userId}/entitlements/.search":{ "post":{ "tags":[ "User" ], "summary":"List entitlements assigned to a user", "operationId":"searchAndListUserEntitlements", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SearchRequest" } } } }, "parameters":[ { "in":"path", "name":"userId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EntityListResponse" } } } } }, "x-internal-id":"oiri-api-v1-users-{userId}-entitlements-.search-post", "x-filename-id":"oiri-api-v1-users-userid-entitlements-search-post" } }, "/oiri/api/v1/users/{userId}/roles/.search":{ "post":{ "tags":[ "User" ], "summary":"List roles that are granted to a user", "operationId":"searchAndListUserRoles", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SearchRequest" } } } }, "parameters":[ { "in":"path", "name":"userId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EntityListResponse" } } } } }, "x-internal-id":"oiri-api-v1-users-{userId}-roles-.search-post", "x-filename-id":"oiri-api-v1-users-userid-roles-search-post" } }, "/oiri/api/v1/tasks":{ "post":{ "tags":[ "Role Mining Task" ], "summary":"Create Role Mining Task", "description":"Save for Later :- A job will be created with Status = CREATED, sourceID and sourceName as null", "operationId":"createTask", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RoleMiningRequest" } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JobDetails" } } } } }, "x-internal-id":"oiri-api-v1-tasks-post", "x-filename-id":"oiri-api-v1-tasks-post" } }, "/oiri/api/v1/tasks/.discoverRoles":{ "post":{ "tags":[ "Role Mining Task" ], "summary":"Create And Run Role Mining Task To Discovery Roles", "description":"Create a job with Status=READY, sourceID and sourceName as null.", "operationId":"createAndRunRoleDiscoveryTask", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RoleMiningRequest" } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JobDetails" } } } } }, "x-internal-id":"oiri-api-v1-tasks-.discoverRoles-post", "x-filename-id":"oiri-api-v1-tasks-discoverroles-post" } }, "/oiri/api/v1/tasks/.search":{ "post":{ "tags":[ "Role Mining Task" ], "summary":"Search Role Mining Tasks Based On Criteria", "operationId":"searchTasks", "requestBody":{ "description":"request for role mining tasks search", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SearchRequest" } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RoleMiningJobSearchResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-.search-post", "x-filename-id":"oiri-api-v1-tasks-search-post" } }, "/oiri/api/v1/tasks/names":{ "get":{ "tags":[ "Role Mining Task" ], "summary":"Fetch All Role Mining Parent Task Names", "operationId":"getAllParentTaksnames", "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GenericListResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-names-get", "x-filename-id":"oiri-api-v1-tasks-names-get" } }, "/oiri/api/v1/tasks/{taskId}":{ "get":{ "tags":[ "Role Mining Task" ], "summary":"Get Role Mining task details with taskId", "description":"Retrieve the Role Mining tasks details with taskId.", "operationId":"getTaskById", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JobDetails" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-get", "x-filename-id":"oiri-api-v1-tasks-taskid-get" }, "put":{ "tags":[ "Role Mining Task" ], "summary":"Update Non Executed Role Mining Task.", "description":"Allows Changing the task's name , description , filters and configuration parameters.", "operationId":"updateRoleDiscoveryTask", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RoleMiningRequest" } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JobDetails" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-put", "x-filename-id":"oiri-api-v1-tasks-taskid-put" }, "delete":{ "tags":[ "Role Mining Task" ], "summary":"Delete Role Mining Task", "operationId":"deleteJobById", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK" } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-delete", "x-filename-id":"oiri-api-v1-tasks-taskid-delete" } }, "/oiri/api/v1/tasks/{taskId}/.run":{ "post":{ "tags":[ "Role Mining Task" ], "summary":"Run Role Mining Task To Discovery Roles", "description":"Run job by changing status to READY if in status 'CREATED'", "operationId":"runRoleDiscoveryTaskById", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RoleMiningRequest" } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JobDetails" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-.run-post", "x-filename-id":"oiri-api-v1-tasks-taskid-run-post" } }, "/oiri/api/v1/tasks/{taskId}/result":{ "get":{ "tags":[ "Role Mining Task" ], "summary":"Fetch Role Mining Task Generated Candidate Roles", "operationId":"getTasksResultById", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RoleMiningResult" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-result-get", "x-filename-id":"oiri-api-v1-tasks-taskid-result-get" } }, "/oiri/api/v1/candidate-roles/.search":{ "post":{ "tags":[ "Candidate Role" ], "summary":"Search all candidate roles", "operationId":"SearchAllCandidateRoles", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SearchRequest" } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleListResponse" } } } } }, "x-internal-id":"oiri-api-v1-candidate-roles-.search-post", "x-filename-id":"oiri-api-v1-candidate-roles-search-post" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles":{ "get":{ "tags":[ "Candidate Role" ], "summary":"List candidate roles", "operationId":"listCandidateRoles", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"limit", "schema":{ "default":25, "format":"int32", "type":"integer" } }, { "in":"query", "name":"offset", "schema":{ "default":0, "format":"int32", "type":"integer" } }, { "in":"query", "name":"sortBy", "schema":{ "default":"createdDate", "type":"string" } }, { "in":"query", "name":"sortOrder", "schema":{ "default":"DESC", "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleListResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-get", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-get" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/list-by-status":{ "get":{ "tags":[ "Candidate Role" ], "summary":"List candidate roles for a job id by status", "operationId":"listCandidateRolesByStatus", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleListByStatusResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-list-by-status-get", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-list-status-get" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/users-entitlement-coverage":{ "get":{ "tags":[ "Candidate Role" ], "summary":"List candidate rolewise users entitlement coverage for the given run", "operationId":"listCandidateRolesUsersEntitlementCoverage", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"topCount", "schema":{ "default":1000, "format":"int32", "type":"integer" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UsersEntitlementCoverageListResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-users-entitlement-coverage-get", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-users-entitlement-coverage-get" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/entitlement-frequency":{ "get":{ "tags":[ "Candidate Role" ], "summary":"List candidate rolewise entitlement frequency for the given run", "operationId":"listCandidateRolesEntitlementFrequency", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"topCount", "schema":{ "default":1000, "format":"int32", "type":"integer" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EntitlementFrequencyListResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-entitlement-frequency-get", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-entitlement-frequency-get" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/entitlements-user-coverage":{ "get":{ "tags":[ "Candidate Role" ], "summary":"List candidate rolewise entitlements user coverage for the given run", "operationId":"listCandidateRolesEntitlementsUserCoverage", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"topCount", "schema":{ "default":1000, "format":"int32", "type":"integer" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EntitlementsUserCoverageListResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-entitlements-user-coverage-get", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-entitlements-user-coverage-get" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/refine-coverage":{ "post":{ "tags":[ "Candidate Role" ], "summary":"Refine candidate roles for a task id", "operationId":"refineCandidateRoles", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GlobalRefineCoverageRequest" } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "type":"integer" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-refine-coverage-post", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-refine-coverage-post" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/refine-coverage":{ "post":{ "tags":[ "Candidate Role" ], "summary":"Refine candidate roles for a task id", "operationId":"refineCandidateRoleCoverage", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GlobalRefineCoverageRequest" } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "type":"integer" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-refine-coverage-post", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-refine-coverage-post" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/discard":{ "post":{ "tags":[ "Candidate Role" ], "summary":"Discard a candidate role", "operationId":"discardCandidateRole", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleDTO" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-discard-post", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-discard-post" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/restore":{ "post":{ "tags":[ "Candidate Role" ], "summary":"Restore discarded candidate role", "operationId":"restoreCandidateRoles", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleDTO" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-restore-post", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-restore-post" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}":{ "get":{ "tags":[ "Candidate Role" ], "summary":"Get an existing candidate role by Id", "operationId":"getCandidateRoleDetailsbyCandidateRoleId", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleDTO" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-get", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-get" }, "patch":{ "tags":[ "Candidate Role" ], "summary":"Update candidate roles", "operationId":"updateCandidateRole", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"patch request for role mining tasks - candidate roles", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleUpdateRequest" } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleDTO" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-patch", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-patch" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/export":{ "get":{ "tags":[ "Candidate Role" ], "summary":"Export all the candidate roles for the given candidateRoleId", "operationId":"exportCandidateRoleDetails", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/octet-stream":{ "schema":{ "type":"string", "format":"binary" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-export-get", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-export-get" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/users/.search":{ "post":{ "tags":[ "Candidate Role" ], "summary":"List users for a candidate role", "operationId":"listCandidateRoleUsers", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SearchRequest" } } } }, "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleListResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-users-.search-post", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-users-search-post" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/deleted-users":{ "get":{ "tags":[ "Candidate Role" ], "summary":"List deleted users of a candidate role", "operationId":"listCandidateRoleDeletedUsers", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"limit", "schema":{ "default":10, "format":"int32", "type":"integer" } }, { "in":"query", "name":"offset", "schema":{ "default":0, "format":"int32", "type":"integer" } }, { "in":"query", "name":"sortBy", "schema":{ "default":"userName", "type":"string" } }, { "in":"query", "name":"sortOrder", "schema":{ "default":"ASC", "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleUserResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-deleted-users-get", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-deleted-users-get" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/users/.delete":{ "post":{ "tags":[ "Candidate Role" ], "summary":"Bulk delete users in a candidate role", "operationId":"bulkDeleteUsersFromCandidateRole", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BulkRequest" } } } }, "responses":{ "204":{ "description":"OK", "content":{ "application/json":{ "schema":{ "type":"string" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-users-.delete-post", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-users-delete-post" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/users/.recover-deleted":{ "post":{ "tags":[ "Candidate Role" ], "summary":"Bulk recover deleted users in a candidate role", "operationId":"bulkRecoverDeletedUsersFromCandidateRole", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BulkRequest" } } } }, "responses":{ "204":{ "description":"OK", "content":{ "application/json":{ "schema":{ "type":"string" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-users-.recover-deleted-post", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-users-recover-deleted-post" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/applications":{ "get":{ "tags":[ "Candidate Role" ], "summary":"List applications for a candidate role", "operationId":"listCandidateRoleApplications", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"limit", "schema":{ "default":10, "format":"int32", "type":"integer" } }, { "in":"query", "name":"offset", "schema":{ "default":0, "format":"int32", "type":"integer" } }, { "in":"query", "name":"sortBy", "schema":{ "default":"applicationName", "type":"string" } }, { "in":"query", "name":"sortOrder", "schema":{ "default":"ASC", "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleApplicationResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-applications-get", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-applications-get" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/entitlements/.search":{ "post":{ "tags":[ "Candidate Role" ], "summary":"List entitlements for a candidate role", "operationId":"listCandidateRoleEntitlements", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SearchRequest" } } } }, "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleListResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-entitlements-.search-post", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-entitlements-search-post" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/entitlements/.delete":{ "post":{ "tags":[ "Candidate Role" ], "summary":"Bulk delete entitlements in a candidate role", "operationId":"bulkDeleteEntitlementsFromCandidateRole", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BulkRequest" } } } }, "responses":{ "204":{ "description":"OK", "content":{ "application/json":{ "schema":{ "type":"string" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-entitlements-.delete-post", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-entitlements-delete-post" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/entitlements/.recover-deleted":{ "post":{ "tags":[ "Candidate Role" ], "summary":"Bulk recover deleted entitlements in a candidate role", "operationId":"bulkRecoverDeletedEntitlementsFromCandidateRole", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BulkRequest" } } } }, "responses":{ "204":{ "description":"OK", "content":{ "application/json":{ "schema":{ "type":"string" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-entitlements-.recover-deleted-post", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-entitlements-recover-deleted-post" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/deleted-entitlements":{ "get":{ "tags":[ "Candidate Role" ], "summary":"List deleted entitlements of a candidate role", "operationId":"listCandidateRoleDeletedEntitlements", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"limit", "schema":{ "default":10, "format":"int32", "type":"integer" } }, { "in":"query", "name":"offset", "schema":{ "default":0, "format":"int32", "type":"integer" } }, { "in":"query", "name":"sortBy", "schema":{ "default":"entitlementDisplayName", "type":"string" } }, { "in":"query", "name":"sortOrder", "schema":{ "default":"ASC", "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleEntitlementResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-deleted-entitlements-get", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-deleted-entitlements-get" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/misaligned-users":{ "get":{ "tags":[ "Candidate Role" ], "summary":"List misaligned users in a candidate role", "operationId":"listCandidateRoleMisalignedUsers", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SearchRequest" } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleUserResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-misaligned-users-get", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-misaligned-users-get" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/misaligned-users/{userId}/entitlements":{ "get":{ "tags":[ "Candidate Role" ], "summary":"List candidate roles misaligned user entitlements", "operationId":"listCandidateRoleMisalignedUserEntitlements", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"userId", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"limit", "schema":{ "default":25, "format":"int32", "type":"integer" } }, { "in":"query", "name":"offset", "schema":{ "default":0, "format":"int32", "type":"integer" } }, { "in":"query", "name":"sortBy", "schema":{ "default":"userName", "type":"string" } }, { "in":"query", "name":"sortOrder", "schema":{ "default":"ASC", "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleEntitlementResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-misaligned-users-{userId}-entitlements-get", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-misaligned-users-userid-entitlements-get" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/misaligned-entitlements":{ "get":{ "tags":[ "Candidate Role" ], "summary":"List misaligned entitlements in a candidate role", "operationId":"listCandidateRoleMisalignedEntitlements", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SearchRequest" } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleEntitlementResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-misaligned-entitlements-get", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-misaligned-entitlements-get" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/misaligned-entitlements/{entitlementId}/users":{ "get":{ "tags":[ "Candidate Role" ], "summary":"List candidate roles misaligned entitlement users", "operationId":"listCandidateRoleMisalignedEntitlementUsers", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"entitlementId", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"limit", "schema":{ "default":25, "format":"int32", "type":"integer" } }, { "in":"query", "name":"offset", "schema":{ "default":0, "format":"int32", "type":"integer" } }, { "in":"query", "name":"sortBy", "schema":{ "default":"entitlementDisplayName", "type":"string" } }, { "in":"query", "name":"sortOrder", "schema":{ "default":"ASC", "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleUserResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-misaligned-entitlements-{entitlementId}-users-get", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-misaligned-entitlements-entitlementid-users-get" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/similar-roles":{ "get":{ "tags":[ "Candidate Role" ], "summary":"List similar roles with candidate roles coverage", "operationId":"listSimilarRoles", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"topCount", "schema":{ "default":1000, "format":"int32", "type":"integer" } }, { "in":"query", "name":"entitlementThreshold", "schema":{ "default":50, "format":"float", "type":"integer" } }, { "in":"query", "name":"userThreshold", "schema":{ "default":50, "format":"float", "type":"integer" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SimilarRoleListResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-similar-roles-get", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-similar-roles-get" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/similar-roles/{roleId}/users":{ "get":{ "tags":[ "Candidate Role" ], "summary":"For a given candidate role get similar Role Detail for users with mode as common/candidate_role_only/role_only", "operationId":"getSimilarRoleDetailForUser", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"roleId", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"limit", "schema":{ "default":10, "format":"int32", "type":"integer" } }, { "in":"query", "name":"mode", "schema":{ "default":"common", "type":"string" } }, { "in":"query", "name":"offset", "schema":{ "default":0, "format":"int32", "type":"integer" } }, { "in":"query", "name":"totalResults", "schema":{ "default":-1, "format":"int32", "type":"integer" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SimilarRoleUserDetailResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-similar-roles-{roleId}-users-get", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-similar-roles-roleid-users-get" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/similar-roles/{roleId}/entitlements":{ "get":{ "tags":[ "Candidate Role" ], "summary":"For a given candidate role get similar Role Detail for entitlements with mode as common/candidate_role_only/role_only", "operationId":"getSimilarRoleDetailForEntitlement", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"roleId", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"limit", "schema":{ "default":10, "format":"int32", "type":"integer" } }, { "in":"query", "name":"mode", "schema":{ "default":"common", "type":"string" } }, { "in":"query", "name":"offset", "schema":{ "default":0, "format":"int32", "type":"integer" } }, { "in":"query", "name":"totalResults", "schema":{ "default":-1, "format":"int32", "type":"integer" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SimilarRoleEntitlementDetailResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-similar-roles-{roleId}-entitlements-get", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-similar-roles-roleid-entitlements-get" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/users-entitlement-assignment":{ "get":{ "tags":[ "Candidate Role" ], "summary":"List of users with entitlement assignment detail for a candidate role", "operationId":"listCandidateRoleUsersEntitlementAssignment", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"maxEntitlementCount", "schema":{ "default":500, "format":"int32", "type":"integer" } }, { "in":"query", "name":"maxUserCount", "schema":{ "default":1000, "format":"int32", "type":"integer" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleUsersEntitlementAssignmentListResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-users-entitlement-assignment-get", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-users-entitlement-assignment-get" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/user-attribute-analytics":{ "post":{ "tags":[ "Candidate Role" ], "summary":"Get a candidate role user attributes analytics for the given user attributes", "operationId":"getUserAttributeAnalytics", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleUserAttributeAnalyticsRequest" } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CandidateRoleUserAttributeAnalyticsResponse" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-user-attribute-analytics-post", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-user-attribute-analytics-post" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/publish-oig":{ "post":{ "tags":[ "Candidate Role" ], "summary":"Publish the candidate role in Oracle Identity Governance", "operationId":"publishCandidateRole", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"includeMembers", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RolePublishResult" } } } }, "400":{ "description":"Bad Request" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-publish-oig-post", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-publish-oig-post" } }, "/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/publish-offline":{ "post":{ "tags":[ "Candidate Role" ], "summary":"Publish and export the candidate role to file", "description":"Publish the candidate role and export the candidate role to file", "operationId":"publishAndExportCandidateRole", "parameters":[ { "in":"path", "name":"taskId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"candidateRoleId", "required":true, "schema":{ "type":"string" } }, { "in":"query", "name":"includeMembers", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/octet-stream":{ "schema":{ "type":"string", "format":"binary" } } } } }, "x-internal-id":"oiri-api-v1-tasks-{taskId}-candidate-roles-{candidateRoleId}-publish-offline-post", "x-filename-id":"oiri-api-v1-tasks-taskid-candidate-roles-candidateroleid-publish-offline-post" } }, "/stats/connectionpools":{ "get":{ "tags":[ "Utility" ], "summary":"Get database connection pool stats", "operationId":"getConnectionPoolStats", "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "properties":{ "oii-db-connection-pool":{ "$ref":"#/components/schemas/connectionPoolStats" }, "oii-db-mining-connection-pool":{ "$ref":"#/components/schemas/connectionPoolStats" } } } } } } }, "x-internal-id":"stats-connectionpools-get", "x-filename-id":"stats-connectionpools-get" } }, "/oiri/api/v1/entitlements/convert/idToDetails":{ "get":{ "tags":[ "Utility" ], "summary":"Get entitlement details", "description":"Get List of entitlement details for the given list of entitlement names.", "operationId":"getEntitlementDetails", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "type":"string" } } } } }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/EntitlementDTO" } } } } } }, "x-internal-id":"oiri-api-v1-entitlements-convert-idToDetails-get", "x-filename-id":"oiri-api-v1-entitlements-convert-idtodetails-get" } } }, "components":{ "securitySchemes":{ "cookieAuth":{ "type":"apiKey", "in":"cookie", "name":"JSESSIONID" } }, "schemas":{ "Criteria":{ "properties":{ "type":{ "type":"string" }, "filter":{ "type":"string" } } }, "RoleMiningRequest":{ "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "candidateRolePrefix":{ "type":"string" }, "criteria":{ "type":"array", "items":{ "$ref":"#/components/schemas/Criteria" } }, "candidateRoleCountIndicator":{ "type":"integer" } } }, "JobDetails":{ "properties":{ "id":{ "type":"string" }, "sourceId":{ "type":"string" }, "sourceName":{ "type":"string" }, "name":{ "type":"string" }, "description":{ "type":"string" }, "type":{ "type":"string" }, "status":{ "type":"string" }, "message":{ "type":"string" }, "createdDate":{ "type":"string" }, "createdBy":{ "type":"string" }, "lastUpdatedDate":{ "type":"string" }, "startedDate":{ "type":"string" }, "finishedData":{ "type":"string" }, "input":{ "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "candidateRolePrefix":{ "type":"string" }, "criteria":{ "type":"array", "items":{ "$ref":"#/components/schemas/Criteria" } }, "candidateRoleCountIndicator":{ "type":"integer" } }, "type":"object" }, "output":{ "type":"string" } } }, "SearchRequest":{ "properties":{ "page":{ "required":[ "offset", "limit" ], "properties":{ "offset":{ "type":"number" }, "limit":{ "type":"number" } }, "type":"object" }, "sort":{ "required":[ "sortBy", "sortOrder" ], "properties":{ "sortBy":{ "type":"string" }, "sortOrder":{ "type":"string" } }, "type":"object" }, "searchFilters":{ "type":"string" }, "recordCount":{ "type":"integer" } } }, "RoleMiningJobSearchResponse":{ "properties":{ "recordCount":{ "type":"number" }, "jobs":{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "description":{ "type":"string" }, "type":{ "type":"string" }, "status":{ "type":"string" }, "createdDate":{ "type":"string" }, "createdBy":{ "type":"string" }, "lastUpdatedDate":{ "type":"string" }, "startedDate":{ "type":"string" }, "finishedData":{ "type":"string" }, "input":{ "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "candidateRolePrefix":{ "type":"string" }, "criteria":{ "type":"array", "items":{ "$ref":"#/components/schemas/Criteria" } }, "candidateRoleCountIndicator":{ "type":"integer" } }, "type":"object" }, "output":{ "required":[ "jobId", "status", "candidateRoles" ], "properties":{ "jobId":{ "type":"string" }, "status":{ "type":"string" }, "candidateRoles":{ "type":"array", "items":{ "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "jobId":{ "type":"string" }, "clusterId":{ "type":"number" }, "userCoverage":{ "type":"integer" }, "entitlementCoverage":{ "type":"integer" }, "userCount":{ "type":"number" }, "entitlementCount":{ "type":"number" }, "applicationCount":{ "type":"number" }, "totalUserCount":{ "type":"number" }, "totalEntCount":{ "type":"number" }, "misalignedUserCount":{ "type":"number" }, "misalignedEntCount":{ "type":"number" }, "roleSimilarity":{ "type":"string" }, "confidence":{ "type":"number" } } } } }, "type":"object" } } } }, "limit":{ "type":"number" }, "offset":{ "type":"number" }, "count":{ "type":"number" }, "hasMore":{ "type":"boolean" } } }, "TaskResourceCountsResponse":{ "properties":{ "type":{ "type":"string" }, "totalCount":{ "type":"number" }, "filteredCount":{ "type":"number" } } }, "TaskCategorySearchRequest":{ "properties":{ "criteria":{ "type":"array", "items":{ "$ref":"#/components/schemas/Criteria" } }, "categoryFilter":{ "type":"string" }, "pagination":{ "required":[ "offset", "limit" ], "properties":{ "offset":{ "type":"number" }, "limit":{ "type":"number" } }, "type":"object" } } }, "TaskCategorySearchResponse":{ "properties":{ "categoryType":{ "type":"string" }, "limit":{ "type":"number" }, "offset":{ "type":"number" }, "count":{ "type":"number" }, "totalCount":{ "type":"number" }, "results":{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "children":{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" } } } } } } } } }, "ResourceCriteria":{ "properties":{ "criteria":{ "type":"array", "items":{ "$ref":"#/components/schemas/Criteria" } } } }, "ResourceTypeSearchRequest":{ "properties":{ "criteria":{ "type":"array", "items":{ "$ref":"#/components/schemas/Criteria" } }, "pagination":{ "required":[ "offset", "limit" ], "type":"object", "properties":{ "offset":{ "type":"string" }, "limit":{ "type":"string" } } }, "returnAttributes":{ "type":"array", "items":{ "type":"string" } } } }, "ResourceTypeSearchResponse":{ "properties":{ "resource":{ "properties":{ "type":{ "type":"string" }, "results":{ "type":"array", "items":{ "type":"object", "properties":{ "userLogin":{ "type":"string" }, "displayName":{ "type":"string" }, "organization":{ "type":"string" }, "id":{ "type":"string" } } } } }, "type":"object" }, "totalCount":{ "type":"number" }, "limit":{ "type":"number" }, "offset":{ "type":"number" }, "count":{ "type":"number" } } }, "RoleMiningResult":{ "properties":{ "jobId":{ "type":"string" }, "status":{ "type":"string" }, "candidateRoles":{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "description":{ "type":"string" }, "jobId":{ "type":"string" }, "clusterId":{ "type":"number" }, "status":{ "type":"string" }, "publishedState":{ "type":"string" }, "userCoverage":{ "type":"integer" }, "entitlementCoverage":{ "type":"integer" }, "userCount":{ "type":"number" }, "entitlementCount":{ "type":"number" }, "applicationCount":{ "type":"number" }, "totalUserCount":{ "type":"number" }, "totalEntCount":{ "type":"number" }, "misalignedUserCount":{ "type":"number" }, "misalignedEntCount":{ "type":"number" }, "roleSimilarity":{ "type":"string" }, "confidence":{ "type":"number" }, "createdDate":{ "type":"string" }, "createdBy":{ "type":"string" }, "lastModifiedDate":{ "type":"string" } } } }, "clusterConfig":{ "type":"object", "properties":{ "similarAssignmentCount":{ "type":"integer" }, "numberOfClusters":{ "type":"integer" }, "numberOfIterations":{ "type":"integer" }, "userCoveragePercentage":{ "type":"integer" }, "entitlementCoveragePercentage":{ "type":"integer" } } } } }, "Result":{ "properties":{ "id":{ "type":"integer" }, "name":{ "type":"string" }, "description":{ "type":"string" }, "createdOn":{ "type":"string" }, "modifiedOn":{ "type":"string" }, "userCount":{ "type":"integer" }, "applicationCount":{ "type":"integer" }, "entitlementCount":{ "type":"integer" }, "misAlignedUserCount":{ "type":"integer" }, "misAlignedEntitlementCount":{ "type":"integer" }, "status":{ "type":"string" }, "candidateRoleId":{ "type":"string" } } }, "CandidateRole":{ "properties":{ "id":{ "type":"string" }, "label":{ "type":"integer" }, "children":{ "type":"array", "items":{ "$ref":"#/components/schemas/Result" } } } }, "CandidateRoleDTO":{ "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "description":{ "type":"string" }, "jobId":{ "type":"string" }, "clusterId":{ "type":"integer" }, "status":{ "type":"string" }, "userCount":{ "type":"integer" }, "entitlementCount":{ "type":"integer" }, "applicationCount":{ "type":"integer" }, "totalUserCount":{ "type":"integer" }, "totalEntitlementCount":{ "type":"integer" }, "misAlignedUserCount":{ "type":"integer" }, "misAlignedEntitlementCount":{ "type":"integer" }, "userCoverage":{ "type":"integer" }, "entitlementCoverage":{ "type":"integer" }, "confidence":{ "type":"number" }, "createdDate":{ "type":"string" }, "createdBy":{ "type":"string" }, "lastModifiedDate":{ "type":"string" } } }, "CandidateRoleUpdateRequest":{ "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "description":{ "type":"string" } } }, "CandidateRoleUserResponse":{ "properties":{ "recordCount":{ "type":"integer" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/UserDTO" } } } }, "CandidateRoleEntitlementResponse":{ "properties":{ "recordCount":{ "type":"integer" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/EntitlementDTO" } } } }, "CandidateRoleApplicationResponse":{ "properties":{ "recordCount":{ "type":"integer" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/ApplicationDTO" } } } }, "CandidateRoleListResponse":{ "properties":{ "recordCount":{ "type":"integer" }, "candidateRoles":{ "type":"array", "items":{ "$ref":"#/components/schemas/CandidateRoleDTO" } } } }, "CandidateRoleListByStatusResponse":{ "properties":{ "jobName":{ "type":"string" }, "totalEntitlementCount":{ "type":"integer" }, "totalUserCount":{ "type":"integer" }, "totalCandidateRoleCount":{ "type":"integer" }, "candidateRoles":{ "type":"array", "items":{ "$ref":"#/components/schemas/CandidateRole" } } } }, "UserDTO":{ "properties":{ "userKey":{ "type":"string" }, "userName":{ "type":"string" }, "employeeType":{ "type":"string" }, "jobCode":{ "type":"string" }, "managerName":{ "type":"string" }, "organizationName":{ "type":"string" }, "usage":{ "type":"number" }, "userDisplayName":{ "type":"string" }, "managerDisplayName":{ "type":"string" }, "employeeNumber":{ "type":"string" }, "departmentNumber":{ "type":"string" }, "misalignedCount":{ "type":"integer" }, "customAttributes":{ "properties":{ "map":{ "type":"object", "properties":{ "value":{ "type":"string" } } } } } } }, "ApplicationDTO":{ "properties":{ "applicationKey":{ "type":"string" }, "applicationId":{ "type":"string" }, "applicationName":{ "type":"string" }, "applicationDisplayName":{ "type":"string" }, "applicationDescription":{ "type":"string" }, "applicationType":{ "type":"string" } } }, "EntitlementDTO":{ "properties":{ "entitlementKey":{ "type":"string" }, "entitlementDisplayName":{ "type":"string" }, "applicationName":{ "type":"string" }, "usage":{ "type":"number" }, "misalignedCount":{ "type":"integer" } } }, "EntitlementFrequencyDTO":{ "properties":{ "id":{ "type":"integer" }, "clusterId":{ "type":"integer" }, "candidateRoleId":{ "type":"string" }, "candidateRoleName":{ "type":"string" }, "entitlementId":{ "type":"string" }, "entitlementDisplayName":{ "type":"string" }, "frequency":{ "type":"integer" }, "entitlementSerialNumber":{ "type":"integer" } } }, "EntitlementFrequencyListResponse":{ "properties":{ "topCount":{ "type":"integer" }, "entitlementFrequencyList":{ "type":"array", "items":{ "$ref":"#/components/schemas/EntitlementFrequencyDTO" } } } }, "UsersEntitlementCoverageDTO":{ "properties":{ "clusterId":{ "type":"integer" }, "candidateRoleId":{ "type":"string" }, "candidateRoleName":{ "type":"string" }, "userSerialNumber":{ "type":"integer" }, "userId":{ "type":"string" }, "userDisplayName":{ "type":"string" }, "coveragePercentage":{ "type":"number" } } }, "UsersEntitlementCoverageListResponse":{ "properties":{ "topCount":{ "type":"integer" }, "usersEntitlementCoverageList":{ "type":"array", "items":{ "$ref":"#/components/schemas/UsersEntitlementCoverageDTO" } } } }, "EntitlementsUserCoverageDTO":{ "properties":{ "clusterId":{ "type":"integer" }, "candidateRoleId":{ "type":"string" }, "candidateRoleName":{ "type":"string" }, "entitlementSerialNumber":{ "type":"integer" }, "entitlementId":{ "type":"string" }, "entitlementDisplayName":{ "type":"string" }, "coveragePercentage":{ "type":"number" } } }, "EntitlementsUserCoverageListResponse":{ "properties":{ "topCount":{ "type":"integer" }, "entitlementsUserCoverageList":{ "type":"array", "items":{ "$ref":"#/components/schemas/EntitlementsUserCoverageDTO" } } } }, "SimilarRoleListResponse":{ "properties":{ "recordCount":{ "type":"integer" }, "similarRoles":{ "type":"array", "items":{ "$ref":"#/components/schemas/SimilarRoleDTO" } } } }, "EntityListResponse":{ "properties":{ "limit":{ "type":"integer" }, "offset":{ "type":"integer" }, "recordCount":{ "type":"number" }, "count":{ "type":"number" }, "hasMore":{ "type":"boolean" }, "items":{ "type":"array", "items":{ "type":"object" } } } }, "RoleDTO":{ "properties":{ "roleId":{ "type":"string" }, "roleName":{ "type":"string" }, "roleDisplayName":{ "type":"string" }, "roleDescription":{ "type":"string" }, "riskScore":{ "type":"integer" }, "parentRoleName":{ "type":"array", "items":{ "type":"string" } } } }, "SimilarRoleDTO":{ "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "displayName":{ "type":"string" }, "description":{ "type":"string" }, "entitlementCount":{ "type":"integer" }, "userCount":{ "type":"integer" }, "entitlementCoverage":{ "type":"number" }, "userCoverage":{ "type":"number" } } }, "SimilarRoleEntitlementDetailResponse":{ "properties":{ "totalResults":{ "type":"integer" }, "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/SimilarRoleDetailEntitlementDTO" } } } }, "SimilarRoleUserDetailResponse":{ "properties":{ "totalResults":{ "type":"integer" }, "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/SimilarRoleDetailUserDTO" } } } }, "SimilarRoleDetailEntitlementDTO":{ "properties":{ "entitlementId":{ "type":"string" }, "entitlementDisplayName":{ "type":"string" }, "applicationId":{ "type":"string" }, "applicationDisplayName":{ "type":"string" } } }, "SimilarRoleDetailUserDTO":{ "properties":{ "userKey":{ "type":"string" }, "userName":{ "type":"string" }, "employeeType":{ "type":"string" }, "jobCode":{ "type":"string" }, "managerName":{ "type":"string" }, "organizationName":{ "type":"string" }, "userDisplayName":{ "type":"string" }, "managerDisplayName":{ "type":"string" }, "employeeNumber":{ "type":"string" }, "departmentNumber":{ "type":"string" } } }, "AnalyticResult":{ "properties":{ "displayName":{ "type":"string" }, "percentage":{ "type":"integer" } } }, "AnalyticResults":{ "properties":{ "userAttributeName":{ "type":"string" }, "totalCount":{ "type":"integer" }, "results":{ "type":"array", "items":{ "$ref":"#/components/schemas/AnalyticResult" } } } }, "CandidateRoleUserAttributeAnalyticsRequest":{ "properties":{ "topCount":{ "type":"integer" }, "userAttributeNames":{ "type":"array", "items":{ "type":"string" } } } }, "CandidateRoleUserAttributeAnalyticsResponse":{ "properties":{ "topCount":{ "type":"integer" }, "analyticResults":{ "type":"array", "items":{ "$ref":"#/components/schemas/AnalyticResults" } } } }, "CandidateRoleUsersEntitlementAssignmentListResponse":{ "properties":{ "entitlementNames":{ "type":"array", "items":{ "type":"string" } }, "userDisplayNameWithFullCoverage":{ "type":"array", "items":{ "type":"string" } }, "usersPartialCoverageEntitlementAssignmentList":{ "type":"array", "items":{ "$ref":"#/components/schemas/CandidateRoleUsersEntitlementAssignmentDTO" } }, "maxUserCount":{ "type":"integer" }, "maxEntitlementCount":{ "type":"integer" } } }, "CandidateRoleUsersEntitlementAssignmentDTO":{ "properties":{ "userId":{ "type":"string" }, "userDisplayName":{ "type":"string" }, "assignmentFlag":{ "type":"array", "items":{ "type":"integer" } } } }, "connectionPoolStats":{ "properties":{ "successfulAffinityBasedBorrowCount":{ "type":"number" }, "failedAffinityBasedBorrowCount":{ "type":"number" }, "successfulRCLBBasedBorrowCount":{ "type":"number" }, "failedRCLBBasedBorrowCount":{ "type":"number" }, "fcfprocessingInfo":{ "type":"string" }, "fcfprocessingInfoProcessedOnly":{ "type":"string" }, "connectionRepurposeCount":{ "type":"number" }, "connectionsCreatedCount":{ "type":"number" }, "connectionsClosedCount":{ "type":"number" }, "totalConnectionsCount":{ "type":"number" }, "abandonedConnectionsCount":{ "type":"number" }, "pendingRequestsCount":{ "type":"number" }, "cumulativeConnectionReturnedCount":{ "type":"number" }, "cumulativeSuccessfulConnectionWaitCount":{ "type":"number" }, "cumulativeFailedConnectionWaitCount":{ "type":"number" }, "cumulativeSuccessfulConnectionWaitTime":{ "type":"number" }, "cumulativeFailedConnectionWaitTime":{ "type":"number" }, "cumulativeConnectionBorrowedCount":{ "type":"number" }, "peakConnectionWaitTime":{ "type":"number" }, "cumulativeConnectionUseTime":{ "type":"number" }, "peakConnectionsCount":{ "type":"number" }, "averageBorrowedConnectionsCount":{ "type":"number" }, "remainingPoolCapacityCount":{ "type":"number" }, "labeledConnectionsCount":{ "type":"number" }, "averageConnectionWaitTime":{ "type":"number" }, "cumulativeConnectionWaitTime":{ "type":"number" }, "availableConnectionsCount":{ "type":"number" }, "borrowedConnectionsCount":{ "type":"number" } }, "type":"object" }, "PublishedCandidateRoleListResponse":{ "properties":{ "limit":{ "type":"integer" }, "offset":{ "type":"integer" }, "recordCount":{ "type":"number" }, "count":{ "type":"number" }, "hasMore":{ "type":"boolean" }, "items":{ "type":"array", "items":{ "type":"object" } } } }, "PublishedCandidateRoleDTO":{ "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "description":{ "type":"string" }, "jobId":{ "type":"string" }, "clusterId":{ "type":"string" }, "candidateRoleId":{ "type":"string" }, "status":{ "type":"string" }, "requestKey":{ "type":"string" }, "userCount":{ "type":"string" }, "entitlementCount":{ "type":"string" }, "applicationCount":{ "type":"string" }, "userCoverage":{ "type":"integer" }, "entitlementCoverage":{ "type":"integer" } } }, "PublishedCandidateRoleApplicationResponse":{ "properties":{ "recordCount":{ "type":"integer" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/ApplicationDTO" } } } }, "UIToScimRequest":{ "properties":{ "user":{ "type":"array", "items":{ "$ref":"#/components/schemas/UIToScimCondition" } }, "application":{ "type":"array", "items":{ "type":"string" } }, "entitlement":{ "type":"array", "items":{ "type":"string" } }, "categoryFilter":{ "type":"object", "properties":{ "type":{ "type":"string" }, "attributes":{ "type":"array", "items":{ "type":"string" } }, "categoryValue":{ "type":"string" } } } } }, "UIToScimCondition":{ "properties":{ "attribute":{ "type":"string" }, "operator":{ "type":"string" }, "entitlement":{ "type":"array", "items":{ "type":"string" } } } }, "UIToScimResponse":{ "properties":{ "user":{ "type":"string" }, "application":{ "type":"string" }, "entitlement":{ "type":"string" } } }, "RolePublishingResult":{ "properties":{ "jobId":{ "type":"string" }, "status":{ "type":"string" }, "roleMiningJobId":{ "type":"string" }, "publishedRoleRequestMap":{ "properties":{ "map":{ "type":"object", "properties":{ "value":{ "type":"array", "items":{ "type":"string" } } } } } } } }, "AuthenticationResponse":{ "properties":{ "authenticated":{ "type":"boolean" }, "user":{ "$ref":"#/components/schemas/User" }, "token":{ "$ref":"#/components/schemas/Token" } } }, "User":{ "properties":{ "userLogin":{ "type":"string" }, "firstName":{ "type":"string" }, "lastName":{ "type":"string" }, "email":{ "type":"string" }, "status":{ "type":"boolean" }, "roles":{ "type":"array", "items":{ "type":"string" } } } }, "Token":{ "properties":{ "expiresIn":{ "type":"string" }, "tokenType":{ "type":"string" }, "accessToken":{ "type":"string" } } }, "Error":{ "type":"object", "properties":{ "code":{ "type":"string" }, "message":{ "type":"string" } }, "required":[ "code", "message" ] }, "EtlJobSearchResponse":{ "properties":{ "recordCount":{ "type":"number" }, "jobs":{ "type":"array", "items":{ "$ref":"#/components/schemas/ETLJobDetails" } } } }, "Credentials":{ "properties":{ "username":{ "type":"string" }, "password":{ "type":"string" } } }, "SessionInfoResp":{ "properties":{ "name":{ "type":"string" }, "idleSessionTimeoutInMinutes":{ "type":"integer" } } }, "ETLJobStatusResponse":{ "properties":{ "lastEtlJobStatus":{ "type":"string" }, "recentEtlJobStatus":{ "type":"string" } } }, "ETLJobDetails":{ "properties":{ "id":{ "type":"string" }, "sourceId":{ "type":"string" }, "sourceName":{ "type":"string" }, "name":{ "type":"string" }, "description":{ "type":"string" }, "type":{ "type":"string" }, "status":{ "type":"string" }, "message":{ "type":"string" }, "createdDate":{ "type":"string" }, "createdBy":{ "type":"string" }, "lastUpdatedDate":{ "type":"string" }, "startedDate":{ "type":"string" }, "finishedData":{ "type":"string" }, "input":{ "properties":{ "version":{ "type":"string" }, "walletDirectory":{ "type":"string" }, "toBeDeletedOigDataDirectory":{ "type":"string" }, "toBeDeletedFileDataDirectory":{ "type":"string" }, "sparkMode":{ "type":"string" }, "databaseConfiguration":{ "type":"object", "properties":{ "url":{ "type":"string" }, "driver":{ "type":"string" }, "queryTimeout":{ "type":"integer" }, "fetchSize":{ "type":"integer" } } }, "sparkConfiguration":{ "type":"object", "properties":{ "masterUrl":{ "type":"string" }, "maxResultSize":{ "type":"string" }, "eventLogOverwrite":{ "type":"boolean" }, "eventLogEnabled":{ "type":"boolean" }, "executorMemory":{ "type":"string" }, "serializer":{ "type":"string" }, "eventLogPath":{ "type":"string" } } }, "globalEtlConfiguration":{ "type":"object", "properties":{ "organizationPathSplitSize":{ "type":"integer" }, "maxOrganizationsInPath":{ "type":"integer" }, "recordsCountInDryRunSummary":{ "type":"integer" }, "validationFailureThresholdLimit":{ "type":"integer" } } }, "sparkK8sConfiguration":{ "type":"object", "properties":{ "master":{ "type":"string" }, "namespace":{ "type":"string" }, "containerImage":{ "type":"string" }, "executorInstances":{ "type":"integer" }, "imagePullPolicy":{ "type":"string" }, "imagePullSecret":{ "type":"string" }, "fileUploadPath":{ "type":"string" }, "k8sCaCertFile":{ "type":"string" }, "serviceAccountName":{ "type":"string" }, "driverPvcPath":{ "type":"string" }, "driverPvcName":{ "type":"string" }, "executorPvcPath":{ "type":"string" }, "executorPvcName":{ "type":"string" }, "driverRequestCores":{ "type":"string" }, "driverLimitCores":{ "type":"string" }, "executorRequestCores":{ "type":"string" }, "executorLimitCores":{ "type":"string" }, "driverMemory":{ "type":"string" }, "executorMemory":{ "type":"string" }, "driverMemoryOverhead":{ "type":"string" }, "executorMemoryOverhead":{ "type":"string" } } }, "sources":{ "type":"object", "properties":{ "flatFile":{ "type":"object", "properties":{ "enabled":{ "type":"boolean" }, "version":{ "type":"string" }, "format":{ "type":"string" }, "option":{ "type":"object", "properties":{ "sep":{ "type":"string" }, "timestampFormat":{ "type":"string" } } } } }, "oracleIdentityGovernance":{ "type":"object", "properties":{ "enabled":{ "type":"boolean" }, "version":{ "type":"string" }, "format":{ "type":"string" }, "option":{ "type":"object", "properties":{ "url":{ "type":"string" }, "driver":{ "type":"string" }, "queryTimeout":{ "type":"integer" }, "fetchSize":{ "type":"integer" } } } } } } }, "entities":{ "type":"array", "items":{ "$ref":"#/components/schemas/ETLEntity" } } } }, "output":{ "type":"array", "items":{ "$ref":"#/components/schemas/ETLResult" } } } }, "ETLResult":{ "properties":{ "source":{ "type":"string" }, "processingTime":{ "type":"integer" }, "entities":{ "type":"array", "items":{ "$ref":"#/components/schemas/ETLEntityResult" } } } }, "ETLEntityResult":{ "properties":{ "entityType":{ "type":"string" }, "processingTime":{ "type":"integer" }, "details":{ "type":"object" }, "additionalDetails":{ "type":"object" } } }, "ETLEntity":{ "properties":{ "name":{ "type":"string" }, "enabled":{ "type":"boolean" }, "syncMode":{ "type":"string" }, "oracleIdentityGovernancePartitionColumn":{ "type":"string" }, "flatFilePartitionColumn":{ "type":"string" }, "lowerBound":{ "type":"integer" }, "upperBound":{ "type":"integer" }, "numPartitions":{ "type":"integer" }, "fileBasePath":{ "type":"string" }, "batchSize":{ "type":"integer" } } }, "RolePublishResult":{ "properties":{ "accessPolicyId":{ "type":"string" }, "roleRequestId":{ "type":"string" } } }, "BulkRequest":{ "properties":{ "ids":{ "type":"array", "items":{ "type":"string" } } } }, "GlobalRefineCoverageRequest":{ "properties":{ "userCoverage":{ "type":"integer" }, "entitlementCoverage":{ "type":"integer" } } }, "GenericListResponse":{ "properties":{ "limit":{ "type":"integer" }, "offset":{ "type":"integer" }, "recordCount":{ "type":"integer" }, "count":{ "type":"integer" }, "hasMore":{ "type":"boolean" }, "items":{ "type":"array", "items":{ "type":"object" } } } }, "UserDetailDTO":{ "properties":{ "userKey":{ "type":"string" }, "userName":{ "type":"string" }, "employeeType":{ "type":"string" }, "jobCode":{ "type":"string" }, "managerName":{ "type":"string" }, "organizationName":{ "type":"string" }, "usage":{ "type":"number" }, "userDisplayName":{ "type":"string" }, "managerDisplayName":{ "type":"string" }, "employeeNumber":{ "type":"string" }, "departmentNumber":{ "type":"string" }, "firstName":{ "type":"string" }, "lastName":{ "type":"string" }, "middleName":{ "type":"string" }, "fullName":{ "type":"string" }, "title":{ "type":"string" }, "status":{ "type":"string" }, "workEmail":{ "type":"string" }, "homeEmail":{ "type":"string" }, "language":{ "type":"string" }, "locale":{ "type":"string" }, "country":{ "type":"string" }, "state":{ "type":"string" }, "territory":{ "type":"string" }, "postalCode":{ "type":"string" }, "description":{ "type":"string" }, "officeName":{ "type":"string" }, "customAttributes":{ "properties":{ "map":{ "type":"object", "properties":{ "value":{ "type":"string" } } } } } } } } } }