OIDCServerSettings#

pydantic model gafaelfawr.config.OIDCServerSettings#

pydantic model of issuer configuration.

Parameters:: data (Any) –

Show JSON schema

{
   "title": "OIDCServerSettings",
   "description": "pydantic model of issuer configuration.",
   "type": "object",
   "properties": {
      "issuer": {
         "title": "Issuer",
         "type": "string"
      },
      "keyId": {
         "title": "Keyid",
         "type": "string"
      },
      "audience": {
         "title": "Audience",
         "type": "string"
      },
      "keyFile": {
         "format": "path",
         "title": "Keyfile",
         "type": "string"
      },
      "secretsFile": {
         "format": "path",
         "title": "Secretsfile",
         "type": "string"
      }
   },
   "required": [
      "issuer",
      "keyId",
      "audience",
      "keyFile",
      "secretsFile"
   ]
}

Fields:

audience (str)
issuer (str)
keyFile (pathlib.Path)
keyId (str)
secretsFile (pathlib.Path)

field audience: str [Required]#: aud (audience) field in issued tokens.

field issuer: str [Required]#: iss (issuer) field in issued tokens.

field keyFile: Path [Required] (name 'key_file')#: File containing RSA private key for signing issued tokens.

field keyId: str [Required] (name 'key_id')#: kid (key ID) header field in issued tokens.

field secretsFile: Path [Required] (name 'secrets_file')#: Path to file containing OpenID Connect client secrets in JSON.

model_dump(**kwargs)#

Export the model as a dictionary.

Overridden to change the default of by_alias from False to True, so that by default the exported dictionary uses camel-case.

Parameters:: kwargs (Any) –
Return type:: dict[str, Any]

model_dump_json(**kwargs)#

Export the model as JSON.

Overridden to change the default of by_alias from False to True, so that by default the exported dictionary uses camel-case.

Parameters:: kwargs (Any) –
Return type:: str