Skip to content

Vapor Week is coming 14th September!

JWTKit

Core

Vapor AsyncKit RoutingKit ConsoleKit ConsoleKitCommands ConsoleKitTerminal ConsoleLogger beta WebSocketKit MultipartKit

Authentication

JWT JWTKit Authentication

Templating

Database

Fluent FluentKit FluentSQL FluentPostgresDriver FluentMongoDriver FluentMySQLDriver FluentSQLiteDriver SQLKit PostgresKit MySQLKit SQLiteKit PostgresNIO MySQLNIO SQLiteNIO Redis

Queues

Queues QueuesRedisDriver

Push Notifications

Testing

XCTVapor VaporTesting XCTFluent XCTQueues

4.x

4.x 5.0 (beta) beta

JWTKit

Classes
ECDSAKey
JWTSigner
JWTSigners
RSAKey
- Initializers
- convenience init?(modulus: String, exponent: String, privateExponent: String?)
- Type Methods
- static certificate(pem:)
- static `private`(pem:)
- static `public`(pem:)
X5CVerifier
- Initializers
- convenience(rootCertificates:)
- Instance Methods
- func verifyJWS(_:as:)
- func verifyJWS(_:as:jsonDecoder:)
Protocols
JWTAlgorithm
- Instance Properties
- var name: String
- Instance Methods
- func sign<Plaintext>(Plaintext) throws -> [UInt8]
- func verify<Signature, Plaintext>(Signature, signs: Plaintext) throws -> Bool
JWTClaim
- Associated Types
- Value
- Initializers
- init(stringLiteral: String)
- init(value: Self.Value)
  - JWTMultiValueClaim Implementations
    - init(value: Self.Value.Element)
- Instance Properties
- var value: Self.Value
JWTJSONDecoder
- Instance Methods
- func decode<T>(T.Type, from: Data) throws -> T
JWTJSONEncoder
- Instance Methods
- func encode<T>(T) throws -> Data
JWTMultiValueClaim
- Initializers
- init(value: Self.Value.Element)
  - JWTMultiValueClaim Implementations
    - init(value: Self.Value.Element)
JWTPayload
- Instance Methods
- func verify(using: JWTSigner) throws
JWTUnixEpochClaim
Structures
AppleIdentityToken
AudienceClaim
- Initializers
- init(stringLiteral: String)
- init(value: [String])
- Instance Properties
- var value: [String]
- Instance Methods
- func verifyIntendedAudience(includes: String) throws
BoolClaim
- Initializers
- init(booleanLiteral: Bool)
- init(from: any Decoder) throws
- init(stringLiteral: String)
- init(value: Bool)
- Instance Properties
- var value: Bool
EdDSAKey
ExpirationClaim
- Initializers
- init(value: Date)
- Instance Properties
- var value: Date
- Instance Methods
- func verifyNotExpired(currentDate: Date) throws
GoogleHostedDomainClaim
- Initializers
- init(value: String)
- Instance Properties
- var value: String
- Instance Methods
- func verify(domain: String) throws
GoogleIdentityToken
- Initializers
- init(from: any Decoder) throws
- Instance Properties
- let atHash: String?
- let audience: AudienceClaim
- let authorizedPresenter: String
- let email: String?
- let emailVerified: BoolClaim?
- let expires: ExpirationClaim
- let familyName: String?
- let givenName: String?
- let hostedDomain: GoogleHostedDomainClaim?
- let issuedAt: IssuedAtClaim
- let issuer: IssuerClaim
- let locale: LocaleClaim?
- let name: String?
- let nonce: String?
- let picture: String?
- let profile: String?
- let subject: SubjectClaim
- Instance Methods
- func verify(using: JWTSigner) throws
IDClaim
- Initializers
- init(value: String)
- Instance Properties
- var value: String
IssuedAtClaim
- Initializers
- init(value: Date)
- Instance Properties
- var value: Date
IssuerClaim
- Initializers
- init(value: String)
- Instance Properties
- var value: String
JWK
JWKIdentifier
JWKS
- Initializers
- init(from: any Decoder) throws
- init(keys: [JWK])
- Instance Properties
- var keys: [JWK]
- Instance Methods
- func find(identifier:)
- func find(identifier:type:)
LocaleClaim
- Initializers
- init(from: any Decoder) throws
- init(stringLiteral: String)
- init(value: Locale)
- Instance Properties
- var value: Locale
- Instance Methods
- func encode(to: any Encoder) throws
MicrosoftIdentityToken
- Initializers
- init(from: any Decoder) throws
- Instance Properties
- let accessTokenHash: String?
- let audience: AudienceClaim
- let codeHash: String?
- let email: String?
- let expires: ExpirationClaim
- let identityProvider: String?
- let issuedAt: IssuedAtClaim
- let issuer: IssuerClaim
- let name: String?
- let nonce: String?
- let notBefore: NotBeforeClaim
- let objectId: String
- let preferredUsername: String?
- let roles: [String]?
- let subject: SubjectClaim
- let tenantId: String?
- let uniqueName: String?
- let version: String?
- Instance Methods
- func verify(using: JWTSigner) throws
NotBeforeClaim
- Initializers
- init(value: Date)
- Instance Properties
- var value: Date
- Instance Methods
- func verifyNotBefore(currentDate: Date) throws
SubjectClaim
- Initializers
- init(value: String)
- Instance Properties
- var value: String
Enumerations
JWTError
Extended Modules
FoundationEssentials

API Docs
Framework Docs

- API Docs
  
  Reference documentation for Vapor
- Framework Docs
  
  Learn how to use Vapor
Home
Store
Showcase
Team
Blog
GitHub
Theme
- Light
- Dark
- System

Instance Property

locale

The user’s locale, represented by a BCP 47 language tag. Might be provided when a name claim is present.

let locale: LocaleClaim?

Vapor

Reference documentation for Vapor and its ecosystem.

Community

Team
Join our Discord
Store
Showcase
Supporters

Resources

Blog
Framework Docs
API Docs
Press Kit
Help

API Documentation © 2026 Vapor.

Twitter
Mastodon
Bsky
GitHub