SettingsResource

A REST resource to query and manipulate Access Control Plus-specific settings. Copyright 2017 WANdisco.

The following resources are part of this group:

/settings

Mount Point: /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/auditstatemachineid

Mount Point: /settings/auditstatemachineid

GET

Returns the current dsm id for the audit state machine.

Response Body

element: (custom)
media types: */*
application/xml

the string dsm id of the audit state machine in the body of the response if available or a 400 bad request if not available

Status Codes

code description
200 OK
503 Service unavailable - see returned ExceptionDTO
401 Authentication required.
403 Authorization required - access forbidden

/settings/conflictstrategyhighestprioritywins

Mount Point: /settings/conflictstrategyhighestprioritywins

GET

Returns whether or not conflict strategy highest priority wins is enabled.

Response Body

element: (custom)
media types: */*
application/xml

the string true in the body of the response if conflict strategy highest priority wins enabled, otherwise the body of the response will contain the string false, to indicate that the lowest priority will win.

Status Codes

code description
200 OK
401 Authentication required.
403 Authorization required - access forbidden

/settings/createauditstatemachine

Mount Point: /settings/createauditstatemachine

PUT

Create and deploy the Audit State Machine.

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
409 Conflict - Requested action would cause a conflict
503 Service unavailable - see returned ExceptionDTO
401 Authentication required.
403 Authorization required - access forbidden

/settings/globaldowncasing

Mount Point: /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/globalwildcards

Mount Point: /settings/globalwildcards

GET

Returns whether or not global wildcards are enabled.

Response Body

element: (custom)
media types: */*
application/xml

the string true in the body of the response if global wildcards are enabled, otherwise the body of the response will contain the string false, to indicate that global wildcards are disabled

Status Codes

code description
200 OK
401 Authentication required.
403 Authorization required - access forbidden

/settings/replicated

Mount Point: /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/resetproposedauditdsmid

Mount Point: /settings/resetproposedauditdsmid

PUT

Reset the proposed audit dsm id on all nodes. This will only be started if getAuditDSMId == null.

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
409 Conflict - Requested action would cause a conflict
503 Service unavailable - see returned ExceptionDTO
401 Authentication required.
403 Authorization required - access forbidden

/settings/conflictstrategyhighestprioritywins/disable

Mount Point: /settings/conflictstrategyhighestprioritywins/disable

PUT

Disable global wildcards.

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/conflictstrategyhighestprioritywins/enable

Mount Point: /settings/conflictstrategyhighestprioritywins/enable

PUT

Enable conflict strategy highest priority wins.

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/disable

Mount Point: /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: /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

/settings/globalwildcards/enable

Mount Point: /settings/globalwildcards/enable

PUT

Enable global wildcards. Once enabled this can't be disabled!

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