Skip to main content

Log in

POST 

/auth/simple/login

Logs in the user and creates an active session

Request

Body

required

loginSchema

    username stringrequired

    The username trying to log in

    Example: user
    password stringrequired

    The password of the user trying to log in

    Example: hunter2

Responses

userSchema

Schema

    id integerrequired

    The user id

    Example: 123
    isAPI booleandeprecated

    Deprecated in v5. Used internally to know which operations the user should be allowed to perform

    Example: true
    name stringnullable

    Name of the user

    Example: User
    email string

    Email of the user

    Example: user@example.com
    username stringnullable

    A unique username for the user

    Example: hunter
    imageUrl string

    URL used for the user profile image

    Example: https://example.com/242x200.png
    inviteLink string

    If the user is actively inviting other users, this is the link that can be shared with other users

    Example: http://localhost:4242/invite-link/some-secret
    loginAttempts integer

    How many unsuccessful attempts at logging in has the user made

    Example: 3
    emailSent boolean

    Is the welcome email sent to the user or not

    Example: false
    rootRole integer

    Which root role this user is assigned

    Example: 1
    seenAt date-timenullable

    The last time this user logged in

    Example: 2023-06-30T11:42:00.345Z
    createdAt date-time

    The user was created at this time

    Example: 2023-06-30T11:41:00.123Z
    accountType string

    A user is either an actual User or a Service Account

    Example: User
    permissions string[]

    Deprecated

    scimId stringnullable

    The SCIM ID of the user, only present if managed by SCIM

    Example: 01HTMEXAMPLESCIMID7SWWGHN6
Loading...