View on GitHub
TokenStringData Structure Reference
TokenStringData
public struct TokenStringData : ContentUsed to return a token string for use in HTTP Bearer Authentication.
Clients can use the userID field to validate the user that logged in matches the user they thiought was logging in.
This guards against a situation where one user changes their username to the previous username value
of another user. A client using /client/user/updates/since could end up associating a login with the wrong
User because they were matching on username instead of userID. That is, a user picks a username and logs in
with their own password. Their client has a (out of date) stored User record, for a different user, that had the same username.
Returned by:
POST /api/v3/auth/loginPOST /api/v3/auth/recovery
See AuthController.loginHandler(_:) and AuthController.recoveryHandler(_:data:).
-
The user ID of the newly logged in user.
Declaration
Swift
var userID: UUID -
The user’s access level.
Declaration
Swift
var accessLevel: UserAccessLevel -
The token string.
Declaration
Swift
let token: String -
Creates a
TokenStringDatafrom aUserAccessLeveland aToken. The Token must be associated with aUser, but the User object does not need to be attached.Declaration
Swift
init(accessLevel: UserAccessLevel, token: Token) -
Declaration
Swift
init?(cacheUser: UserCacheData)