TokenGroup#

pydantic model gafaelfawr.models.token.TokenGroup#

Information about a single group.

Parameters:

data (Any) –

Show JSON schema
{
   "title": "TokenGroup",
   "description": "Information about a single group.",
   "type": "object",
   "properties": {
      "name": {
         "examples": [
            "g_special_users"
         ],
         "minLength": 1,
         "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$",
         "title": "Name of the group",
         "type": "string"
      },
      "id": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Numeric GID may be unset, in which case the group still contributes to determining scopes, but may be ignored by services that require a GID. If Firestore is configured, a numeric GID will be allocated by Firestore if left unset when creating a token.",
         "examples": [
            123181
         ],
         "title": "Numeric GID of the group"
      }
   },
   "required": [
      "name"
   ]
}

Fields:
field id: int | None = None#

Numeric GID may be unset, in which case the group still contributes to determining scopes, but may be ignored by services that require a GID. If Firestore is configured, a numeric GID will be allocated by Firestore if left unset when creating a token.

field name: str [Required]#
Constraints:
  • min_length = 1

  • pattern = ^[a-zA-Z][a-zA-Z0-9._-]*$