Documentation

    
{
    "$defs": {
        "SAMSmarterAuthTokenMetadata": {
            "description": "Smarter API SmarterAuthToken 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"
                }
            },
            "required": [
                "name",
                "description",
                "version"
            ],
            "title": "SAMSmarterAuthTokenMetadata",
            "type": "object"
        },
        "SAMSmarterAuthTokenSpec": {
            "description": "Smarter API SmarterAuthToken Manifest SmarterAuthToken.spec",
            "properties": {
                "config": {
                    "$ref": "#/$defs/SAMSmarterAuthTokenSpecConfig",
                    "description": "SmarterAuthToken.spec.config[object]. The configuration for the SmarterAuthToken."
                }
            },
            "required": [
                "config"
            ],
            "title": "SAMSmarterAuthTokenSpec",
            "type": "object"
        },
        "SAMSmarterAuthTokenSpecConfig": {
            "description": "Smarter API SmarterAuthToken Manifest SmarterAuthToken.spec.config",
            "properties": {
                "isActive": {
                    "default": false,
                    "description": "SmarterAuthToken.spec.configuration.isActive[bool]. Required. Whether the SmarterAuthToken is activated.",
                    "title": "Isactive",
                    "type": "boolean"
                },
                "username": {
                    "description": "SmarterAuthToken.spec.configuration.username[str]. The Smarter username to which this SmarterAuthToken is attached.",
                    "title": "Username",
                    "type": "string"
                }
            },
            "required": [
                "username"
            ],
            "title": "SAMSmarterAuthTokenSpecConfig",
            "type": "object"
        },
        "SAMSmarterAuthTokenStatus": {
            "description": "Smarter API SmarterAuthToken Manifest - Status class.",
            "properties": {
                "created": {
                    "anyOf": [
                        {
                            "format": "date-time",
                            "type": "string"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "SmarterAuthToken.status.created: The date in which this SmarterAuthToken was created. Read only.",
                    "title": "Created"
                },
                "modified": {
                    "anyOf": [
                        {
                            "format": "date-time",
                            "type": "string"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "SmarterAuthToken.status.modified: The date in which this SmarterAuthToken was most recently changed. Read only.",
                    "title": "Modified"
                },
                "lastUsedAt": {
                    "anyOf": [
                        {
                            "format": "date-time",
                            "type": "string"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "SmarterAuthToken.status.modified: The date in which this SmarterAuthToken was most recently used for authentication. Read only.",
                    "title": "Lastusedat"
                }
            },
            "required": [
                "created",
                "modified",
                "lastUsedAt"
            ],
            "title": "SAMSmarterAuthTokenStatus",
            "type": "object"
        }
    },
    "description": "Smarter API Manifest - SmarterAuthToken",
    "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/SAMSmarterAuthTokenMetadata",
            "description": "SmarterAuthToken.metadata[obj]: Required, the SmarterAuthToken metadata."
        },
        "spec": {
            "$ref": "#/$defs/SAMSmarterAuthTokenSpec",
            "description": "SmarterAuthToken.spec[obj]: Required, the SmarterAuthToken specification."
        },
        "status": {
            "anyOf": [
                {
                    "$ref": "#/$defs/SAMSmarterAuthTokenStatus"
                },
                {
                    "type": "null"
                }
            ],
            "description": "SmarterAuthToken.status[obj]: Optional, Read-only. Stateful status information about the SmarterAuthToken."
        }
    },
    "required": [
        "apiVersion",
        "kind",
        "metadata",
        "spec",
        "status"
    ],
    "title": "SAMSmarterAuthToken",
    "type": "object"
}