SAMSmarterAuthToken

smarter.models.sam.smarterauthtoken

SAM model of the SmarterAuthToken kind, generated from the Smarter platform’s JSON Schema.

Do not edit: run scripts/generate_sam_models.py. See smarter.models.sam.

class smarter.models.sam.smarterauthtoken.SAMDependency

Bases: smarter.models.sam.base.SAMModel

A resource that depends on the resource that a manifest describes.

kind: str

Kind[String]: The SAM kind of the resource that depends on this resource, e.g. LLMClient.

Read only.

name: str

Name[String]: The name of the resource that depends on this resource.

Read only.

class smarter.models.sam.smarterauthtoken.SAMSmarterAuthTokenMetadata

Bases: smarter.models.sam.base.SAMModel

Smarter API SmarterAuthToken Manifest - Metadata class.

annotations: None | list[dict[str, str | int | float | bool | datetime.date | datetime.datetime | Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$')] | uuid.UUID | bytes | list | dict[str, Any]]]

The manifest annotations.

Used for storing arbitrary metadata as

key-value pairs. Example: [{‘smarter.sh/test-manifest/project-name’: ‘Scooby dooby do’}]. The key should be a valid url-friendly string. The value accepts multi-line string values (YAML block scalars) and various scalar types including str, int, float, bool, datetime.date, datetime.datetime, decimal.Decimal, uuid.UUID, bytes, list, dict.

description: str | None

The description for this resource.

Be brief. Keep it under 255 characters.

name: str

The camelCase name of the manifest resource.

tags: list[str] | None

The tags of the manifest.

Used for generic resource categorization and search. Example: [‘tag1’, ‘tag2’]

version: str | None

The semantic version of the manifest.

Example: 0.1.0

class smarter.models.sam.smarterauthtoken.SAMSmarterAuthTokenSpecConfig

Bases: smarter.models.sam.base.SAMModel

Smarter API SmarterAuthToken Manifest SmarterAuthToken.spec.config.

isActive: bool | None

SmarterAuthToken.spec.configuration.isActive[bool].

Required. Whether the SmarterAuthToken is activated.

username: str

SmarterAuthToken.spec.configuration.username[str].

The Smarter username to which this SmarterAuthToken is attached.

class smarter.models.sam.smarterauthtoken.SAMSmarterAuthTokenStatus

Bases: smarter.models.sam.base.SAMModel

Smarter API SmarterAuthToken Manifest - Status class.

created: datetime

The date in which this resource was created.

Read only.

dependencies: list[smarter.models.sam.smarterauthtoken.SAMDependency] | None

Dependencies[List]: The resources that depend on this resource, and that must be deleted, or stop referring to it, before it can be deleted.

Lists only the resources that you can read. Read only.

lastUsedAt: datetime.datetime | None

SmarterAuthToken.status.modified: The date in which this SmarterAuthToken was most recently used for authentication.

Read only.

modified: datetime

The date in which this resource was most recently changed.

Read only.

recordLocator: str

RecordLocator[String]: An optional identifier used to locate the resource record associated with this manifest.

Read only.

class smarter.models.sam.smarterauthtoken.SAMSmarterAuthTokenSpec

Bases: smarter.models.sam.base.SAMModel

Smarter API SmarterAuthToken Manifest SmarterAuthToken.spec.

config: SAMSmarterAuthTokenSpecConfig

SmarterAuthToken.spec.config[object].

The configuration for the SmarterAuthToken.

class smarter.models.sam.smarterauthtoken.SAMSmarterAuthToken

Bases: smarter.models.sam.base.SAMModel

Smarter API Manifest - SmarterAuthToken.

apiVersion: str

ApiVersion[String]: Required.

The API version of the AbstractSAMBase.

kind: str

Kind[String]: Required.

The kind of resource described by the manifest.

metadata: SAMSmarterAuthTokenMetadata

SmarterAuthToken.metadata[obj]: Required, the SmarterAuthToken metadata.

spec: SAMSmarterAuthTokenSpec

SmarterAuthToken.spec[obj]: Required, the SmarterAuthToken specification.

status: smarter.models.sam.smarterauthtoken.SAMSmarterAuthTokenStatus | None

SmarterAuthToken.status[obj]: Optional, Read-only.

Stateful status information about the SmarterAuthToken.