Skip to content

Commit 784a96b

Browse files
committed
Add doc string for PDP
1 parent f6754af commit 784a96b

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

tiled/access_control/access_policies.py

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -441,6 +441,32 @@ def __init__(
441441
audience: str,
442442
provider: Optional[str] = None,
443443
):
444+
"""
445+
Initialize an access policy configuration.
446+
447+
Parameters
448+
----------
449+
authorization_provider : HttpUrl
450+
The base URL of the authorization provider.
451+
node_access : str
452+
The endpoint path for node access validation. Will be joined with the
453+
authorization_provider base URL.
454+
filter_nodes : str
455+
The endpoint path for filtering nodes. Will be joined with the
456+
authorization_provider base URL.
457+
scopes_access : str
458+
The endpoint path for scopes access validation. Will be joined with the
459+
authorization_provider base URL.
460+
audience : str
461+
The intended audience for the authorization tokens.
462+
provider : Optional[str], optional
463+
The name of the authorization provider, by default None.
464+
465+
Notes
466+
-----
467+
The endpoint paths are combined with the authorization_provider URL using
468+
urljoin, extracting only the path component from each endpoint parameter.
469+
"""
444470
self._node_access = str(
445471
urljoin(
446472
str(authorization_provider),

0 commit comments

Comments
 (0)