Skip to main content

LoginResponse

Login response with JWT token

accessTokenstringrequired

JWT access token

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ
expiresIninteger<int64>required

Token expiry in seconds

Possible values: >= 0

Example: 86400
tokenTypestringrequired

Token type (always "Bearer")

Example: Bearer
user objectrequired

User information

emailstringrequired

Email address

Example: admin@example.com
emailVerifiedbooleanrequired

Whether email has been verified

Example: true
idstring<uuid>required

User unique identifier

Example: 550e8400-e29b-41d4-a716-446655440000
permissionsstring[]required

Custom permissions granted to the user (in addition to role permissions)

Example: ["libraries:write","series:delete"]
rolestringrequired

User role (reader, maintainer, admin)

Example: admin
usernamestringrequired

Username

Example: admin
LoginResponse
{
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ",
"expiresIn": 86400,
"tokenType": "Bearer",
"user": {
"email": "admin@example.com",
"emailVerified": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"permissions": [
"libraries:write",
"series:delete"
],
"role": "admin",
"username": "admin"
}
}