SettingsResource
A REST resource to query and manipulate Access Control Plus-specific settings
The following resources are part of this group:
- /settings
- /settings/globaldowncasing
- /settings/replicated
- /settings/globaldowncasing/disable
- /settings/globaldowncasing/enable
/settings
Mount Point: /api/settings
GET
Retrieve ACP specific settings
Response Body
| element: | configuration |
| media types: | application/xml application/json |
(no documentation provided)
Status Codes
| code | description |
|---|---|
| 200 | OK |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |
/settings/globaldowncasing
Mount Point: /api/settings/globaldowncasing
GET
Returns whether global downcasing of usernames is enabled or not.
Response Body
| element: | (custom) |
| media types: | */* application/xml |
the string true in the body of the response if global downcasing is enabled, otherwise the body of the response will contain the string false, to indicate that global downcasing is disabled
Status Codes
| code | description |
|---|---|
| 200 | OK |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |
/settings/replicated
Mount Point: /api/settings/replicated
The following operations are supported on this resource:
GET
Retrieve ACP specific replicated settings
Response Body
| element: | configuration |
| media types: | application/xml application/json |
(no documentation provided)
Status Codes
| code | description |
|---|---|
| 200 | OK |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |
PUT
Update ACP specific replicated settings
Request Body
| element: | configuration |
| media types: | application/xml application/json |
edited values to push to ACP replicated settings
Response Body
| element: | (custom) |
| media types: | */* application/xml |
ID of the task monitoring the proposal
Status Codes
| code | description |
|---|---|
| 202 | Accepted - proposed |
| 400 | Bad request - see returned ExceptionDTO |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |
DELETE
Delete ACP specific replicated settings
Parameters
| name | description | type | default |
|---|---|---|---|
| key | keyvalue of the setting to delete | query |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
ID of the task monitoring the proposal
Status Codes
| code | description |
|---|---|
| 202 | Accepted - proposed |
| 404 | Not found - see returned ExceptionDTO |
| 400 | Bad request - see returned ExceptionDTO |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |
/settings/globaldowncasing/disable
Mount Point: /api/settings/globaldowncasing/disable
PUT
Disable global downcasing of usernames.
Response Body
| element: | (custom) |
| media types: | */* application/xml |
a task ID in the body of the HTTP response that can be used to check on the task progress
Status Codes
| code | description |
|---|---|
| 202 | Accepted - proposed |
| 503 | Service unavailable - see returned ExceptionDTO |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |
/settings/globaldowncasing/enable
Mount Point: /api/settings/globaldowncasing/enable
PUT
Enable global downcasing of usernames.
Response Body
| element: | (custom) |
| media types: | */* application/xml |
a task ID in the body of the HTTP response that can be used to check on the task progress
Status Codes
| code | description |
|---|---|
| 202 | Accepted - proposed |
| 503 | Service unavailable - see returned ExceptionDTO |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |