/webconsole - group

Rest API Documentation

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

Endpoints (DRAFT)

POST /rest/api/groups/addChildGroup

Group API doc

Query Params:

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

Responses:

  • Status Code: 200 OK.

    Content-type: /,

    Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/groups/removeChildGroup

Group API doc

Query Params:

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

Responses:

  • Status Code: 200 OK.

    Content-type: /,

    Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/groups/save

Group API doc

Responses:

  • Status Code: 200 OK.

    Content-type: /,

    Schema: /components/schemas/BasicAjaxResponse

GET /rest/api/groups/search

Group API doc, Search groups by given filter

Query Params:

  • name [{'type': 'string'}]:
  • managedSysIds [{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]:
  • ownerId [{'type': 'string'}]:
  • size [{'type': 'integer', 'format': 'int32'}]:
  • from [{'type': 'integer', 'format': 'int32'}]:
  • attributeName [{'type': 'string'}]:
  • attributeValue [{'type': 'string'}]:
  • 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

POST /rest/api/groups/startGroupBulkOperation

Group API doc

Responses:

  • Status Code: 200 OK.

    Content-type: /,

    Schema: /components/schemas/BasicAjaxResponse

DELETE /rest/api/groups/(groupId)

Group API doc

Path Params:

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

Responses:

  • Status Code: 200 OK.

    Content-type: /,

    Schema: /components/schemas/BasicAjaxResponse

GET /rest/api/groups/(groupId)

Group API doc, Get group for given id

Path Params:

  • groupId [{'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/groups/(groupId)/children

Group API doc, Get All children for given group

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:

  • groupId [{'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/groups/(groupId)/organizations

Group API doc, Get All organization for given group

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:

  • groupId [{'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/groups/(groupId)/resources

Group API doc, Get All resources for given group

Query Params:

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

Path Params:

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

Group API doc, Get All roles for given group

Query Params:

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

Path Params:

  • groupId [{'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/groups/(groupId)/users

Group API doc, Get All users for given group

Query Params:

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

Path Params:

  • groupId [{'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