Rest API Documentation

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

Endpoints (DRAFT)

POST /rest/api/policy/deleteAttributePolicy

Policy Management API doc, Remove policy attribute

Query 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

POST /rest/api/policy/deleteAuthenticationPolicy

Policy Management API doc, Delete authentication policy

Query 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

POST /rest/api/policy/deletePasswordPolicy

Policy Management API doc, Delete Password policy

Query 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/policy/get/(id)

Policy Management API doc, Get Policy by Id

Query Params:

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

Path Params:

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

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/Policy

• Status Code: 500 Failure.

  Content-type: application/json

GET /rest/api/policy/getPasswordAttributes

Policy Management API doc, Get Password policy Attributes

Query Params:

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

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/PolicyAttributesModel

GET /rest/api/policy/new

Policy Management API doc, New Policy Creation

Query Params:

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

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/Policy

POST /rest/api/policy/save-password-dictionary

Policy Management API doc

Query Params:

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

Body Params:

• {'content': {'application/json': {'schema': {'type': 'object', 'properties': {'file': {'type': 'string', 'format': 'binary'}}}}}} Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/policy/saveAttributePolicy

Policy Management API doc, Save policy attribute

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

Policy Management API doc, Save authentication 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

POST /rest/api/policy/savePasswordPolicy

Policy Management API doc, Save Password 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/policy/search

policy-search-restful-controller

Query Params:

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

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/PolicySearchResultBean

DELETE /rest/api/policy/(id)

Policy Management API doc, Delete policy

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