OIDCClient

pydantic model gafaelfawr.config.OIDCClient

Configuration for a single OpenID Connect client of our server.

Unlike the other configuration models, this model parses the value of a secret rather than the Helm values file and does not support camel-case.

Parameters:

data (Any)

Show JSON schema
{
   "title": "OIDCClient",
   "description": "Configuration for a single OpenID Connect client of our server.\n\nUnlike the other configuration models, this model parses the value of a\nsecret rather than the Helm values file and does not support camel-case.",
   "type": "object",
   "properties": {
      "id": {
         "description": "Unique identifier of the client",
         "title": "Client ID",
         "type": "string"
      },
      "secret": {
         "description": "Secret used to authenticate this client",
         "format": "password",
         "title": "Client secret",
         "type": "string",
         "writeOnly": true
      },
      "return_uri": {
         "description": "Acceptable return URL when authenticating users for this client",
         "title": "Return URL",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "id",
      "secret",
      "return_uri"
   ]
}

Fields:
field id: str [Required]

Unique identifier of the client

field return_uri: HttpUrlString [Required]

Acceptable return URL when authenticating users for this client

field secret: SecretStr [Required]

Secret used to authenticate this client