ForgeRockSettings#

pydantic model gafaelfawr.config.ForgeRockSettings#

pydantic model of ForgeRock Identity Management configuration.

Parameters:: data (Any) –

Show JSON schema

{
   "title": "ForgeRockSettings",
   "description": "pydantic model of ForgeRock Identity Management configuration.",
   "type": "object",
   "properties": {
      "url": {
         "title": "Url",
         "type": "string"
      },
      "username": {
         "title": "Username",
         "type": "string"
      },
      "passwordFile": {
         "format": "path",
         "title": "Passwordfile",
         "type": "string"
      }
   },
   "required": [
      "url",
      "username",
      "passwordFile"
   ]
}

Fields:

passwordFile (pathlib.Path)
url (str)
username (str)

field passwordFile: Path [Required] (name 'password_file')#: File containing the password for authenticated queries.

field url: str [Required]#: Base URL for ForgeRock Identity Management server.

field username: str [Required]#: Username for authenticated queries.

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