Rest API Documentation

REST API Documentation for Group user, application /webconsole Version: 4.2.1.2

Endpoints (DRAFT)

POST /rest/api/users/add-subordinate

Add subordinate to given user

Query Params:

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

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/users/add-superior

Add supervisor to given user

Query Params:

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

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/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

POST /rest/api/users/entitlements/addUserToGroup

User Entitlements API doc, Add User to given Group

Query Params:

• groupId [{'type': 'string'}]:
• userId [{'type': 'string'}]:
• rights[][{'type': 'array', 'items': {'type': 'string'}}]:
• startDate [{'type': 'string'}]:
• endDate [{'type': 'string'}]:
• description [{'type': 'string'}]:
• update [{'type': 'boolean', 'default': False}]:

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/users/entitlements/addUserToOrganization

User Entitlements API doc, Add User to given Organization

Query Params:

• organizationId [{'type': 'string'}]:
• userId [{'type': 'string'}]:
• startDate [{'type': 'string'}]:
• endDate [{'type': 'string'}]:
• rights[][{'type': 'array', 'items': {'type': 'string'}}]:
• update [{'type': 'boolean', 'default': False}]:

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/users/entitlements/addUserToResource

User Entitlements API doc, Add User to given Resource

Query Params:

• resourceId [{'type': 'string'}]:
• userId [{'type': 'string'}]:
• rights[][{'type': 'array', 'items': {'type': 'string'}}]:
• startDate [{'type': 'string'}]:
• endDate [{'type': 'string'}]:
• description [{'type': 'string'}]:
• update [{'type': 'boolean', 'default': False}]:

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/users/entitlements/addUserToRole

User Entitlements API doc, Add Role to given User

Query Params:

• roleId [{'type': 'string'}]:
• userId [{'type': 'string'}]:
• rights[][{'type': 'array', 'items': {'type': 'string'}}]:
• startDate [{'type': 'string'}]:
• endDate [{'type': 'string'}]:
• description [{'type': 'string'}]:
• update [{'type': 'boolean', 'default': False}]:

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/users/entitlements/removeUserFromGroup

User Entitlements API doc, Delete User from given Group

Query Params:

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

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/users/entitlements/removeUserFromOrganization

User Entitlements API doc, Delete User from given Organization

Query Params:

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

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

DELETE /rest/api/users/entitlements/removeUserFromResource/(userId)/(resourceId)

User Entitlements API doc, Delete User from given Resource

Path Params:

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

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

DELETE /rest/api/users/entitlements/removeUserFromRole/(userId)/(roleId)

User Entitlements API doc, Remove Role from given User

Path Params:

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

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/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

POST /rest/api/users/remove-subordinate

Remove subordinate from user

Query Params:

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

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/users/remove-superior

Remove supervisor from user

Query Params:

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

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/users/replace-subordinate

Replace subordinate from srcSubordinateId to subordinateId

Query Params:

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

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/users/replace-superior

Replace superior from srcSupervisorId to supervisorId

Query Params:

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

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/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