Documentation

    
{
    "$defs": {
        "SAMUserMetadata": {
            "description": "Smarter API User Manifest - Metadata class.",
            "properties": {
                "name": {
                    "description": "The camelCase name of the manifest resource",
                    "title": "Name",
                    "type": "string"
                },
                "description": {
                    "description": "The description for this resource. Be brief. Keep it under 255 characters.",
                    "title": "Description",
                    "type": "string"
                },
                "version": {
                    "description": "The semantic version of the manifest. Example: 0.1.0",
                    "title": "Version",
                    "type": "string"
                },
                "tags": {
                    "anyOf": [
                        {
                            "items": {
                                "type": "string"
                            },
                            "type": "array"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "default": null,
                    "description": "The tags of the manifest. These are fully functional but are not currently used. Example: [tag1, tag2]",
                    "title": "Tags"
                },
                "annotations": {
                    "anyOf": [
                        {
                            "items": {
                                "type": "string"
                            },
                            "type": "array"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "default": null,
                    "description": "The manifest annotations. These are fully functional but are not currently used.",
                    "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": {
                "account_number": {
                    "default": null,
                    "description": "User.status.account_number: The account owner of this User. Read only.",
                    "title": "Account Number",
                    "type": "string"
                },
                "username": {
                    "default": null,
                    "description": "User.status.account_number: The Smarter user who created this User. Read only.",
                    "title": "Username",
                    "type": "string"
                },
                "created": {
                    "default": null,
                    "description": "User.status.created: The date in which this User was created. Read only.",
                    "format": "date-time",
                    "title": "Created",
                    "type": "string"
                },
                "modified": {
                    "default": null,
                    "description": "User.status.modified: The date in which this User was most recently changed. Read only.",
                    "format": "date-time",
                    "title": "Modified",
                    "type": "string"
                }
            },
            "title": "SAMUserStatus",
            "type": "object"
        }
    },
    "description": "Smarter API Manifest - User",
    "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"
                }
            ],
            "description": "User.status[obj]: Optional, Read-only. Stateful status information about the User."
        }
    },
    "required": [
        "apiVersion",
        "kind",
        "metadata",
        "spec",
        "status"
    ],
    "title": "SAMUser",
    "type": "object"
}