APIConfig

pydantic model gafaelfawr.models.auth.APIConfig

Configuration information for the API.

Supplemental information about the Gafaelfawr configuration that is useful to a UI and therefore is returned as part of a login response.

Parameters:

data (Any)

Show JSON schema

{
   "title": "APIConfig",
   "description": "Configuration information for the API.\n\nSupplemental information about the Gafaelfawr configuration that is useful\nto a UI and therefore is returned as part of a login response.",
   "type": "object",
   "properties": {
      "scopes": {
         "description": "All scopes currently recognized by the server.  Tokens may have other scopes, but new tokens may only be issued with one of these scopes.",
         "items": {
            "$ref": "#/$defs/Scope"
         },
         "title": "All known scopes",
         "type": "array"
      }
   },
   "$defs": {
      "Scope": {
         "description": "A known token scope.",
         "properties": {
            "name": {
               "examples": [
                  "user:token"
               ],
               "title": "Scope name",
               "type": "string"
            },
            "description": {
               "examples": [
                  "Can create and modify user tokens"
               ],
               "title": "Scope description",
               "type": "string"
            }
         },
         "required": [
            "name",
            "description"
         ],
         "title": "Scope",
         "type": "object"
      }
   },
   "required": [
      "scopes"
   ]
}

Fields:

• scopes (list[gafaelfawr.models.auth.Scope])

field scopes: list[Scope] [Required]

All scopes currently recognized by the server. Tokens may have other scopes, but new tokens may only be issued with one of these scopes.