Rest API Documentation

REST API Documentation for Group access-certification, application /webconsole Version: 4.2.1.3

Endpoints (DRAFT)

GET /rest/api/access-certifications

Access Certification API doc, Get all Access Certifications

Query Params:

• name [{'type': 'string'}]:
• size [{'type': 'integer', 'format': 'int32'}]:
• from [{'type': 'integer', 'format': 'int32'}]:
• sortBy [{'type': 'string'}]:
• orderBy [{'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

POST /rest/api/access-certifications

Access Certification API doc, Save Access Certification

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/access-certifications/all-entitlements-by-app

Access Certification API doc

Query Params:

• appId [{'type': 'string'}]:
• name [{'type': 'string'}]:
• risk [{'type': 'string'}]:

Responses:

• Status Code: 200 OK.

  Content-type: /

GET /rest/api/access-certifications/get-md-types

Access Certification API doc

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BeanResponse

POST /rest/api/access-certifications/preview-entitlements-by-application

Access Certification API doc

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BeanResponse

POST /rest/api/access-certifications/preview-groups-by-application

Access Certification API doc

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BeanResponse

POST /rest/api/access-certifications/preview-roles-by-application

Access Certification API doc

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BeanResponse

POST /rest/api/access-certifications/preview-users-by-application

Access Certification API doc

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BeanResponse

GET /rest/api/access-certifications/target-users

Access Certification API doc, Export users to CSV

Query Params:

• targetIds[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]:
• typeId [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: text/csv

• Status Code: 404 Not Found.

  Content-type: text/csv

• Status Code: 500 Failure.

  Content-type: text/csv

POST /rest/api/access-certifications/upload

Access Certification API doc

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BasicAjaxResponse

GET /rest/api/access-certifications/(access-certification-id)

Access Certification API doc, Get Access Certification by Id

Path Params:

• access-certification-id [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/AccessCertification

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/AccessCertification

POST /rest/api/access-certifications/(access-certification-id)

Access Certification API doc, Execute Access Certification

Path Params:

• access-certification-id [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/AccessCertification

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/AccessCertification

GET /rest/api/access-certifications/(access-certification-id)/stats

Access Certification API doc, Get All stats

Query Params:

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

Path Params:

• access-certification-id [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/AccessCertificationChartsBean

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/AccessCertificationChartsBean

GET /rest/api/access-certifications/(access-certification-id)/stats/(campaign-id)

Access Certification API doc, Get stats for selected campaign

Query Params:

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

Path Params:

• access-certification-id [{'type': 'string'}]:
• campaign-id [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/AccessCertificationChartsBean

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/AccessCertificationChartsBean

DELETE /rest/api/access-certifications/(id)

Access Certification API doc, Remove Access Certification

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