All API categories

    AuthKit API

    25 endpoints

    Public authentication kit endpoints.

    POST
    Auth Required

    authKit.create

    authKit.create

    Endpoint

    /admin/collection/{collectionId}/authKit

    Parameters

    collectionId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "AuthKitConfig"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    authKit.get

    authKit.get

    Endpoint

    /admin/collection/{collectionId}/authKit/{authKitId}

    Parameters

    collectionId
    path
    string
    Required
    authKitId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "AuthKitConfig"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    PUT
    Auth Required

    authKit.update

    authKit.update

    Endpoint

    /admin/collection/{collectionId}/authKit/{authKitId}

    Parameters

    collectionId
    path
    string
    Required
    authKitId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "AuthKitConfig"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    DELETE
    Auth Required

    authKit.remove

    authKit.remove

    Endpoint

    /admin/collection/{collectionId}/authKit/{authKitId}

    Parameters

    collectionId
    path
    string
    Required
    authKitId
    path
    string
    Required

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    authKit.load

    authKit.load

    Endpoint

    /authKit/{authKitId}/config

    Parameters

    authKitId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "AuthKitConfig"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    authKit.changeEmail

    authKit.changeEmail

    Endpoint

    /authkit/{clientId}/account/change-email

    Parameters

    clientId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "SuccessResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    authKit.changePassword

    authKit.changePassword

    Endpoint

    /authkit/{clientId}/account/change-password

    Parameters

    clientId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "SuccessResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    authKit.deleteAccount

    authKit.deleteAccount

    Endpoint

    /authkit/{clientId}/account/delete

    Parameters

    clientId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "SuccessResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    authKit.getProfile

    authKit.getProfile

    Endpoint

    /authkit/{clientId}/account/profile

    Parameters

    clientId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "UserProfile"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    authKit.updatePhone

    authKit.updatePhone

    Endpoint

    /authkit/{clientId}/account/update-phone

    Parameters

    clientId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "SuccessResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    authKit.updateProfile

    authKit.updateProfile

    Endpoint

    /authkit/{clientId}/account/update-profile

    Parameters

    clientId
    path
    string
    Required
    body
    body
    ProfileUpdateData
    Required

    See ProfileUpdateData schema

    Responses

    200
    Success
    {
  "schema": "UserProfile"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    authKit.verifyEmailChange

    authKit.verifyEmailChange

    Endpoint

    /authkit/{clientId}/account/verify-email-change

    Parameters

    clientId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "SuccessResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    authKit.completePasswordReset

    authKit.completePasswordReset

    Endpoint

    /authkit/{clientId}/auth/complete-reset

    Parameters

    clientId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "PasswordResetCompleteResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Namespace containing helper functions for the new AuthKit API.

    Namespace containing helper functions for the new AuthKit API.

    Endpoint

    /authkit/{clientId}/auth/google

    Parameters

    clientId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "AuthLoginResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Namespace containing helper functions for the new AuthKit API.

    Namespace containing helper functions for the new AuthKit API.

    Endpoint

    /authkit/{clientId}/auth/login

    Parameters

    clientId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "AuthLoginResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Send a magic link email to the user (public).

    Send a magic link email to the user (public).

    Endpoint

    /authkit/{clientId}/auth/phone/send-code

    Parameters

    clientId
    path
    string
    Required
    POST
    Auth Required

    Verify a magic link token and authenticate/create the user (public).

    Verify a magic link token and authenticate/create the user (public).

    Endpoint

    /authkit/{clientId}/auth/phone/verify

    Parameters

    clientId
    path
    string
    Required
    POST
    Auth Required

    Namespace containing helper functions for the new AuthKit API.

    Namespace containing helper functions for the new AuthKit API.

    Endpoint

    /authkit/{clientId}/auth/register

    Responses

    200
    Success
    {
  "schema": "AuthLoginResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    authKit.resendEmailVerification

    authKit.resendEmailVerification

    Endpoint

    /authkit/{clientId}/auth/resend-verification
    POST
    Auth Required

    Send phone verification code (public).

    Send phone verification code (public).

    Endpoint

    /authkit/{clientId}/auth/reset-password

    Responses

    200
    Success
    {
  "schema": "PasswordResetRequestResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    authKit.sendEmailVerification

    authKit.sendEmailVerification

    Endpoint

    /authkit/{clientId}/auth/send-verification

    Parameters

    clientId
    path
    string
    Required
    body
    body
    object
    Required

    Request body

    POST
    Auth Required

    authKit.verifyEmail

    authKit.verifyEmail

    Endpoint

    /authkit/{clientId}/auth/verify-email
    POST
    Auth Required

    authKit.verifyResetToken

    authKit.verifyResetToken

    Endpoint

    /authkit/{clientId}/auth/verify-reset-token