Rest API Documentation

REST API Documentation for Group auth-provider, application /webconsole Version: 4.2.1.3

Endpoints (DRAFT)

GET /rest/api/authprovider/amAttributeList

Authentication Provider API REST Operations, Get all AmAttributes

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/authprovider/attribute/delete

Authentication Provider API REST Operations

Query Params:

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

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/authprovider/attribute/save

Authentication Provider API REST Operations, Save attribute for provider

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/authprovider/attribute/(id)

Authentication Provider API REST Operations, Delete attribute for provider

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

Authentication Provider API REST Operations, Get all attribute types

Responses:

• Status Code: 200 Success.

  Content-type: application/json

• Status Code: 500 Failure.

  Content-type: application/json

POST /rest/api/authprovider/authentication-provider-with-ca-cert

Authentication Provider API REST Operations, Save auth provider with CA cert

Query Params:

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

Body Params:

• {'content': {'application/json': {'schema': {'type': 'object', 'properties': {'caCert': {'type': 'string', 'format': 'binary'}}}}}} 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/authprovider/delete

Authentication Provider API REST Operations

Query Params:

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

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BasicAjaxResponse

GET /rest/api/authprovider/get/(id)

Authentication Provider API REST Operations, Get AuthProvider by id

Path Params:

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

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/AuthProvider

• Status Code: 404 Not Found.

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/AuthProvider

POST /rest/api/authprovider/save

Authentication Provider API REST Operations, Save auth provider

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

Authentication Provider API REST Operations, Search auth providers

Query Params:

• name [{'type': 'string'}]:
• managedSysId [{'type': 'string'}]:
• 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

DELETE /rest/api/authprovider/(id)

Authentication Provider API REST Operations, Delete auth provider

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

POST /rest/api/authprovider/(id)/attributes

Authentication Provider API REST Operations, Get attributes by auth provider id

Path Params:

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

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 404 Not Found.

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse## Definitions