Security schemes API Resource

Abstract class for REST webservices

POST /admin/securityschemes

Add security scheme.

Example of request: 7 *

{"description":"scheme description","name":"scheme name"}

Try it out!

Request Body
media type data type description
application/json SecuritySchemeTO (JSON) The specification of security scheme that has to be added.
Response Body
media type data type description
application/json HdcSuccessWithId (JSON) JSON Response with information, whether the adding has or has not been succeeded.

PUT /admin/securityschemes

Add security scheme.

Example of request: 7 *

{"description":"scheme description","name":"scheme name"}

Try it out!

Request Body
media type data type description
application/json SecuritySchemeTO (JSON) The specification of security scheme that has to be added.
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information, whether the adding has or has not been succeeded.

GET /securityschemes/json

Get list of security schemes

Try it out!

Response Body
media type data type description
application/json object (JSON) JSON Response with list of security schemes

Example of response:

{"list":[{"id":"1","description":"first scheme defined, to be used as default one","name":"general scheme", "color":"#FFFFFF"}]}

GET /admin/securityschemes/json

Get list of security schemes

Try it out!

Response Body
media type data type description
application/json object (JSON) JSON Response with list of security schemes

Example of response:

{"list":[{"id":"1","description":"first scheme defined, to be used as default one","name":"general scheme","color":"#FFFFFF"}]}

DELETE /admin/securityschemes/{securitySchemeId}

Delete security scheme

Try it out!

Request Parameters
name type description default constraints
securitySchemeId path ID of securityScheme   long
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information, whether the deleting has or has not been succeeded.

GET /admin/securityschemes/json/{securitySchemeId}

Get list of permissions for given security scheme

Try it out!

Request Parameters
name type description default constraints
securitySchemeId path   long
Response Body
media type data type description
application/json object (JSON)

PUT /admin/securityschemes/setdefault/{securitySchemeId}

Set default security scheme

Try it out!

Request Parameters
name type description default constraints
securitySchemeId path ID of securityScheme   long
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information, whether the setting has or has not been succeeded.

POST /admin/securityschemes/assign/{securitySchemeId}/{rightId}

Assign user or group to given right in security scheme

Try it out!

Request Parameters
name type description default constraints
rightId path ID of right   long
securitySchemeId path ID of security scheme   long
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information, whether the assignment has or has not been succeeded.

POST /admin/securityschemes/class/assign/{securitySchemeId}

Try it out!

Request Parameters
name type description default constraints
securitySchemeId path   long
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json HdcSuccessTO (JSON)

POST /admin/securityschemes/class/unassign/{securitySchemeId}

Try it out!

Request Parameters
name type description default constraints
securitySchemeId path   long
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json HdcSuccessTO (JSON)

GET /admin/securityschemes/classes/json/{securitySchemeId}

Try it out!

Request Parameters
name type description default constraints
securitySchemeId path   long
Response Body
media type data type description
application/json object (JSON)

POST /admin/securityschemes/unassign/{securitySchemeId}/{rightId}

Try it out!

Request Parameters
name type description default constraints
rightId path   long
securitySchemeId path   long
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json HdcSuccessTO (JSON)

GET /admin/securityschemes/members/json/{securitySchemeId}/{privilegeId}

Get list of security scheme members (users or groups) assigned to given privilege in security scheme

Try it out!

Request Parameters
name type description default constraints
privilegeId path privilege identifier   long
securitySchemeId path security scheme identifier   long
mode query    
Response Body
media type data type description
application/json object (JSON) JSON with list of users

Example of response:

{"list":[{"id":1,"name":"admin","userFullName":"Admin","description":"","enabled":true,"email":"","loginCount":1840,"lastLoginDate":"2013-09-26T10:18:36.199072+02:00"},{"id":2,"name":"user1","userFullName":"User 1","description":"","enabled":true,"email":"","loginCount":784,"lastLoginDate":"2013-09-25T13:16:12.990218+02:00"}]}