User

Smarter API User Manifest Constants

Smarter API Manifest - User.metadata

pydantic model smarter.apps.account.manifest.models.user.metadata.SAMUserMetadata[source]

Bases: AbstractSAMMetadataBase

Smarter API User Manifest - Metadata class.

Show JSON schema

{
   "title": "SAMUserMetadata",
   "description": "Smarter API User Manifest - Metadata class.",
   "type": "object",
   "properties": {
      "name": {
         "description": "The camelCase name of the manifest resource",
         "title": "Name",
         "type": "string"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The description for this resource. Be brief. Keep it under 255 characters.",
         "title": "Description"
      },
      "version": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The semantic version of the manifest. Example: 0.1.0",
         "title": "Version"
      },
      "tags": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "description": "The tags of the manifest. Used for generic resource categorization and search. Example: ['tag1', 'tag2']",
         "title": "Tags"
      },
      "annotations": {
         "anyOf": [
            {
               "items": {
                  "additionalProperties": {
                     "anyOf": [
                        {
                           "type": "string"
                        },
                        {
                           "type": "integer"
                        },
                        {
                           "type": "number"
                        },
                        {
                           "type": "boolean"
                        },
                        {
                           "format": "date",
                           "type": "string"
                        },
                        {
                           "format": "date-time",
                           "type": "string"
                        },
                        {
                           "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
                           "type": "string"
                        },
                        {
                           "format": "uuid",
                           "type": "string"
                        },
                        {
                           "format": "binary",
                           "type": "string"
                        },
                        {
                           "items": {},
                           "type": "array"
                        },
                        {
                           "additionalProperties": true,
                           "type": "object"
                        }
                     ]
                  },
                  "type": "object"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "description": "The manifest annotations. Used for storing arbitrary metadata as\n            key-value pairs. Example: [{'smarter.sh/test-manifest/project-name': 'Scooby dooby do'}]. The\n            key should be a valid url-friendly string. The value accepts\n            multi-line string values (YAML block scalars) and various scalar types including\n            str, int, float, bool, datetime.date, datetime.datetime, decimal.Decimal, uuid.UUID, bytes, list, dict.\n            ",
         "title": "Annotations"
      },
      "username": {
         "description": "User.metadata.username[str]. Required. The Django username of the user.",
         "title": "Username",
         "type": "string"
      }
   },
   "required": [
      "name",
      "description",
      "version",
      "username"
   ]
}

Config:

from_attributes: bool = True
arbitrary_types_allowed: bool = True
frozen: bool = True

Fields:

username (str)

Validators:

field username: str [Required]

User.metadata.username[str]. Required. The Django username of the user.

Validated by:

coerce_none_strings

class_identifier: ClassVar[str] = 'User.metadata'

Smarter API Manifest - User.spec

pydantic model smarter.apps.account.manifest.models.user.spec.SAMUserSpec[source]

Bases: AbstractSAMSpecBase

Smarter API User Manifest User.spec

Show JSON schema

{
   "title": "SAMUserSpec",
   "description": "Smarter API User Manifest User.spec",
   "type": "object",
   "properties": {
      "config": {
         "$ref": "#/$defs/SAMUserSpecConfig",
         "description": "User.spec.config[object]. The configuration for the User."
      }
   },
   "$defs": {
      "SAMUserSpecConfig": {
         "description": "Smarter API User Manifest User.spec.config",
         "properties": {
            "firstName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "User.spec.configuration.firstName[str]. Optional. The first name of the User.",
               "title": "Firstname"
            },
            "lastName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "User.spec.configuration.lastName[str]. Optional. The last name of the User.",
               "title": "Lastname"
            },
            "email": {
               "description": "User.spec.configuration.email[str]. The email address of the User.",
               "title": "Email",
               "type": "string"
            },
            "isStaff": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": false,
               "description": "User.spec.configuration.isStaff[bool]. Optional. Designates whether the User has admin permissions.",
               "title": "Isstaff"
            },
            "isActive": {
               "description": "User.spec.configuration.isActive[bool]. Designates whether this User should be treated as active.",
               "title": "Isactive",
               "type": "boolean"
            }
         },
         "required": [
            "email",
            "isActive"
         ],
         "title": "SAMUserSpecConfig",
         "type": "object"
      }
   },
   "required": [
      "config"
   ]
}

Config:

from_attributes: bool = True
arbitrary_types_allowed: bool = True
frozen: bool = True

Fields:

config (smarter.apps.account.manifest.models.user.spec.SAMUserSpecConfig)

Validators:

field config: SAMUserSpecConfig [Required]

User.spec.config[object]. The configuration for the User.

Validated by:

coerce_none_strings

class_identifier: ClassVar[str] = 'User.spec'

pydantic model smarter.apps.account.manifest.models.user.spec.SAMUserSpecConfig[source]

