Token

final class Token : Model, @unchecked Sendable

extension Token: ModelTokenAuthenticatable

A Token model associates a randomly generated string with a User.

A Token is generated upon each login, and revoked by deletion upon each logout. The .token value is used in between those events in an HTTP Bearer Authorization header field to authenticate the user sending API requests. There is no identifying user info in a .token; the association to a specific User is done internally on the API server through this model.

Show on GitHub

schema
Declaration
Swift

static let schema: String
Show on GitHub

Properties

id
The Token’s ID, provisioned automatically.
Declaration
Swift

@Token .ID var id: UUID? { get set }
Show on GitHub
token
The generated token value.
Declaration
Swift

@Token .Field var token: String { get set }
Show on GitHub
user
The User associated to the Token.
Declaration
Swift

@Token .Parent var user: User { get set }
Show on GitHub
createdAt
Timestamp of the model’s creation, set automatically.
Declaration
Swift

@Token .Timestamp var createdAt: Date? { get set }
Show on GitHub

Initializaton

init()
Declaration
Swift

init()
Show on GitHub


                    
                    
                    init(token:user:)

Initializes a new Token.

Declaration

Swift

init(token: String, user: User) throws

Parameters

`token`	The generated token string.
`user`	The `User` associated to the token.

Show on GitHub


                    
                    
                    init(token:userID:)

Initializes a new Token.

Declaration

Swift

init(token: String, userID: UUID)

Parameters

`token`	The generated token string.
`userID`	The `User` associated to the token.

Show on GitHub

valueKey
Required key for HTTP Bearer Authorization token.
Declaration
Swift

static let valueKey: KeyPath<Token, Field<String>>
Show on GitHub


                    
                    
                    userKey

Declaration

Swift

static let userKey: KeyPath<Token, Parent<User>>

Show on GitHub

isValid
Declaration
Swift

var isValid: Bool { get }
Show on GitHub

Methods


                    
                    
                    generate(for:length:)

Creates a new random Token.

Declaration

Swift

static func generate(for user: User, length: Int = 16) throws -> Token

Parameters

`user`	The `User` to be associated with this `Token`.
`length`	Desired length of token data, defaults to 16.

Return Value

A Token object.

Show on GitHub