description:Checking and setting user availability
- name:Booking
description:Create and manage bookings
- name:Integrations
description:Manage integrations
- name:User
description:Manage the user's profile and settings
paths:
/api/auth/signin:
get:
description:Displays the sign in page.
summary:Displays the sign in page
tags:
- Authentication
/api/auth/signin/:provider:
post:
description:Starts an OAuth signin flow for the specified provider. The POST submission requires CSRF token from /api/auth/csrf.
summary:Starts an OAuth signin flow for the specified provider
tags:
- Authentication
/api/auth/callback/:provider:
get:
description:Handles returning requests from OAuth services during sign in. For OAuth 2.0 providers that support the state option, the value of the state parameter is checked against the one that was generated when the sign in flow was started - this uses a hash of the CSRF token which MUST match for both the POST and GET calls during sign in.
summary:Handles returning requests from OAuth services
tags:
- Authentication
/api/auth/signout:
get:
description:Displays the sign out page.
summary:Displays the sign out page
tags:
- Authentication
post:
description:Handles signing out - this is a POST submission to prevent malicious links from triggering signing a user out without their consent. Handles signing out - this is a POST submission to prevent malicious links from triggering signing a user out without their consent.
summary:Handles signing out
tags:
- Authentication
/api/auth/session:
get:
description:Returns client-safe session object - or an empty object if there is no session. The contents of the session object that is returned are configurable with the session callback.
summary:Returns client-safe session object
tags:
- Authentication
/api/auth/csrf:
get:
description:Returns object containing CSRF token. In NextAuth.js, CSRF protection is present on all authentication routes. It uses the "double submit cookie method", which uses a signed HttpOnly, host-only cookie. The CSRF token returned by this endpoint must be passed as form variable named csrfToken in all POST submissions to any API endpoint.
summary:Returns object containing CSRF token
tags:
- Authentication
/api/auth/providers:
get:
description:Returns a list of configured OAuth services and details (e.g. sign in and callback URLs) for each service. It can be used to dynamically generate custom sign up pages and to check what callback URLs are configured for each OAuth provider that is configured.
summary:Returns configured OAuth services
tags:
- Authentication
/api/auth/changepw:
post:
description:Changes the password for the currently logged in account.
summary:Changes the password for the currently logged in account
tags:
- Authentication
/api/availability/:user:
get:
description:Gets the busy times for a particular user, by username.
summary:Gets the busy times for a user
tags:
- Availability
/api/availability/day:
patch:
description:Updates the start and end times for a user's availability.