Bases: AbstractSAMSpecBase

Smarter API User Manifest User.spec.config

Show JSON schema

{
   "title": "SAMUserSpecConfig",
   "description": "Smarter API User Manifest User.spec.config",
   "type": "object",
   "properties": {
      "firstName": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User.spec.configuration.firstName[str]. Optional. The first name of the User.",
         "title": "Firstname"
      },
      "lastName": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User.spec.configuration.lastName[str]. Optional. The last name of the User.",
         "title": "Lastname"
      },
      "email": {
         "description": "User.spec.configuration.email[str]. The email address of the User.",
         "title": "Email",
         "type": "string"
      },
      "isStaff": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "description": "User.spec.configuration.isStaff[bool]. Optional. Designates whether the User has admin permissions.",
         "title": "Isstaff"
      },
      "isActive": {
         "description": "User.spec.configuration.isActive[bool]. Designates whether this User should be treated as active.",
         "title": "Isactive",
         "type": "boolean"
      }
   },
   "required": [
      "email",
      "isActive"
   ]
}

Config:

from_attributes: bool = True
arbitrary_types_allowed: bool = True
frozen: bool = True

Fields:

email (str)
firstName (str | None)
isActive (bool)
isStaff (bool | None)
lastName (str | None)

Validators:

field email: str [Required]

User.spec.configuration.email[str]. The email address of the User.

Validated by:

coerce_none_strings

field firstName: Optional[str] = None

User.spec.configuration.firstName[str]. Optional. The first name of the User.

Validated by:

coerce_none_strings

field isActive: bool [Required]

User.spec.configuration.isActive[bool]. Designates whether this User should be treated as active.

Validated by:

coerce_none_strings

field isStaff: Optional[bool] = False

User.spec.configuration.isStaff[bool]. Optional. Designates whether the User has admin permissions.

Validated by:

coerce_none_strings

field lastName: Optional[str] = None

User.spec.configuration.lastName[str]. Optional. The last name of the User.

Validated by:

coerce_none_strings

class_identifier: ClassVar[str] = 'User.spec.configuration'

Smarter API Manifest - User.status

pydantic model smarter.apps.account.manifest.models.user.status.SAMUserStatus[source]

Bases: AbstractSAMStatusBase

Smarter API User Manifest - Status class.

Show JSON schema

{
   "title": "SAMUserStatus",
   "description": "Smarter API User Manifest - Status class.",
   "type": "object",
   "properties": {
      "recordLocator": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "recordLocator[String]: An optional identifier used to locate the resource record associated with this manifest. Read only.",
         "title": "Recordlocator"
      },
      "created": {
         "description": "The date in which this resource was created. Read only.",
         "format": "date-time",
         "title": "Created",
         "type": "string"
      },
      "modified": {
         "description": "The date in which this resource was most recently changed. Read only.",
         "format": "date-time",
         "title": "Modified",
         "type": "string"
      },
      "account_number": {
         "description": "User.status.account_number: The account owner of this User. Read only.",
         "title": "Account Number",
         "type": "string"
      },
      "username": {
         "description": "User.status.account_number: The Smarter user who created this User. Read only.",
         "title": "Username",
         "type": "string"
      }
   },
   "required": [
      "created",
      "modified",
      "account_number",
      "username"
   ]
}

Config:

from_attributes: bool = True
arbitrary_types_allowed: bool = True
frozen: bool = True

Fields:

account_number (str)
username (str)

Validators:

field account_number: str [Required]

User.status.account_number: The account owner of this User. Read only.

Validated by:

coerce_none_strings

field username: str [Required]

User.status.account_number: The Smarter user who created this User. Read only.

Validated by:

coerce_none_strings

class_identifier: ClassVar[str] = 'User.status'

Smarter API User Manifest

pydantic model smarter.apps.account.manifest.models.user.model.SAMUser[source]

Bases: AbstractSAMBase

Smarter API Manifest - User

Show JSON schema

