Rest API Documentation

REST API Documentation for Group idp-rest, application /idp Version: 4.2.1.2

Endpoints (DRAFT)

GET /rest/api/auditlog/exportLogs

Audit Logs Rest API, Export audit logs to CSV

Query Params:

• fromDate [{'type': 'integer', 'format': 'int64'}]:
• toDate [{'type': 'integer', 'format': 'int64'}]:
• offset [{'type': 'integer', 'format': 'int32'}]:
• doPurge [{'type': 'boolean'}]:
• actions[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]:
• result [{'type': 'string'}]:
• showChildren [{'type': 'boolean'}]:
• targetManagedSystems[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]:
• targetOrganizations[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]:
• targetResources[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]:
• targetGroups[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]:
• targetRoles[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]:
• targetUsers[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]:

Responses:

• Status Code: 200 Success.

  Content-type: text/csv

• Status Code: 404 Not Found.

• Status Code: 500 Failure.

GET /rest/api/auditlog/findLogs

Audit Logs Rest API, Find Audit logs by search params

Query Params:

• userId [{'type': 'string'}]: Requester User Id.

• fromDate [{'type': 'integer', 'format': 'int64'}]: Limit result by time from the bottom. The value is the number of milliseconds from the beginning of epoch .

• toDate [{'type': 'integer', 'format': 'int64'}]: Limit result by time from the top. The value is the number of milliseconds from the beginning of epoch .

• from [{'type': 'integer', 'format': 'int32'}]: Offset of the search results.

• size [{'type': 'integer', 'format': 'int32'}]: Size of the results page.

• offset [{'type': 'integer', 'format': 'int32'}]: Timezone offset in offset minutes.

• actions[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]: The array of actions for search filter.

• result [{'type': 'string'}]: The Result (SUCCESS/FAILURE) for search filter.

• clientIP [{'type': 'string'}]: The Ip Addresses of requesters for search filter.

• showChildren [{'type': 'boolean'}]: If 'false' will be shown only audit logs with empty parentId, otherwise all entities satisfied search filters.

• allActions [{'type': 'boolean'}]: If 'true' userId param will be used as a target user as a requester Id. .

• targetManagedSystems[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]: Set Of target Managed System Ids.

• targetOrganizations[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]: Set Of target Organization Ids.

• targetResources[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]: Set Of target Resource Ids.

• targetGroups[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]: Set of target Group Ids.

• targetRoles[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]: Set of target Role Ids.

• targetUsers[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]: Set of target User Ids.

• authProviderId [{'type': 'string'}]: Id of target Authentication Provider (for example for OAuth authorization).

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/auth/logout

Logout user

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/auth/public/login

Authenticate User against OpenIAM

Path Params:

• returnType [{'type': 'string'}]: Body Params:

• {'content': {'application/json': {'schema': {'$ref': '#/components/schemas/OpenIAMLoginToken'}}}, 'required': True} Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/LoginAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/LoginAjaxResponse

POST /rest/api/auth/public/login/(returnType)

Authenticate User against OpenIAM

Path Params:

• returnType [{'type': 'string'}]: Body Params:

• {'content': {'application/json': {'schema': {'$ref': '#/components/schemas/OpenIAMLoginToken'}}}, 'required': True} Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/LoginAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/LoginAjaxResponse

GET /rest/api/itpolicy/

IT Policy Content API Doc, Get IT Policy

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

GET /rest/api/managedsys/get/(id)

Managed System API doc, Get managed system by Id

Path Params:

