/webconsole - role

Rest API Documentation

REST API Documentation for Group role, application /webconsole Version: 4.2.1.3

Endpoints (DRAFT)

POST /rest/api/roles/addChildRole

Role Api, Add child role to given role

Query Params:

  • roleId [{'type': 'string'}]:
  • childRoleId [{'type': 'string'}]:
  • rights[][{'type': 'array', 'items': {'type': 'string'}}]:
  • startDate [{'type': 'string'}]:
  • endDate [{'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/roles/addGroupToRole

Role Api, Entitle Role and Group with given ids, time range and rights

Query Params:

  • roleId [{'type': 'string'}]:
  • groupId [{'type': 'string'}]:
  • rights[][{'type': 'array', 'items': {'type': 'string'}}]:
  • startDate [{'type': 'string'}]:
  • endDate [{'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/roles/clone

Role Api, Clone role

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

Role Api

Query Params:

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

Responses:

  • Status Code: 200 OK.

    Content-type: /,

    Schema: /components/schemas/BasicAjaxResponse

DELETE /rest/api/roles/removeChildRole/(roleId)/(childRoleId)

Role Api, Remove Child Role by Id

Path Params:

  • roleId [{'type': 'string'}]:
  • childRoleId [{'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/roles/removeGroupFromRole

Role Api

Query Params:

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

Responses:

  • Status Code: 200 OK.

    Content-type: /,

    Schema: /components/schemas/BasicAjaxResponse

DELETE /rest/api/roles/removeGroupFromRole/(roleId)/(groupId)

Role Api, Dis-entitle Role and Group with given ids

Path Params:

  • roleId [{'type': 'string'}]:
  • groupId [{'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/roles/save

Role Api, Save role

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

Role Api, Search roles by given parameters

Query Params:

  • name [{'type': 'string'}]:
  • managedSysIds [{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]:
  • metadataTypeId [{'type': 'string'}]:
  • size [{'type': 'integer', 'format': 'int32'}]:
  • from [{'type': 'integer', 'format': 'int32'}]:
  • sortBy [{'type': 'string'}]:
  • orderBy [{'type': 'string'}]:
  • forCertification [{'type': 'boolean'}]:

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

DELETE /rest/api/roles/(id)

Role Api, Delete role by Id

Path Params:

  • id [{'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/roles/(id)

Role Api, Get role by Id

Path Params:

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

Responses:

  • Status Code: 200 Success.

    Content-type: application/json,

    Schema: /components/schemas/Role

  • Status Code: 500 Failure.

    Content-type: application/json

GET /rest/api/roles/(id)/children

Role Api, Get children for given role

Query Params:

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

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/roles/(id)/groups

Role Api, Get groups for given role

Query Params:

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

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/roles/(id)/organizations

Role Api, Get organizations linked with given role according filtering

Query Params:

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

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/roles/(id)/parents

Role Api, Get parents for given role

Query Params:

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

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/roles/(id)/resources

Role Api, Get resources for given role

Query Params:

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

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/roles/(id)/users

Role Api, Get users for given role

Query Params:

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

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## Definitions