Skip to content

JWTOptionsInput

Source code in docs_src/capo_opensearch/types/jwt_options_input.py 
15
16
17
18
19
20
21
22
23
24
25
class JWTOptionsInput(TypedDict, closed=True):
    enabled: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>True to enable JWT authentication and authorization for a domain.</p>"""
    subject_key: NotRequired["capo_opensearch.types.subject_key.SubjectKey"]
    """<p>Element of the JWT assertion to use for the user name.</p>"""
    roles_key: NotRequired["capo_opensearch.types.roles_key.RolesKey"]
    """<p>Element of the JWT assertion to use for roles.</p>"""
    jwks_url: NotRequired["capo_opensearch.types.jwks_url.JwksUrl"]
    """<p>The URL endpoint that hosts the JSON Web Key Set (JWKS) containing public keys used to verify JWT signatures.</p>"""
    public_key: NotRequired["capo_opensearch.types.string.String"]
    """<p>Element of the JWT assertion used by the cluster to verify JWT signatures.</p>"""

enabled instance-attribute 

enabled: NotRequired[Boolean]

True to enable JWT authentication and authorization for a domain.

jwks_url instance-attribute 

jwks_url: NotRequired[JwksUrl]

The URL endpoint that hosts the JSON Web Key Set (JWKS) containing public keys used to verify JWT signatures.

public_key instance-attribute 

public_key: NotRequired[String]

Element of the JWT assertion used by the cluster to verify JWT signatures.

roles_key instance-attribute 

roles_key: NotRequired[RolesKey]

Element of the JWT assertion to use for roles.

subject_key instance-attribute 

subject_key: NotRequired[SubjectKey]

Element of the JWT assertion to use for the user name.