Skip to content

AGATE Configuration

Service pydantic-model

Bases: BaseModel

Fields:

pattern_target pydantic-field

If undefined, then the pattern is matched against the path. Use query.{param}, where {param} is the parameter value, to use a query parameter. Use query.{param}.url.path|query if the param value is a url and that you want to target the path or query of that url.

public_url_patterns pydantic-field

List of patterns for public access. IMPORTANT: no access control done on those patterns.

url_header pydantic-field

Header containing the URL

url_header_prefix pydantic-field

URL prefix that is removed before pattern matching.

url_patterns pydantic-field

List of patterns for the service for extracting the collection name and item name (e.g. (?P[^/]+)/items/(?P[^/]+)/assets/overview)

Settings pydantic-model

Bases: BaseModel

Fields:

agate_prefix pydantic-field

Agate endpoint prefix

ARLAS URL Search (ex http://arlas-server:9999/arlas/explore/{collection}/_search?f=id:eq:{item})

host pydantic-field

Agate service connection host

port pydantic-field

Agate service port

services = {} pydantic-field

Dictionary of service name/definition. A service protects an endpoint that is exposing resources linked to an ARLAS Item. The service definition tells how to extract the collection name and the item id that are then used for checking with ARLAS whether the item is accessible or not.

urbac pydantic-field

URL Role Based Access Control Definition. A user access an endpoint if one of his role is configured in the role configuration file for the requested endpoint (roles.yaml)

URBAC pydantic-model

Bases: BaseModel

Fields:

jwt_header pydantic-field

The header containing the JWT (can start with 'Bearer')

method_header pydantic-field

The header containing the method

role_file pydantic-field

File location containing the roles

roles = Roles(technicalRoles={}) pydantic-field

Definition of the endpoints and of the authorized roles. This is automatically filled from role_file

url_header pydantic-field

The header containing the requested URL