GafaelfawrIngressDelegate

pydantic model gafaelfawr.models.kubernetes.GafaelfawrIngressDelegate

Configuration for delegated tokens requested for a service.

Parameters:

data (Any)

Show JSON schema
{
   "title": "GafaelfawrIngressDelegate",
   "description": "Configuration for delegated tokens requested for a service.",
   "type": "object",
   "properties": {
      "notebook": {
         "anyOf": [
            {
               "$ref": "#/$defs/GafaelfawrIngressDelegateNotebook"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "internal": {
         "anyOf": [
            {
               "$ref": "#/$defs/GafaelfawrIngressDelegateInternal"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "minimumLifetime": {
         "anyOf": [
            {
               "$ref": "#/$defs/SecondsTimedelta"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "useAuthorization": {
         "default": false,
         "title": "Useauthorization",
         "type": "boolean"
      }
   },
   "$defs": {
      "GafaelfawrIngressDelegateInternal": {
         "description": "Configuration for a delegated internal token.",
         "properties": {
            "service": {
               "title": "Service",
               "type": "string"
            },
            "scopes": {
               "items": {
                  "type": "string"
               },
               "title": "Scopes",
               "type": "array"
            }
         },
         "required": [
            "service",
            "scopes"
         ],
         "title": "GafaelfawrIngressDelegateInternal",
         "type": "object"
      },
      "GafaelfawrIngressDelegateNotebook": {
         "description": "Configuration for a delegated notebook token.\n\nNotes\n-----\nThis model is currently empty and represents an empty dict on the\nKubernetes side, but it is still an object for parallelism with\n`GafaelfawrIngressDelegateInternal`. It may have parameters for notebook\ntokens in the future.",
         "properties": {},
         "title": "GafaelfawrIngressDelegateNotebook",
         "type": "object"
      },
      "SecondsTimedelta": {
         "format": "duration",
         "type": "string"
      }
   }
}

Fields:
Validators:

  • validator » all fields

field internal: GafaelfawrIngressDelegateInternal | None = None

Configuration for a delegated internal token.

Validated by:

  • validator

field minimumLifetime: SecondsTimedelta | None = None (name 'minimum_lifetime')

The minimum lifetime of the delegated token.

Validated by:

  • validator

field notebook: GafaelfawrIngressDelegateNotebook | None = None

Whether the delegated token requested is a notebook token.

Validated by:

  • validator

field useAuthorization: bool = False (name 'use_authorization')

Whether to put the delegated token in the Authorization header.

Validated by:

  • validator

to_auth_query()

Generate the query parameters corresponding to this delegation.

Returns:

List of query parameters corresponding to this ingress delegation configuration to pass to the Gafaelfawr /ingress/auth route.

Return type:

list of tuple