GeoServer Security

The Security area shows access rules and other configuration for the security subsystem
More information: http://geoserver.org/comm/
Contact Info: geoserver-users@sourceforge.net
Version: 1.0.0
BasePath:/geoserver/rest
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up
delete /rest/security/acl/layers/{rule}
Delete layer rule. (deleteACLLayer)
Deletes specific layer-based rule(s). The {rule} must specified in the last part of the URL and of the form <workspace>.<layer>.[r|w|a]

Path parameters

rule (required)
Path Parameter — The specified rule, as the last part in the URI, e.g. /security/acl/layers/*.*.r

Responses

200

OK

Up
delete /rest/security/acl/layers
Delete layer rule(s) (deleteACLLayers)
Deletes one or more layer-based rules in the list of security rules.

Responses

200

OK

404

Not found. Attempting to delete a non-existent rule.

Up
delete /rest/security/acl/rest/{rule}
Delete REST access rule (deleteACLRESTRule)
Deletes specific REST access rule(s). The {rule} must specified as the last part of the URL and must be of the form <URL Ant pattern>:<comma separated list of HTTP methods>

Path parameters

rule (required)
Path Parameter

The REST rule, specified as <URL Ant pattern>;<comma separated list of HTTP methods>. Examples are

  • /**;GET
  • /**;POST,DELETE,PUT

Responses

200

OK

Up
delete /rest/security/acl/rest
Delete REST access rule(s) (deleteACLRESTRules)
Deletes one or more service-based rules.

Responses

200

OK

404

Not found. Attempting to delete a non-existent rule.

Up
delete /rest/security/acl/services/{rule}
Delete service rule. (deleteACLService)
Deletes specific service-based rule(s). The {rule} must be specified as the last part of the URL and must be of the form <service>.<operation>

Path parameters

rule (required)
Path Parameter — The specified rule, as the last part in the URI, e.g. /security/acl/layers/*.*.r

Responses

200

OK

Up
delete /rest/security/acl/services
Delete service rule(s) (deleteACLServices)
Deletes one or more service-based rules in the list of security rules.

Responses

200

OK

404

Not found. Attempting to delete a non-existent rule.

Up
delete /rest/security/acl/catalog
(deleteCatalogMode)
Invalid. Use PUT to change catalog mode.

Responses

405

Method Not Allowed

Up
delete /rest/security/masterpw
(deleteMasterPW)
Invalid. Use PUT to change keystore password.

Responses

405

Method Not Allowed

Up
delete /rest/security/self/password
(deleteSelfPassword)
Invalid. Use PUT to change password.

Responses

405

Method Not Allowed

Up
get /rest/security/acl/layers/{rule}
(getACLLayer)
Has no effect. Endpoint that includes a specific rule is only used with DELETE.

Path parameters

rule (required)
Path Parameter — The specified rule, as the last part in the URI, e.g. /security/acl/layers/*.*.r

Responses

405

Method not allowed

Up
get /rest/security/acl/layers
Get layer rules (getACLLayers)
Displays the current layer-based security rules.

Return type

ACLLayers

Example data

Content-Type: application/xml
"\n\n  GROUP_ADMIN,ADMIN\n  *\n\n"

Example data

Content-Type: application/json
"{\"*.*.w\":\"GROUP_ADMIN,ADMIN\",\"*.*.r\":\"*\"}\n"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ACLLayers

Example data

Content-Type: application/xml


  GROUP_ADMIN,ADMIN
  *

Example data

Content-Type: application/json
{"*.*.w":"GROUP_ADMIN,ADMIN","*.*.r":"*"}

Up
get /rest/security/acl/rest/{rule}
(getACLRESTRule)
Has no effect. Endpoint that includes a specific rule is only used with DELETE.

Path parameters

rule (required)
Path Parameter

The REST rule, specified as <URL Ant pattern>;<comma separated list of HTTP methods>. Examples are

  • /**;GET
  • /**;POST,DELETE,PUT

Responses

200

OK

Up
get /rest/security/acl/rest
Get REST rules (getACLRESTRules)
Displays the current REST access rules.

Return type

ACLREST

Example data

Content-Type: application/xml
"\n  ADMIN\n  ADMIN\n\n"

Example data

Content-Type: application/json
"{\"/**:GET\":\"ADMIN\",\"/**:POST,DELETE,PUT\":\"ADMIN\"}\n"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ACLREST

Example data

Content-Type: application/xml

  ADMIN
  ADMIN

Example data

Content-Type: application/json
{"/**:GET":"ADMIN","/**:POST,DELETE,PUT":"ADMIN"}

Up
get /rest/security/acl/services/{rule}
(getACLService)
Has no effect. Endpoint that includes a specific rule is only used with DELETE.

Path parameters

rule (required)
Path Parameter — The specified rule, as the last part in the URI, e.g. /security/acl/layers/*.*.r

Responses

405

Method not allowed.

Up
get /rest/security/acl/services
Get service rules (getACLServices)
Displays the current service-based security rules.

Return type

ACLServices

Example data

Content-Type: application/xml
"\n\n  *\n\n"

Example data

Content-Type: application/json
"{\"*.*\":\"*\"}\n"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ACLServices

Example data

Content-Type: application/xml


  *

Example data

Content-Type: application/json
{"*.*":"*"}

Up
get /rest/security/acl/catalog
(getCatalogMode)
Gets the catalog mode, which specifies how GeoServer will advertise secured layers and behave when a secured layer is accessed without the necessary privileges.

Return type

CatalogMode

Example data

Content-Type: application/xml
"\n\n  HIDE\n\n"

Example data

Content-Type: application/json
"{\"mode\":\"HIDE\"}\n"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK CatalogMode

Example data

Content-Type: application/xml


  HIDE

Example data

Content-Type: application/json
{"mode":"HIDE"}

Up
get /rest/security/masterpw
Get keystore password (getMasterPW)
Displays the keystore password. HTTPS is strongly suggested, otherwise password will be sent in plain text. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/settings.xml" for XML).

Return type

MasterPW

Example data

Content-Type: application/xml
"\n\n  geoserver\n\n"

Example data

Content-Type: application/json
"{\"oldMasterPassword\":\"GeoServer\"}\n"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MasterPW

Example data

Content-Type: application/xml


  geoserver

Example data

Content-Type: application/json
{"oldMasterPassword":"GeoServer"}

Up
get /rest/security/self/password
(getSelfPassword)
Invalid. Use PUT to change password.

Responses

405

Method Not Allowed

Up
post /rest/security/acl/layers/{rule}
(postACLLayer)
Has no effect. Endpoint that includes a specific rule is only used with DELETE.

Path parameters

rule (required)
Path Parameter — The specified rule, as the last part in the URI, e.g. /security/acl/layers/*.*.r

Responses

405

Method not allowed.

Up
post /rest/security/acl/layers
Add layer rule(s) (postACLLayers)
Adds one or more new layer-based rules to the list of security rules.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ACLLayersBody ACLLayers (required)
Body Parameter — The new rules to upload.

Responses

200

OK

409

Conflict. Adding an already-added rule. Use PUT to edit the rule in this case. All rule additions are aborted.

Up
post /rest/security/acl/rest/{rule}
(postACLRESTRule)
Has no effect. Endpoint that includes a specific rule is only used with DELETE.

Path parameters

rule (required)
Path Parameter

The REST rule, specified as <URL Ant pattern>;<comma separated list of HTTP methods>. Examples are

  • /**;GET
  • /**;POST,DELETE,PUT

Responses

200

OK

Up
post /rest/security/acl/rest
Add REST access rule(s) (postACLRESTRules)
Adds one or more new REST access rules.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ACLRESTBody ACLREST (required)
Body Parameter — The new rules to upload.

Responses

200

OK

409

Conflict. Adding an already-added rule. Use PUT to edit the rule in this case. All rule additions are aborted.

Up
post /rest/security/acl/services/{rule}
(postACLService)
Has no effect. Endpoint that includes a specific rule is only used with DELETE.

Path parameters

rule (required)
Path Parameter — The specified rule, as the last part in the URI, e.g. /security/acl/layers/*.*.r

Responses

405

Method not allowed.

Up
post /rest/security/acl/services
Add service rule(s) (postACLServices)
Adds one or more new service-based rules to the list of security rules.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ACLServicesBody ACLServices (required)
Body Parameter — The new rules to upload.

Responses

200

OK

409

Conflict. Adding an already-added rule. Use PUT to edit the rule in this case. All rule additions are aborted.

Up
post /rest/security/acl/catalog
(postCatalogMode)
Invalid. Use PUT to change catalog mode.

Responses

405

Method Not Allowed

Up
post /rest/security/masterpw
(postMasterPW)
Invalid. Use PUT to change keystore password.

Responses

405

Method Not Allowed

Up
post /rest/security/self/password
(postSelfPassword)
Invalid. Use PUT to change password

Responses

405

Method Not Allowed

Up
put /rest/security/acl/layers/{rule}
(putACLLayer)
Has no effect. Endpoint that includes a specific rule is only used with DELETE.

Path parameters

rule (required)
Path Parameter — The specified rule, as the last part in the URI, e.g. /security/acl/layers/*.*.r

Responses

405

Method not allowed.

Up
put /rest/security/acl/layers
Edit layer rule(s) (putACLLayers)
Edits one or more layer-based rules in the list of security rules.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ACLLayersBody ACLLayers (required)
Body Parameter — The altered rules to upload.

Responses

200

OK

409

Conflict. Attempting to modify a non-existent rule. Use POST to create the rule in this case. All rule modifications are aborted.

Up
put /rest/security/acl/rest/{rule}
(putACLRESTRule)
Has no effect. Endpoint that includes a specific rule is only used with DELETE.

Path parameters

rule (required)
Path Parameter

The REST rule, specified as <URL Ant pattern>;<comma separated list of HTTP methods>. Examples are

  • /**;GET
  • /**;POST,DELETE,PUT

Responses

200

OK

Up
put /rest/security/acl/rest
Edit REST access rule(s) (putACLRESTRules)
Edits one or more REST access rules.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ACLRESTBody ACLREST (required)
Body Parameter — The altered rules to upload.

Responses

200

OK

409

Conflict. Attempting to modify a non-existent rule. Use POST to create the rule in this case. All rule modifications are aborted.

Up
put /rest/security/acl/services/{rule}
(putACLService)
Has no effect. Endpoint that includes a specific rule is only used with DELETE.

Path parameters

rule (required)
Path Parameter — The specified rule, as the last part in the URI, e.g. /security/acl/layers/*.*.r

Responses

405

Method not allowed.

Up
put /rest/security/acl/services
Edit service rule(s) (putACLServices)
Edits one or more service-based rules in the list of security rules.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ACLServicesBody ACLServices (required)
Body Parameter — The altered rules to upload.

Responses

200

OK

409

Conflict. Attempting to modify a non-existent rule. Use POST to create the rule in this case. All rule modifications are aborted.

Up
put /rest/security/acl/catalog
Update catalog mode (putCatalogMode)
Changes catalog mode. The mode must be one of HIDE, MIXED, or CHALLENGE.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CatalogModeBody CatalogMode (required)
Body Parameter — The catalog mode information to upload.

Responses

200

OK

422

Unprocessable Entity. This error code will show when an invalid catalog mode is specified.

Up
put /rest/security/masterpw
Update keystore password (putMasterPW)
Changes keystore password. Must supply current keystore password. HTTPS is strongly suggested, otherwise password will be sent in plain text.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

MasterPWBody UpdateMasterPW (required)
Body Parameter — The old and new keystore password information to upload.

Responses

200

OK

422

Unprocessable Entity. This error code will show when the current keystore password supplied is incorrect, or if the new keystore password is rejected by the password policy.

Up
put /rest/security/self/password
Update password (putSelfPassword)
Updates the password for the account used to issue the request.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SelfPasswordBody SelfPassword (required)
Body Parameter — The catalog mode information to upload.

Responses

200

OK

422

Bad password

Models

[ Jump to Methods ]

Table of Contents

  1. ACLLayers - rules
  2. ACLLayers_rule -
  3. ACLREST - rules
  4. ACLREST_rule -
  5. ACLServices - rules
  6. ACLServices_rule -
  7. CatalogMode - catalog
  8. MasterPW - masterPassword
  9. SelfPassword - userPassword
  10. UpdateMasterPW - masterPassword

ACLLayers - rules Up

rule (optional)

ACLLayers_rule - Up

@resource (optional)
String Security pattern of the form ..[r|w|a]
text (optional)
String Comma-separated list of roles

ACLREST - rules Up

rule (optional)

ACLREST_rule - Up

@resource (optional)
String Security pattern of the form <URL Ant pattern>:<comma separated list of HTTP methods>
text (optional)
String Comma-separated list of roles

ACLServices - rules Up

rule (optional)

ACLServices_rule - Up

@resource (optional)
String Security pattern of the form <service>.<operation>
text (optional)
String Comma-separated list of roles

CatalogMode - catalog Up

mode (optional)
Enum:
HIDE
MIXED
CHALLENGE

MasterPW - masterPassword Up

oldMasterPassword (optional)
String Current keystore password

SelfPassword - userPassword Up

newPassword (optional)
String New password
example: newPassword

UpdateMasterPW - masterPassword Up

oldMasterPassword (optional)
String Current keystore password
example: oldPassword
newMasterPassword (optional)
String New keystore password
example: newPassword