Skip to content

JWTOptionsOutput

Source code in docs_src/capo_opensearch/types/jwt_options_output.py 
13
14
15
16
17
18
19
20
21
22
23
class JWTOptionsOutput(TypedDict, closed=True):
    enabled: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>True if JWT use is enabled.</p>"""
    subject_key: NotRequired["capo_opensearch.types.string.String"]
    """<p>The key used for matching the JWT subject attribute.</p>"""
    roles_key: NotRequired["capo_opensearch.types.string.String"]
    """<p>The key used for matching the JWT roles attribute.</p>"""
    jwks_url: NotRequired["capo_opensearch.types.jwks_url.JwksUrl"]
    """<p>The configured JWKS URL endpoint from which the cluster retrieves public keys to verify JWT requests.</p>"""
    public_key: NotRequired["capo_opensearch.types.string.String"]
    """<p>The key used to verify the signature of incoming JWT requests.</p>"""

enabled instance-attribute 

enabled: NotRequired[Boolean]

True if JWT use is enabled.

jwks_url instance-attribute 

jwks_url: NotRequired[JwksUrl]

The configured JWKS URL endpoint from which the cluster retrieves public keys to verify JWT requests.

public_key instance-attribute 

public_key: NotRequired[String]

The key used to verify the signature of incoming JWT requests.

roles_key instance-attribute 

roles_key: NotRequired[String]

The key used for matching the JWT roles attribute.

subject_key instance-attribute 

subject_key: NotRequired[String]

The key used for matching the JWT subject attribute.