OIDCClientSecret#

pydantic model phalanx.models.secrets.OIDCClientSecret#

Configuration for a single OpenID Connect client of our server.

This must match the corresponding Gafaelfawr model, since its serialization to JSON will be parsed as part of the Gafaelfawr configuration.

Parameters:

data (Any)

Show JSON schema
{
   "title": "OIDCClientSecret",
   "description": "Configuration for a single OpenID Connect client of our server.\n\nThis must match the corresponding Gafaelfawr model, since its\nserialization to JSON will be parsed as part of the Gafaelfawr\nconfiguration.",
   "type": "object",
   "properties": {
      "id": {
         "description": "Unique identifier of the client",
         "title": "Client ID",
         "type": "string"
      },
      "secret": {
         "description": "Secret used to authenticate this client",
         "title": "Client secret",
         "type": "string"
      },
      "return_uri": {
         "description": "Acceptable return URL when authenticating users for this client",
         "title": "Return URL",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "id",
      "secret",
      "return_uri"
   ]
}

Config:
  • extra: str = forbid

  • populate_by_name: bool = True

  • validate_by_alias: bool = True

  • validate_by_name: bool = True

Fields:
field id: str [Required]#

Unique identifier of the client

field return_uri: str [Required]#

Acceptable return URL when authenticating users for this client

field secret: str [Required]#

Secret used to authenticate this client