{
   "title": "SAMUser",
   "description": "Smarter API Manifest - User",
   "type": "object",
   "properties": {
      "apiVersion": {
         "description": "apiVersion[String]: Required. The API version of the AbstractSAMBase.",
         "title": "Apiversion",
         "type": "string"
      },
      "kind": {
         "description": "kind[String]: Required. The kind of resource described by the manifest.",
         "title": "Kind",
         "type": "string"
      },
      "metadata": {
         "$ref": "#/$defs/SAMUserMetadata",
         "description": "User.metadata[obj]: Required, the User metadata."
      },
      "spec": {
         "$ref": "#/$defs/SAMUserSpec",
         "description": "User.spec[obj]: Required, the User specification."
      },
      "status": {
         "anyOf": [
            {
               "$ref": "#/$defs/SAMUserStatus"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User.status[obj]: Optional, Read-only. Stateful status information about the User."
      }
   },
   "$defs": {
      "SAMUserMetadata": {
         "description": "Smarter API User Manifest - Metadata class.",
         "properties": {
            "name": {
               "description": "The camelCase name of the manifest resource",
               "title": "Name",
               "type": "string"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The description for this resource. Be brief. Keep it under 255 characters.",
               "title": "Description"
            },
            "version": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The semantic version of the manifest. Example: 0.1.0",
               "title": "Version"
            },
            "tags": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The tags of the manifest. Used for generic resource categorization and search. Example: ['tag1', 'tag2']",
               "title": "Tags"
            },
            "annotations": {
               "anyOf": [
                  {
                     "items": {
                        "additionalProperties": {
                           "anyOf": [
                              {
                                 "type": "string"
                              },
                              {
                                 "type": "integer"
                              },
                              {
                                 "type": "number"
                              },
                              {
                                 "type": "boolean"
                              },
                              {
                                 "format": "date",
                                 "type": "string"
                              },
                              {
                                 "format": "date-time",
                                 "type": "string"
                              },
                              {
                                 "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
                                 "type": "string"
                              },
                              {
                                 "format": "uuid",
                                 "type": "string"
                              },
                              {
                                 "format": "binary",
                                 "type": "string"
                              },
                              {
                                 "items": {},
                                 "type": "array"
                              },
                              {
                                 "additionalProperties": true,
                                 "type": "object"
                              }
                           ]
                        },
                        "type": "object"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The manifest annotations. Used for storing arbitrary metadata as\n            key-value pairs. Example: [{'smarter.sh/test-manifest/project-name': 'Scooby dooby do'}]. The\n            key should be a valid url-friendly string. The value accepts\n            multi-line string values (YAML block scalars) and various scalar types including\n            str, int, float, bool, datetime.date, datetime.datetime, decimal.Decimal, uuid.UUID, bytes, list, dict.\n            ",
               "title": "Annotations"
            },
            "username": {
               "description": "User.metadata.username[str]. Required. The Django username of the user.",
               "title": "Username",
               "type": "string"
            }
         },
         "required": [
            "name",
            "description",
            "version",
            "username"
         ],
         "title": "SAMUserMetadata",
         "type": "object"
      },
      "SAMUserSpec": {
         "description": "Smarter API User Manifest User.spec",
         "properties": {
            "config": {
               "$ref": "#/$defs/SAMUserSpecConfig",
               "description": "User.spec.config[object]. The configuration for the User."
            }
         },
         "required": [
            "config"
         ],
         "title": "SAMUserSpec",
         "type": "object"
      },
      "SAMUserSpecConfig": {
         "description": "Smarter API User Manifest User.spec.config",
         "properties": {
            "firstName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "User.spec.configuration.firstName[str]. Optional. The first name of the User.",
               "title": "Firstname"
            },
            "lastName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "User.spec.configuration.lastName[str]. Optional. The last name of the User.",
               "title": "Lastname"
            },
            "email": {
               "description": "User.spec.configuration.email[str]. The email address of the User.",
               "title": "Email",
               "type": "string"
            },
            "isStaff": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": false,
               "description": "User.spec.configuration.isStaff[bool]. Optional. Designates whether the User has admin permissions.",
               "title": "Isstaff"
            },
            "isActive": {
               "description": "User.spec.configuration.isActive[bool]. Designates whether this User should be treated as active.",
               "title": "Isactive",
               "type": "boolean"
            }
         },
         "required": [
            "email",
            "isActive"
         ],
         "title": "SAMUserSpecConfig",
         "type": "object"
      },
      "SAMUserStatus": {
         "description": "Smarter API User Manifest - Status class.",
         "properties": {
            "recordLocator": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "recordLocator[String]: An optional identifier used to locate the resource record associated with this manifest. Read only.",
               "title": "Recordlocator"
            },
            "created": {
               "description": "The date in which this resource was created. Read only.",
               "format": "date-time",
               "title": "Created",
               "type": "string"
            },
            "modified": {
               "description": "The date in which this resource was most recently changed. Read only.",
               "format": "date-time",
               "title": "Modified",
               "type": "string"
            },
            "account_number": {
               "description": "User.status.account_number: The account owner of this User. Read only.",
               "title": "Account Number",
               "type": "string"
            },
            "username": {
               "description": "User.status.account_number: The Smarter user who created this User. Read only.",
               "title": "Username",
               "type": "string"
            }
         },
         "required": [
            "created",
            "modified",
            "account_number",
            "username"
         ],
         "title": "SAMUserStatus",
         "type": "object"
      }
   },
   "required": [
      "apiVersion",
      "kind",
      "metadata",
      "spec"
   ]
}