geoserver-acl-client

This API provides comprehensive control over the GeoServer Access Control List (ACL) system. It allows for the management of fine-grained access rules and provides endpoints to query authorization decisions.

The API is divided into three main areas:

1. Data Rules: For managing access to specific GeoServer resources (layers, services, etc.).
2. Workspace Admin Rules: For managing administrative privileges on a per-workspace basis.
3. Authorization: For querying the ACL system to determine access rights for a given request.

Rules are evaluated in priority order (lower numbers = higher priority) to determine whether a request should be allowed, denied, or limited. The API also provides authorization endpoints that evaluate these rules for specific access requests.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 3.0.2
• Generator version: 7.25.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://github.com/geoserver/geoserver-acl

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/geoserver/geoserver-acl.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/geoserver/geoserver-acl.git)

Then import the package:

import geoserver_acl_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import geoserver_acl_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import geoserver_acl_client
from geoserver_acl_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api
# See configuration.py for a list of all supported configuration parameters.
configuration = geoserver_acl_client.Configuration(
    host = "/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = geoserver_acl_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)


# Enter a context with an instance of the API client
with geoserver_acl_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = geoserver_acl_client.AuthorizationApi(api_client)
    access_request = geoserver_acl_client.AccessRequest() # AccessRequest | 

    try:
        # Evaluate resource access permissions
        api_response = api_instance.get_access_info(access_request)
        print("The response of AuthorizationApi->get_access_info:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthorizationApi->get_access_info: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /api

Documentation For Models

• AccessInfo
• AccessRequest
• AccessSummary
• AccessSummaryRequest
• AddressRangeFilter
• AdminAccessInfo
• AdminAccessRequest
• AdminGrantType
• AdminRule
• AdminRuleFilter
• CatalogMode
• Geom
• GrantType
• InsertPosition
• LayerAttribute
• LayerDetails
• Rule
• RuleFilter
• RuleLimits
• SetFilter
• SpatialFilterType
• TextFilter
• Wkb
• Wkt
• WorkspaceAccessSummary

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

Author

geoserver-user@discourse.osgeo.org