• id [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/managedsys/policyMaps

Managed System API doc, Search managed system policies map with attribute map by filters

Query Params:

• id [{'type': 'string'}]:
• connectorId [{'type': 'string'}]:
• name [{'type': 'string'}]:
• type [{'type': 'string'}]:
• objectType [{'type': 'string'}]:
• from [{'type': 'integer', 'format': 'int32'}]:
• size [{'type': 'integer', 'format': 'int32'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/managedsys/search

Managed System API doc, Search managed system by filters

Query Params:

• name [{'type': 'string'}]:
• isManual [{'type': 'boolean'}]:
• size [{'type': 'integer', 'format': 'int32'}]:
• from [{'type': 'integer', 'format': 'int32'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

POST /rest/api/orphans/delete-orphans

Orphan Management API Doc, Deletes selected orphans from idm or idm and target system

Query Params:

• deleteFromTarget [{'type': 'boolean'}]:

Body Params:

• {'content': {'application/json': {'schema': {'type': 'array', 'items': {'$ref': '#/components/schemas/Orphan'}}}}, 'required': True} Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/orphans/orphan-search

Orphan Management API Doc, Search Orphan by user model. AND search mode will be used

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/TreeGridResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/TreeGridResponse

POST /rest/api/orphans/orphans-link

Orphan Management API Doc, Link of orphans to user

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/prov/saveUser

User Provisioning API Rest Operations, Update or Create User

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/prov/template/user

User Provisioning API Rest Operations, Save user from template page

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/users/applications

User Management API Doc, Get All System Applications

Query Params:

• ignoreUser [{'type': 'boolean'}]:
• from [{'type': 'integer', 'format': 'int32'}]:
• size [{'type': 'integer', 'format': 'int32'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/users/attributeList

User Management API Doc, Get All possible Account Statuses

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/users/employeeTypes

User Management API Doc, Get All possible Employee Types

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/users/getAllSuperiors

User Management API Doc, Get All users that are supervisors (have subordinates)

Query Params:

• size [{'type': 'integer', 'format': 'int32'}]:
• from [{'type': 'integer', 'format': 'int32'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/users/jobCodes

User Management API Doc, Get All possible Job Codes

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/users/search

User Management API Doc, Search User by searchTerm

Query Params:

• searchTerm [{'type': 'string'}]:
• checkEmailVisibility [{'type': 'boolean'}]:
• from [{'type': 'integer', 'format': 'int32'}]:
• size [{'type': 'integer', 'format': 'int32'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

POST /rest/api/users/search

User Management API Doc, Search User by model

Query Params:

• deepCopy [{'type': 'boolean'}]:

Body Params:

• {'content': {'application/json': {'schema': {'$ref': '#/components/schemas/UserSearchModel'}}}, 'required': True} Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/users/search/metadata

User Management API Doc, Get configured list of search fields. 'org.openiam.ui.user.search.result.columns' property will be used

Responses:

• Status Code: 200 Success.

  Content-type: application/json

• Status Code: 500 Failure.

  Content-type: application/json

POST /rest/api/users/searchSubordinates

User Management API Doc, Get List of users that could be potentials subordinates (ignoring loops and self-assigment)

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

POST /rest/api/users/searchSuperiors

User Management API Doc, Get List of users that could be potentials supervisors (ignoring loops and self-assigment)

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/users/superior-types

User Management API Doc, Get Supervisor Types

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/users/userSecondaryStatuses

User Management API Doc, Get All possible Account Statuses

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/users/userStatuses

User Management API Doc, Get All possible User statuses

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/users/userTypes

User Management API Doc, Get All possible User Types

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/users/(userId)/groups

User Management API Doc, Get Groups for given user

Query Params:

• size [{'type': 'integer', 'format': 'int32'}]:
• from [{'type': 'integer', 'format': 'int32'}]:
• deepFlag [{'type': 'boolean', 'default': False}]:
• sortBy [{'type': 'string'}]:
• orderBy [{'type': 'string'}]:

Path Params:

• userId [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/users/(userId)/organizations

User Management API Doc, Get Organizations for given user

Query Params:

• size [{'type': 'integer', 'format': 'int32'}]:
• from [{'type': 'integer', 'format': 'int32'}]:
• sortBy [{'type': 'string'}]:
• orderBy [{'type': 'string'}]:

Path Params:

• userId [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/users/(userId)/resources

User Management API Doc, Get Resources for given user

Query Params:

• size [{'type': 'integer', 'format': 'int32'}]:
• from [{'type': 'integer', 'format': 'int32'}]:
• ignoreMenus [{'type': 'boolean'}]:
• ignoreWorkflow [{'type': 'boolean'}]:
• sortBy [{'type': 'string'}]:
• orderBy [{'type': 'string'}]:

Path Params:

• userId [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/users/(userId)/roles

User Management API Doc, Get Roles for given user

Query Params:

• size [{'type': 'integer', 'format': 'int32'}]:
• from [{'type': 'integer', 'format': 'int32'}]:
• deepFlag [{'type': 'boolean', 'default': False}]:
• sortBy [{'type': 'string'}]:
• orderBy [{'type': 'string'}]:

Path Params:

• userId [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/users/(userId)/subordinates

User Management API Doc, Get All Subordinates for given users (not only direct)

Query Params:

• size [{'type': 'integer', 'format': 'int32'}]:
• from [{'type': 'integer', 'format': 'int32'}]:

Path Params:

• userId [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/users/(userId)/subordinates/direct

User Management API Doc, Get Directs Subordinates for given users

Path Params:

• userId [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/users/(userId)/superiors

User Management API Doc, Get Supervisors for given users

Query Params:

• size [{'type': 'integer', 'format': 'int32'}]:
• from [{'type': 'integer', 'format': 'int32'}]:

Path Params:

• userId [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse## Definitions