REST APIs for Oracle Identity Role Intelligence

All REST Endpoints

Authentication

Authentication API's

Authenticate user: Method: post
Path: /oiri/api/v1/authenticate/{mode}
Get Session Infomation: Method: get
Path: /oiri/api/v1/sessionInfo
Logout user: Method: get
Path: /oiri/api/v1/logout

Candidate Role

Candidate Role API's

Bulk delete entitlements in a candidate role: Method: post
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/entitlements/.delete
Bulk delete users in a candidate role: Method: post
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/users/.delete
Bulk recover deleted entitlements in a candidate role: Method: post
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/entitlements/.recover-deleted
Bulk recover deleted users in a candidate role: Method: post
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/users/.recover-deleted
Discard a candidate role: Method: post
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/discard
Export all the candidate roles for the given candidateRoleId: Method: get
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/export
For a given candidate role get similar Role Detail for entitlements with mode as common/candidate_role_only/role_only: Method: get
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/similar-roles/{roleId}/entitlements
For a given candidate role get similar Role Detail for users with mode as common/candidate_role_only/role_only: Method: get
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/similar-roles/{roleId}/users
Get a candidate role user attributes analytics for the given user attributes: Method: post
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/user-attribute-analytics
Get an existing candidate role by Id: Method: get
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}
List applications for a candidate role: Method: get
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/applications
List candidate roles: Method: get
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles
List candidate roles for a job id by status: Method: get
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/list-by-status
List candidate roles misaligned entitlement users: Method: get
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/misaligned-entitlements/{entitlementId}/users
List candidate roles misaligned user entitlements: Method: get
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/misaligned-users/{userId}/entitlements
List candidate rolewise entitlement frequency for the given run: Method: get
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/entitlement-frequency
List candidate rolewise entitlements user coverage for the given run: Method: get
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/entitlements-user-coverage
List candidate rolewise users entitlement coverage for the given run: Method: get
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/users-entitlement-coverage
List deleted entitlements of a candidate role: Method: get
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/deleted-entitlements
List deleted users of a candidate role: Method: get
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/deleted-users
List entitlements for a candidate role: Method: post
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/entitlements/.search
List misaligned entitlements in a candidate role: Method: get
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/misaligned-entitlements
List misaligned users in a candidate role: Method: get
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/misaligned-users
List of users with entitlement assignment detail for a candidate role: Method: get
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/users-entitlement-assignment
List similar roles with candidate roles coverage: Method: get
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/similar-roles
List users for a candidate role: Method: post
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/users/.search
Publish and export the candidate role to file: Method: post
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/publish-offline
Publish the candidate role in Oracle Identity Governance: Method: post
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/publish-oig
Refine candidate roles for a task id: Method: post
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/refine-coverage
Refine candidate roles for a task id: Method: post
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/refine-coverage
Restore discarded candidate role: Method: post
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/restore
Search all candidate roles: Method: post
Path: /oiri/api/v1/candidate-roles/.search
Update candidate roles: Method: patch
Path: /oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}

ETL Jobs

ETL jobs API's

ETL job search API: Method: post
Path: /oiri/api/v1/etl/jobs/search
Get ETL Job By ID: Method: get
Path: /oiri/api/v1/etl/jobs/{jobId}
Get Status Details for Last ETL Job Run: Method: get
Path: /oiri/api/v1/etl/jobs/last-run-status

Published Candidate Role

published candidate role API's

Get an existing published candidate role by Id: Method: get
Path: /oiri/api/v1/published-candidate-role/{publishedCandidateRoleId}
List applications for a published candidate role: Method: get
Path: /oiri/api/v1/published-candidate-role/{publishedCandidateRoleId}/applications
List entitlements for a published candidate role: Method: post
Path: /oiri/api/v1/published-candidate-role/{publishedCandidateRoleId}/entitlements/.search
List published candidate roles: Method: post
Path: /oiri/api/v1/published-candidate-role/.search
List users for a published candidate role: Method: post
Path: /oiri/api/v1/published-candidate-role/{publishedCandidateRoleId}/users/.search

Role

Role API's

List applications for a role: Method: get
Path: /oiri/api/v1/roles/{roleId}/applications
List entitlements for a role: Method: post
Path: /oiri/api/v1/roles/{roleId}/entitlements/.search
List nested roles for a role: Method: post
Path: /oiri/api/v1/roles/{roleId}/nestedRoles/.search
List role details: Method: get
Path: /oiri/api/v1/roles/{roleId}
List user members for a role: Method: post
Path: /oiri/api/v1/roles/{roleId}/users/.search
Search role details: Method: post
Path: /oiri/api/v1/roles/.search

Role Mining Task

CRUD API's for Role Mining Task

Create And Run Role Mining Task To Discovery Roles: Method: post
Path: /oiri/api/v1/tasks/.discoverRoles
Create Role Mining Task: Method: post
Path: /oiri/api/v1/tasks
Delete Role Mining Task: Method: delete
Path: /oiri/api/v1/tasks/{taskId}
Fetch All Role Mining Parent Task Names: Method: get
Path: /oiri/api/v1/tasks/names
Fetch Role Mining Task Generated Candidate Roles: Method: get
Path: /oiri/api/v1/tasks/{taskId}/result
Get Role Mining task details with taskId: Method: get
Path: /oiri/api/v1/tasks/{taskId}
Run Role Mining Task To Discovery Roles: Method: post
Path: /oiri/api/v1/tasks/{taskId}/.run
Search Role Mining Tasks Based On Criteria: Method: post
Path: /oiri/api/v1/tasks/.search
Update Non Executed Role Mining Task.: Method: put
Path: /oiri/api/v1/tasks/{taskId}

Task Resources

Task Resources API's

Search Resources Based On Category & Criteria: Method: post
Path: /oiri/api/v1/task/resources/{resourceType}/category/{categoryType}/.search
Search Resources Based On Criteria: Method: post
Path: /oiri/api/v1/task/resources/{resourcetype}/.search
Task Entitlements search Based On Criteria: Method: post
Path: /api/v1/tasks/{taskId}/entitlements/.search
Task Resources Counts Based On Criteria: Method: post
Path: /oiri/api/v1/task/resources/{resourcetype}/count
Task Users search Based On Criteria: Method: post
Path: /api/v1/tasks/{taskId}/users/.search

User

The operations from the User category.

List applications assigned to a user: Method: get
Path: /oiri/api/v1/users/{userId}/applications
List entitlements assigned to a user: Method: post
Path: /oiri/api/v1/users/{userId}/entitlements/.search
List roles that are granted to a user: Method: post
Path: /oiri/api/v1/users/{userId}/roles/.search
List user details for a given userId: Method: get
Path: /oiri/api/v1/users/{userId}
List user details for a given username: Method: get
Path: /oiri/api/v1/users/username/{username}

Utility

Utility API's

Get counts of all resources: Method: get
Path: /oiri/api/v1/resources/counts
Get database connection pool stats: Method: get
Path: /stats/connectionpools
Get entitlement details: Method: get
Path: /oiri/api/v1/entitlements/convert/idToDetails
Get entity metadata: Method: get
Path: /oiri/api/v1/entity/{entityType}/attributes
SCIM to UI util: Method: post
Path: /oiri/api/v1/criteria/convert/scimtoui
UI to SCIM util: Method: post
Path: /oiri/api/v1/criteria/convert/uitoscim