{apiCalls.quantity.toLocaleString()} / 10,000 API calls used

); } ``` {/* END_PLATFORM */} ## Usage Notes ### Payment Flow When using `createCheckoutUrl()`, the typical flow is: 1. **Create checkout URL**: Call `createCheckoutUrl()` with the desired product ID 2. **Redirect to Stripe**: Direct the user to the returned URL 3. **User completes payment**: Stripe handles the payment process 4. **Webhook processing**: Stack Auth receives webhook notifications from Stripe 5. **Item allocation**: Purchased items are automatically added to the customer's account 6. **User returns**: User is redirected back to your application ### Item Management Items are automatically managed through the payment system: * **Purchases**: When a user completes a purchase, associated items are automatically added * **Subscriptions**: Recurring subscriptions automatically replenish items at the specified intervals * **Manual allocation**: Server-side code can manually adjust item quantities using [`ServerItem`](../types/item.mdx#serveritem) methods ### Security Considerations * **Client-side safety**: All payment operations are designed to be safe for client-side use * **Server validation**: Critical operations should always be validated on the server side * **Race conditions**: Use [`tryDecreaseQuantity()`](../types/item.mdx#serveritemtrydecreasequantity) for atomic, race-condition-free item consumption # Email URL: /docs/sdk/types/email Source: /vercel/path0/docs/content/docs/sdk/types/email.mdx *** title: Email full: true ---------- This is a detailed reference for email-related types in Stack Auth. If you're looking for a more high-level overview, please refer to our [guide on the email system](../../concepts/emails.mdx). On this page: * [SendEmailOptions](#sendemailoptions) *** # `SendEmailOptions` Options for sending emails via the `sendEmail` method on `StackServerApp`. ### Table of Contents ; //$stack-link-to:#sendemailoptionsvariables };`} /> An array of user IDs that will receive the email. All users must exist in your Stack Auth project. ```typescript userIds: string[] ``` ```typescript { userIds: ['user-1', 'user-2', 'user-3'], // ... other options } ``` Optional theme ID to apply to the email. Use `null` for no theme, `false` to use the default theme, or a string ID for a specific theme. ```typescript themeId?: string | null | false ``` ```typescript { themeId: 'corporate-theme-id', // or themeId: null, // no theme // or themeId: false, // default theme // ... other options } ``` Optional email subject line. If using a template, this overrides the template's default subject. ```typescript subject?: string ``` ```typescript { subject: 'Welcome to our platform!', // ... other options } ``` Optional notification category name for user preferences. Users can opt in or out of specific categories through their account settings. ```typescript notificationCategoryName?: string ``` ```typescript { notificationCategoryName: 'product_updates', // ... other options } ``` Custom HTML content for the email. Use this option when you want to send a custom HTML email instead of using a template. Cannot be used together with `templateId` or `variables`. ```typescript html?: string ``` ```typescript { userIds: ['user-1'], html: '

Welcome!

Thanks for joining us.

', subject: 'Welcome to our platform' } ``` ID of the email template to use. Use this option when you want to send a template-based email with variables. Cannot be used together with `html`. ```typescript templateId?: string ``` ```typescript { userIds: ['user-1'], templateId: 'welcome-template', variables: { userName: 'John Doe', activationUrl: 'https://app.com/activate/token123' } } ``` Optional variables to substitute in the template. Only used when `templateId` is provided. ```typescript variables?: Record ``` ```typescript { templateId: 'welcome-template', variables: { userName: 'John Doe', activationUrl: 'https://app.com/activate/token123', supportEmail: 'support@yourapp.com' } } ``` # Item URL: /docs/sdk/types/item Source: /vercel/path0/docs/content/docs/sdk/types/item.mdx *** title: Item full: true ---------- Items represent quantifiable resources in your application, such as credits, API calls, storage quotas, or subscription allowances. They can be associated with users, teams, or custom customers and are managed through Stack Auth's payment system. On this page: * [Item](#item) * [ServerItem](#serveritem) *** # `Item` The `Item` type represents a quantifiable resource that can be consumed or managed within your application. Items are typically obtained through purchases, subscriptions, or manual allocation. Items can be retrieved through: * [`user.getItem()`](../types/user.mdx#currentusergetitem) * [`user.useItem()`](../types/user.mdx#currentuseruseitem) (React hook) * [`team.getItem()`](../types/team.mdx#teamgetitem) * [`team.useItem()`](../types/team.mdx#teamuseitem) (React hook) ### Table of Contents The human-readable name of the item as configured in your Stack Auth project settings. ```typescript declare const displayName: string; ``` The current quantity of the item. This value can be negative, which is useful for tracking overdrafts or pending charges. For example, if a user has 100 credits but makes a purchase that costs 150 credits, the quantity might temporarily be -50 until the purchase is processed. ```typescript declare const quantity: number; ``` The quantity clamped to a minimum of 0. This is equivalent to `Math.max(0, quantity)` and is useful for display purposes when you don't want to show negative values to users. Use this when you want to display available resources without confusing users with negative numbers. ```typescript declare const nonNegativeQuantity: number; ``` ***

# `ServerItem` The `ServerItem` type extends `Item` with additional server-side methods for modifying quantities. This type is only available in server-side contexts and provides race-condition-safe operations for managing item quantities. Server items can be retrieved through: * [`serverUser.getItem()`](../types/user.mdx#serverusergetitem) * [`serverUser.useItem()`](../types/user.mdx#serveruseruseitem) (React hook) * [`serverTeam.getItem()`](../types/team.mdx#serverteamgetitem) * [`serverTeam.useItem()`](../types/team.mdx#serverteamuseitem) (React hook) ### Table of Contents ; //$stack-link-to:#serveritemincreasequantity decreaseQuantity(amount): Promise; //$stack-link-to:#serveritemdecreasequantity tryDecreaseQuantity(amount): Promise; //$stack-link-to:#serveritemtrydecreasequantity };`} /> Increases the item quantity by the specified amount. This operation is atomic and safe for concurrent use. ### Parameters The amount to increase the quantity by. Must be a positive number. ### Returns `Promise` ```typescript declare function increaseQuantity(amount: number): Promise; ``` ```typescript Adding credits to a user const user = await stackServerApp.getUser({ userId: "user_123" }); const credits = await user.getItem("credits"); // Add 100 credits await credits.increaseQuantity(100); ``` Decreases the item quantity by the specified amount. This operation allows the quantity to go negative. **Note**: If you want to prevent the quantity from going below zero, use [`tryDecreaseQuantity()`](#serveritemtrydecreasequantity) instead, as it provides race-condition-free protection against negative quantities. ### Parameters The amount to decrease the quantity by. Must be a positive number. ### Returns `Promise` ```typescript declare function decreaseQuantity(amount: number): Promise; ``` ```typescript Consuming user credits const user = await stackServerApp.getUser({ userId: "user_123" }); const credits = await user.getItem("credits"); // Consume 50 credits (allows negative balance) await credits.decreaseQuantity(50); ``` Attempts to decrease the item quantity by the specified amount, but only if the result would be non-negative. Returns `true` if the operation succeeded, `false` if it would result in a negative quantity. This method is race-condition-safe and is ideal for implementing prepaid credit systems where you need to ensure sufficient balance before allowing an operation. ### Parameters The amount to decrease the quantity by. Must be a positive number. ### Returns `Promise`: `true` if the quantity was successfully decreased, `false` if the operation would result in a negative quantity. ```typescript declare function tryDecreaseQuantity(amount: number): Promise; ``` ```typescript Safe credit consumption const user = await stackServerApp.getUser({ userId: "user_123" }); const credits = await user.getItem("credits"); // Try to consume 50 credits, only if sufficient balance const success = await credits.tryDecreaseQuantity(50); if (success) { console.log("Credits consumed successfully"); // Proceed with the operation } else { console.log("Insufficient credits"); // Handle insufficient balance throw new Error("Not enough credits available"); } ``` ```typescript API rate limiting with credits async function handleApiCall(userId: string) { const user = await stackServerApp.getUser({ userId }); const apiCalls = await user.getItem("api_calls"); // Check if user has API calls remaining const canProceed = await apiCalls.tryDecreaseQuantity(1); if (!canProceed) { throw new Error("API rate limit exceeded. Please upgrade your plan."); } // Process the API call return processApiRequest(); } ``` # Project URL: /docs/sdk/types/project Source: /vercel/path0/docs/content/docs/sdk/types/project.mdx *** title: Project full: true ---------- The `Project` object contains the information and configuration of a project, such as the name, description, and enabled authentication methods. Each [Stack app](../../concepts/stack-app.mdx) corresponds to a project. You can obtain its `Project` object by calling [`stackApp.getProject()`](../objects/stack-app.mdx#stackappgetproject) or [`stackApp.useProject()`](../objects/stack-app.mdx#stackappuseproject) {/* THIS_LINE_PLATFORM react-like */} . ### Table of Contents *** The unique ID of the project as a `string`. ```typescript declare const id: string; ``` The display name of the project as a `string`. ```typescript declare const displayName: string; ``` The configuration settings for the project. ### Properties Indicates if sign-up is enabled for the project. Specifies if credential-based authentication is enabled for the project. States whether magic link authentication is enabled for the project. Determines if client-side team creation is permitted within the project. Indicates if client-side user deletion is enabled for the project. ```typescript declare const config: { signUpEnabled: boolean; credentialEnabled: boolean; magicLinkEnabled: boolean; clientTeamCreationEnabled: boolean; clientUserDeletionEnabled: boolean; }; ``` # TeamPermission URL: /docs/sdk/types/team-permission Source: /vercel/path0/docs/content/docs/sdk/types/team-permission.mdx *** title: TeamPermission full: true ---------- The `TeamPermission` object represents a permission that a user has within a team. Currently, it contains only an `id` to specify the permission. You can get `TeamPermission` objects by calling functions such as `user.getPermission(...)` or `user.listPermissions()`. ### Table of Contents *** The identifier of the permission as a `string`. ```typescript declare const id: string; ``` # TeamProfile URL: /docs/sdk/types/team-profile Source: /vercel/path0/docs/content/docs/sdk/types/team-profile.mdx *** title: TeamProfile full: true ---------- This is a detailed reference for the `TeamProfile` and `ServerTeamProfile` objects. On this page: * [TeamProfile](#teamprofile) * [ServerTeamProfile](#serverteamprofile) # `TeamProfile` The `TeamProfile` object represents the profile of a user within the context of a team. It includes the user's profile information specific to the team and can be accessed through the `teamUser.teamProfile` property on a `TeamUser` object. ### Table of Contents *** The display name of the user within the team context as a `string` or `null` if no display name is set. ```typescript declare const displayName: string | null; ``` The profile image URL of the user within the team context as a `string`, or `null` if no profile image is set. ```typescript declare const profileImageUrl: string | null; ``` *** # `ServerTeamProfile` The `ServerTeamProfile` object is currently the same as `TeamProfile`. ### Table of Contents *** # TeamUser URL: /docs/sdk/types/team-user Source: /vercel/path0/docs/content/docs/sdk/types/team-user.mdx *** title: TeamUser full: true ---------- On this page: * [TeamUser](#teamuser) * [ServerTeamUser](#serverteamuser) *** # `TeamUser` The `TeamUser` object is used on the client side to represent a user in the context of a team, providing minimal information about the user, including their ID and team-specific profile. It is usually obtained by calling `team.useUsers()` or {/* THIS_LINE_PLATFORM react-like */} `team.listUsers()` on a [`Team` object](../types/team.mdx#team). ### Table of Contents *** The ID of the user. ```typescript declare const id: string; ``` The team profile of the user as a `TeamProfile` object. ```typescript declare const teamProfile: TeamProfile; ``` *** # `ServerTeamUser` The `ServerTeamUser` object is used on the server side to represent a user within a team. Besides the team profile, it also includes all the functionality of a [`ServerUser`](../types/user.mdx#serveruser). It is usually obtained by calling `serverTeam.listUsers()` on a [`ServerTeam` object](../types/team.mdx#serverteam). ### Table of Contents *** The team profile of the user as a `ServerTeamProfile` object. ```typescript declare const teamProfile: ServerTeamProfile; ``` # Team URL: /docs/sdk/types/team Source: /vercel/path0/docs/content/docs/sdk/types/team.mdx *** title: Team full: true ---------- This is a detailed reference for the `Team` object. If you're looking for a more high-level overview, please refer to our [guide on teams](../../concepts/orgs-and-teams.mdx). On this page: * [Team](#team) * [ServerTeam](#serverteam) *** # `Team` A `Team` object contains basic information and functions about a team, to the extent of which a member of the team would have access to it. You can get `Team` objects with the `user.useTeams()` or {/* THIS_LINE_PLATFORM react-like */} `user.listTeams()` functions. The created team will then inherit the permissions of that user; for example, the `team.update(...)` function can only succeed if the user is allowed to make updates to the team. ### Table of Contents ; //$stack-link-to:#teamupdate inviteUser(options): Promise; //$stack-link-to:#teaminviteuser listUsers(): Promise; //$stack-link-to:#teamlistusers // NEXT_LINE_PLATFORM react-like ⤷ useUsers(): TeamUser[]; //$stack-link-to:#teamuseusers listInvitations(): Promise<{ ... }[]>; //$stack-link-to:#teamlistinvitations // NEXT_LINE_PLATFORM react-like ⤷ useInvitations(): { ... }[]; //$stack-link-to:#teamuseinvitations createApiKey(options): Promise; //$stack-link-to:#teamcreateapikey listApiKeys(): Promise; //$stack-link-to:#teamlistapikeys // NEXT_LINE_PLATFORM react-like ⤷ useApiKeys(): TeamApiKey[]; //$stack-link-to:#teamuseapikeys createCheckoutUrl(options): Promise; //$stack-link-to:#teamcreatecheckouturl getItem(itemId): Promise; //$stack-link-to:#teamgetitem // NEXT_LINE_PLATFORM react-like ⤷ useItem(itemId): Item; //$stack-link-to:#teamuseitem };`} /> The team ID as a `string`. This value is always unique. ```typescript declare const id: string; ``` The display name of the team as a `string`. ```typescript declare const displayName: string; ``` The profile image URL of the team as a `string`, or `null` if no profile image is set. ```typescript declare const profileImageUrl: string | null; ``` The client metadata of the team as a `Json` object. ```typescript declare const clientMetadata: Json; ``` The client read-only metadata of the team as a `Json` object. ```typescript declare const clientReadOnlyMetadata: Json; ``` Updates the team information. Note that this operation requires the current user to have the `$update_team` permission. If the user lacks this permission, an error will be thrown. ### Parameters The fields to update. The display name of the team. The profile image URL of the team. The client metadata of the team. ### Returns `Promise` ```typescript declare function update(options: { displayName?: string; profileImageUrl?: string | null; clientMetadata?: Json; }): Promise; ``` ```typescript Updating team details await team.update({ displayName: 'New Team Name', profileImageUrl: 'https://example.com/profile.png', clientMetadata: { address: '123 Main St, Anytown, USA', }, }); ``` Sends an invitation email to a user to join the team. Note that this operation requires the current user to have the `$invite_members` permission. If the user lacks this permission, an error will be thrown. An invitation email containing a magic link will be sent to the specified user. If the user has an existing account, they will be automatically added to the team upon clicking the link. For users without an account, the link will guide them through the sign-up process before adding them to the team. ### Parameters An object containing multiple properties. The email of the user to invite. The URL where users will be redirected after accepting the team invitation. Required when calling `inviteUser()` in the server environment since the URL cannot be automatically determined. Example: `https://your-app-url.com/handler/team-invitation` ### Returns `Promise` ```typescript declare function inviteUser(options: { email: string; callbackUrl?: string; }): Promise; ``` ```typescript Sending a team invitation await team.inviteUser({ email: 'user@example.com', }); ``` Gets a list of users in the team. Note that this operation requires the current user to have the `$read_members` permission. If the user lacks this permission, an error will be thrown. ### Parameters None. ### Returns `Promise` ```typescript declare function listUsers(): Promise; ``` ```typescript Listing team members const users = await team.listUsers(); users.forEach(user => { console.log(user.id, user.teamProfile.displayName); }); ``` {/* IF_PLATFORM next */} Functionally equivalent to [`listUsers()`](#teamlistusers), but as a React hook. ### Parameters None. ### Returns `TeamUser[]` ```typescript declare function useUsers(): TeamUser[]; ``` ```typescript Listing team members in React component const users = team.useUsers(); users.forEach(user => { console.log(user.id, user.teamProfile.displayName); }); ``` {/* END_PLATFORM */} Gets a list of invitations to the team. Note that this operation requires the current user to have the `$read_members` and `$invite_members` permissions. If the user lacks this permission, an error will be thrown. ### Parameters None. ### Returns `Promise<{ id: string, email: string, expiresAt: Date }[]>` ```typescript declare function listInvitations(): Promise<{ id: string, email: string, expiresAt: Date }[]>; ``` ```typescript Listing team invitations const invitations = await team.listInvitations(); invitations.forEach(invitation => { console.log(invitation.id, invitation.email); }); ``` {/* IF_PLATFORM next */} Functionally equivalent to [`listInvitations()`](#teamlistinvitations), but as a React hook. ### Parameters None. ### Returns `{ id: string, email: string, expiresAt: Date }[]` ```typescript declare function useInvitations(): { id: string, email: string, expiresAt: Date }[]; ``` ```typescript Listing team invitations in React component const invitations = team.useInvitations(); invitations.forEach(invitation => { console.log(invitation.id, invitation.email); }); ``` {/* END_PLATFORM */} Creates a new API key for the team. ### Parameters An object containing multiple properties. The name of the API key. The description of the API key. The expiration date of the API key. ### Returns `Promise` ```typescript declare function createApiKey(options: { name: string; description: string; expiresAt: Date; }): Promise; ``` ```typescript Creating a new API key await team.createApiKey({ name: 'New API Key', description: 'This is a new API key', expiresAt: new Date('2024-01-01'), }); ``` Gets a list of API keys for the team. ### Parameters None. ### Returns `Promise` ```typescript declare function listApiKeys(): Promise; ``` ```typescript Listing API keys const apiKeys = await team.listApiKeys(); apiKeys.forEach(key => { console.log(key.id, key.name); }); ``` {/* IF_PLATFORM next */} Functionally equivalent to [`listApiKeys()`](#teamlistapikeys), but as a React hook. ### Parameters None. ### Returns `TeamApiKey[]` ```typescript declare function useApiKeys(): TeamApiKey[]; ``` ```typescript Using API keys in React component const apiKeys = team.useApiKeys(); apiKeys.forEach(key => { console.log(key.id, key.name); }); ``` {/* END_PLATFORM */} Creates a checkout URL for the team to purchase products. This method integrates with Stripe to generate a secure payment link for team-level purchases. Note that this operation requires the current user to have appropriate permissions for team purchases. The specific permission requirements depend on your project configuration. ### Parameters Options for creating the checkout URL. The ID of the product to purchase. ### Returns `Promise`: A URL that redirects to the Stripe checkout page for the specified product. ```typescript declare function createCheckoutUrl(options: { productId: string; }): Promise; ``` ```typescript Team purchasing additional seats const checkoutUrl = await team.createCheckoutUrl({ productId: "prod_team_seats", }); // Redirect to checkout window.location.href = checkoutUrl; ``` Retrieves information about a specific item (such as credits, API quotas, storage limits, etc.) for the team. ### Parameters The ID of the item to retrieve. ### Returns `Promise`: The item object containing display name, quantity, and other details. ```typescript declare function getItem(itemId: string): Promise; ``` ```typescript Checking team API quota const apiQuota = await team.getItem("api_calls"); console.log(`Team has ${apiQuota.quantity} API calls remaining`); if (apiQuota.nonNegativeQuantity < 100) { console.warn("Team is running low on API calls"); } ``` {/* IF_PLATFORM next */} Retrieves information about a specific item for the team, used as a React hook. ### Parameters The ID of the item to retrieve. ### Returns `Item`: The item object containing display name, quantity, and other details. ```typescript declare function useItem(itemId: string): Item; ``` ```typescript Team quota monitoring component function TeamQuotaDisplay({ team }: { team: Team }) { const storage = team.useItem("storage_gb"); return (

Team Storage Usage

{storage.quantity} GB used

Plan: {storage.displayName}

); } ``` {/* END_PLATFORM */} *** # `ServerTeam` Like [`Team`](#team), but with [server permissions](../../concepts/stack-app.mdx#client-vs-server). Has full read and write access to everything. Calling `serverUser.getTeam(...)` and `serverUser.listTeams()` will return `ServerTeam` objects if the user is a [`ServerUser`](../types/user.mdx#serveruser). Alternatively, you can call `stackServerApp.getTeam('team_id_123')` or `stackServerApp.listTeams()` to query all teams of the project. `ServerTeam` extends the `Team` object, providing additional functions and properties as detailed below. It's important to note that while the `Team` object's functions may require specific user permissions, the corresponding functions in `ServerTeam` can be executed without these permission checks. This allows for more flexible and unrestricted team management on the server side. ### Table of Contents ; //$stack-link-to:#serverteamlistusers // NEXT_LINE_PLATFORM react-like ⤷ useUsers(): ServerTeamUser[]; //$stack-link-to:#serverteamuseusers addUser(userId): Promise; //$stack-link-to:#serverteamadduseruserid removeUser(userId): Promise; //$stack-link-to:#serverteamremoveuseruserid delete(): Promise; //$stack-link-to:#serverteamdelete };`} /> The date and time when the team was created. ```typescript declare const createdAt: Date; ``` The server metadata of the team as a `Json` object. ```typescript declare const serverMetadata: Json; ``` Gets a list of users in the team. This is similar to the `listUsers` method on the `Team` object, but it returns `ServerTeamUser` objects instead of `TeamUser` objects and does not require any permissions. ### Parameters None. ### Returns `Promise` ```typescript declare function listUsers(): Promise; ``` ```typescript Listing server team members const users = await team.listUsers(); users.forEach(user => { console.log(user.id, user.teamProfile.displayName); }); ``` {/* IF_PLATFORM next */} Functionally equivalent to [`listUsers()`](#serverteamlistusers), but as a React hook. ### Parameters None. ### Returns `ServerTeamUser[]` ```typescript declare function useUsers(): ServerTeamUser[]; ``` ```typescript Using server team members in React component const users = team.useUsers(); users.forEach(user => { console.log(user.id, user.teamProfile.displayName); }); ``` {/* END_PLATFORM */} Adds a user to the team directly without sending an invitation email. ### Parameters The ID of the user to add. ### Returns `Promise` ```typescript declare function addUser(userId: string): Promise; ``` ```typescript Adding a user to the team await team.addUser('user_id_123'); ``` Removes a user from the team. ### Parameters The ID of the user to remove. ### Returns `Promise` ```typescript declare function removeUser(userId: string): Promise; ``` ### Examples ```typescript Removing a user from the team await team.removeUser('user_id_123'); ``` Deletes the team. ### Parameters None. ### Returns `Promise` ```typescript declare function delete(): Promise; ``` ```typescript Deleting a team await team.delete(); ``` # User URL: /docs/sdk/types/user Source: /vercel/path0/docs/content/docs/sdk/types/user.mdx *** title: User full: true ---------- This is a detailed reference for the `User` object. If you're looking for a more high-level overview, please refer to our guide on users [here](../../getting-started/users.mdx). On this page: * [CurrentUser](#currentuser) * [ServerUser](#serveruser) * [CurrentServerUser](#currentserveruser) # `CurrentUser` Use `useUser()` to get `CurrentUser` (client). Use `stackServerApp.getUser()` to get `CurrentServerUser` (server). ### Table of Contents ; //$stack-link-to:#currentuserupdate updatePassword(data): Promise; //$stack-link-to:#currentuserupdatepassword getAuthorizationHeader(): Promise; //$stack-link-to:#currentusergetauthorizationheader // NEXT_LINE_PLATFORM react-like ⤷ useAuthorizationHeader(): string | null; //$stack-link-to:#currentuseruseauthorizationheader getAuthHeaders(): Promise>; //$stack-link-to:#currentusergetauthheaders getAuthJson(): Promise<{ accessToken: string | null }>; //$stack-link-to:#currentusergetauthjson signOut([options]): Promise; //$stack-link-to:#currentusersignout delete(): Promise; //$stack-link-to:#currentuserdelete getTeam(id): Promise; //$stack-link-to:#currentusergetteam // NEXT_LINE_PLATFORM react-like ⤷ useTeam(id): Team | null; //$stack-link-to:#currentuseruseteam listTeams(): Promise; //$stack-link-to:#currentuserlistteams // NEXT_LINE_PLATFORM react-like ⤷ useTeams(): Team[]; //$stack-link-to:#currentuseruseteams setSelectedTeam(team): Promise; //$stack-link-to:#currentusersetselectedteam createTeam(data): Promise; //$stack-link-to:#currentusercreateteam leaveTeam(team): Promise; //$stack-link-to:#currentuserleaveteam getTeamProfile(team): Promise; //$stack-link-to:#currentusergetteamprofile // NEXT_LINE_PLATFORM react-like ⤷ useTeamProfile(team): EditableTeamMemberProfile; //$stack-link-to:#currentuseruseteamprofile hasPermission(scope, permissionId): Promise; //$stack-link-to:#currentuserhaspermission getPermission(scope, permissionId[, options]): Promise; //$stack-link-to:#currentusergetpermission // NEXT_LINE_PLATFORM react-like ⤷ usePermission(scope, permissionId[, options]): TeamPermission | null; //$stack-link-to:#currentuserusepermission listPermissions(scope[, options]): Promise; //$stack-link-to:#currentuserlistpermissions // NEXT_LINE_PLATFORM react-like ⤷ usePermissions(scope[, options]): TeamPermission[]; //$stack-link-to:#currentuserusepermissions listContactChannels(): Promise; //$stack-link-to:#currentuserlistcontactchannels // NEXT_LINE_PLATFORM react-like ⤷ useContactChannels(): ContactChannel[]; //$stack-link-to:#currentuserusecontactchannels getConnectedAccount(account): Promise; //$stack-link-to:#currentusergetconnectedaccount // NEXT_LINE_PLATFORM react-like ⤷ useConnectedAccount(account): OAuthConnection | null; //$stack-link-to:#currentuseruseconnectedaccount listConnectedAccounts(): Promise; //$stack-link-to:#currentuserlistconnectedaccounts // NEXT_LINE_PLATFORM react-like ⤷ useConnectedAccounts(): OAuthConnection[]; //$stack-link-to:#currentuseruseconnectedaccounts linkConnectedAccount(provider[, options]): Promise; //$stack-link-to:#currentuserlinkconnectedaccount getOrLinkConnectedAccount(provider[, options]): Promise; //$stack-link-to:#currentusergetorlinkconnectedaccount // NEXT_LINE_PLATFORM react-like ⤷ useOrLinkConnectedAccount(provider[, options]): OAuthConnection; //$stack-link-to:#currentuseruseorlinkconnectedaccount createApiKey(options): Promise; //$stack-link-to:#currentusercreateapikey listApiKeys(): Promise; //$stack-link-to:#currentuserlistapikeys // NEXT_LINE_PLATFORM react-like ⤷ useApiKeys(): UserApiKey[]; //$stack-link-to:#currentuseruseapikeys createCheckoutUrl(options): Promise; //$stack-link-to:#currentusercreatecheckouturl getItem(itemId): Promise; //$stack-link-to:#currentusergetitem // NEXT_LINE_PLATFORM react-like ⤷ useItem(itemId): Item; //$stack-link-to:#currentuseruseitem };`} /> The user ID as a `string`. This is the unique identifier of the user. ```typescript declare const id: string; ``` The display name of the user as a `string` or `null` if not set. The user can modify this value. ```typescript declare const displayName: string | null; ``` The primary email of the user as a `string` or `null`. Note that this is not necessarily unique. ```typescript declare const primaryEmail: string | null; ``` A `boolean` indicating whether the primary email of the user is verified. ```typescript declare const primaryEmailVerified: boolean; ``` The profile image URL of the user as a `string` or `null` if no profile image is set. ```typescript declare const profileImageUrl: string | null; ``` The date and time when the user signed up, as a `Date`. ```typescript declare const signedUpAt: Date; ``` A `boolean` indicating whether the user has a password set. ```typescript declare const hasPassword: boolean; ``` The client metadata of the user as an `object`. This metadata is visible on the client side but should not contain sensitive or server-only information. ```typescript declare const clientMetadata: Json; ``` Read-only metadata visible on the client side. This metadata can only be modified on the server side. ```typescript declare const clientReadOnlyMetadata: Json; ``` The currently selected team for the user, if applicable, as a `Team` object or `null` if no team is selected. ```typescript declare const selectedTeam: Team | null; ``` Updates the user information. ### Parameters The fields to update. The new display name for the user. Custom metadata visible to the client. The ID of the team to set as selected, or `null` to clear selection. The URL of the user's new profile image, or `null` to remove it. ### Returns `Promise` ```typescript declare function update(data: { displayName?: string; clientMetadata?: Json; selectedTeamId?: string | null; profileImageUrl?: string | null; }): Promise; ``` ```typescript Updating user details await user.update({ displayName: "New Display Name", clientMetadata: { address: "123 Main St", }, }); ``` Gets the team with the specified ID. ### Parameters The ID of the team to get. ### Returns `Promise`: The team object, or `null` if the team is not found or the user is not a member of the team. ```typescript declare function getTeam(id: string): Promise; ``` ```typescript Getting a team by ID const team = await user.getTeam("teamId"); ``` {/* IF_PLATFORM next */} Gets the team with the given ID. This is the same as `getTeam` but is used as a React hook. ### Parameters The ID of the team to get. ### Returns `Team | null`: The team object, or `null` if the team is not found or the user is not a member of the team. ```typescript declare function useTeam(id: string): Team | null; ``` ```typescript Using a team in a React component const team = user.useTeam("teamId"); ``` {/* END_PLATFORM */} Lists all the teams the user is a member of. ### Parameters None. ### Returns `Promise`: The list of teams. ```typescript declare function listTeams(): Promise; ``` ```typescript Listing all teams const teams = await user.listTeams(); ``` {/* IF_PLATFORM next */} Lists all the teams the user is a member of. This is the same as `listTeams` but is used as a React hook. ### Parameters None. ### Returns `Team[]`: The list of teams. ```typescript declare function useTeams(): Team[]; ``` ```typescript Using teams in a React component const teams = user.useTeams(); ``` {/* END_PLATFORM */} Sets the currently selected team for the user. ### Parameters The team to set as selected, or `null` to clear selection. ### Returns `Promise` ```typescript declare function setSelectedTeam(team: Team | null): Promise; ``` ```typescript Setting the selected team const team = await user.getTeam("team_id_123"); await user.setSelectedTeam(team); ``` Creates a new team for the user. The user will be added to the team and given creator permissions. **Note**: If client-side team creation is disabled in the Stack dashboard, this will throw an error. ### Parameters The data for creating the team. The display name for the team. The URL of the team's profile image, or `null` to remove it. ### Returns `Promise`: The created team. ```typescript declare function createTeam(data: { displayName: string; profileImageUrl?: string | null; }): Promise; ``` ```typescript Creating a new team const team = await user.createTeam({ displayName: "New Team", profileImageUrl: "https://example.com/profile.jpg", }); ``` Allows the user to leave a team. If the user is not a member of the team, this will throw an error. ### Parameters The team to leave. ### Returns `Promise` ```typescript declare function leaveTeam(team: Team): Promise; ``` ```typescript Leaving a team await user.leaveTeam(team); ``` Retrieves the user's profile within a specific team. ### Parameters The team to retrieve the profile for. ### Returns `Promise`: The user's editable profile for the specified team. ```typescript declare function getTeamProfile(team: Team): Promise; ``` ```typescript Getting a team profile const profile = await user.getTeamProfile(team); ``` {/* IF_PLATFORM next */} Retrieves the user's profile within a specific team. This is the same as `getTeamProfile` but is used as a React hook. ### Parameters The team to retrieve the profile for. ### Returns `EditableTeamMemberProfile`: The user's editable profile for the specified team. ```typescript declare function useTeamProfile(team: Team): EditableTeamMemberProfile; ``` ```typescript Using a team profile in React const profile = user.useTeamProfile(team); ``` {/* END_PLATFORM */} Checks if the user has a specific permission for a team. ### Parameters The team to check the permission for. The ID of the permission to check. ### Returns `Promise`: Whether the user has the specified permission. ```typescript declare function hasPermission(scope: Team, permissionId: string): Promise; ``` ```typescript Checking user permission const hasPermission = await user.hasPermission(team, "permissionId"); ``` Retrieves a specific permission for a user within a team. ### Parameters The team to retrieve the permission for. The ID of the permission to retrieve. An object containing multiple properties. Whether to retrieve the permission recursively. Default is `true`. ### Returns `Promise`: The permission object, or `null` if not found. ```typescript declare function getPermission(scope: Team, permissionId: string, options?: { recursive?: boolean }): Promise; ``` ```typescript Getting a permission const permission = await user.getPermission(team, "read_secret_info"); ``` {/* IF_PLATFORM next */} Retrieves a specific permission for a user within a team, used as a React hook. ### Parameters The team to retrieve the permission for. The ID of the permission to retrieve. An object containing multiple properties. Whether to retrieve the permission recursively. Default is `true`. ### Returns `TeamPermission | null`: The permission object, or `null` if not found. ```typescript declare function usePermission(scope: Team, permissionId: string, options?: { recursive?: boolean }): TeamPermission | null; ``` ```typescript Using a permission in React const permission = user.usePermission(team, "read_secret_info"); ``` {/* END_PLATFORM */} Lists all permissions the user has for a specified team. ### Parameters The team to list permissions for. An object containing multiple properties. Whether to list the permissions recursively. Default is `true`. ### Returns `Promise`: An array of permissions. ```typescript declare function listPermissions(scope: Team, options?: { recursive?: boolean }): Promise; ``` ```typescript Listing user permissions const permissions = await user.listPermissions(team); ``` {/* IF_PLATFORM next */} Lists all permissions the user has for a specified team, used as a React hook. ### Parameters The team to retrieve permissions for. An object containing multiple properties. Whether to list the permissions recursively. Default is `true`. ### Returns `TeamPermission[]`: An array of permissions. ```typescript declare function usePermissions(scope: Team, options?: { recursive?: boolean }): TeamPermission[]; ``` ```typescript Using permissions in a React component const permissions = user.usePermissions(team); ``` {/* END_PLATFORM */} Lists all the contact channels of the user. ### Parameters No parameters. ### Returns `Promise`: An array of contact channels. ```typescript declare function listContactChannels(): Promise; ``` ```typescript Listing contact channels const contactChannels = await user.listContactChannels(); ``` {/* IF_PLATFORM next */} Lists all the contact channels of the user, used as a React hook. ### Parameters No parameters. ### Returns `ContactChannel[]`: An array of contact channels. ```typescript declare function useContactChannels(): ContactChannel[]; ``` ```typescript Using contact channels in React const contactChannels = user.useContactChannels(); ``` {/* END_PLATFORM */} Gets a specific connected account by provider and provider account ID. Returns `null` if not found. For more details on connected accounts, see the [ConnectedAccount type reference](../types/connected-account.mdx) and the [OAuth guide](../../apps/oauth). ### Parameters The provider config ID (e.g., `"google"`, `"github"`). The account ID from the OAuth provider. ### Returns `Promise` ```typescript declare function getConnectedAccount(account: { provider: string, providerAccountId: string, }): Promise; ``` ```typescript Getting a connected account const account = await user.getConnectedAccount({ provider: "google", providerAccountId: "123456", }); if (account) { const result = await account.getAccessToken(); } ``` {/* IF_PLATFORM react-like */} React hook version of `getConnectedAccount`. Returns a specific connected account by provider and provider account ID, or `null` if not found. ### Parameters The provider config ID (e.g., `"google"`, `"github"`). The account ID from the OAuth provider. ### Returns `OAuthConnection | null` ```typescript declare function useConnectedAccount(account: { provider: string, providerAccountId: string, }): OAuthConnection | null; ``` ```tsx Using a connected account in React const account = user.useConnectedAccount({ provider: "google", providerAccountId: "123456", }); ``` {/* END_PLATFORM */} Lists all connected accounts for this user. Only returns accounts for providers that have `allowConnectedAccounts` enabled. ### Parameters None. ### Returns `Promise` ```typescript declare function listConnectedAccounts(): Promise; ``` ```typescript Listing connected accounts const accounts = await user.listConnectedAccounts(); for (const account of accounts) { console.log(account.provider, account.providerAccountId); } ``` {/* IF_PLATFORM react-like */} React hook to list all connected accounts for this user. ### Parameters None. ### Returns `OAuthConnection[]` ```typescript declare function useConnectedAccounts(): OAuthConnection[]; ``` ```tsx Using connected accounts in React const accounts = user.useConnectedAccounts(); ``` {/* END_PLATFORM */} Redirects the user to the OAuth flow to link a new connected account. This function always redirects and never returns. ### Parameters The provider to link (e.g., `"google"`, `"github"`). OAuth scopes to request during the linking flow. ### Returns `Promise` (always redirects) ```typescript declare function linkConnectedAccount( provider: string, options?: { scopes?: string[] }, ): Promise; ``` ```typescript Linking a Google account await user.linkConnectedAccount("google", { scopes: ["https://www.googleapis.com/auth/drive.readonly"], }); ``` Gets a connected account for the given provider, or redirects the user to the OAuth flow to link one if none exists or the token/scopes are insufficient. ### Parameters The provider to get or link (e.g., `"google"`, `"github"`). OAuth scopes to require. If the existing account doesn't have these scopes, the user will be redirected to re-authorize. ### Returns `Promise` ```typescript declare function getOrLinkConnectedAccount( provider: string, options?: { scopes?: string[] }, ): Promise; ``` ```typescript Get or link a Google account with Drive access const account = await user.getOrLinkConnectedAccount("google", { scopes: ["https://www.googleapis.com/auth/drive.readonly"], }); const result = await account.getAccessToken(); ``` {/* IF_PLATFORM react-like */} React hook version of `getOrLinkConnectedAccount`. Returns a connected account for the given provider, or redirects the user to link one if none exists or the token/scopes are insufficient. ### Parameters The provider to get or link (e.g., `"google"`, `"github"`). OAuth scopes to require. ### Returns `OAuthConnection` ```typescript declare function useOrLinkConnectedAccount( provider: string, options?: { scopes?: string[] }, ): OAuthConnection; ``` ```tsx Using or linking a connected account in React const account = user.useOrLinkConnectedAccount("google", { scopes: ["https://www.googleapis.com/auth/drive.readonly"], }); const result = account.useAccessToken(); ``` {/* END_PLATFORM */} Creates a new API key for the user, which can be used for programmatic access to your application's backend. ### Parameters Options for creating the API key. A human-readable description of the API key's purpose. The date when the API key will expire. Use null for keys that don't expire. Whether the API key is public. Defaults to false. * **Secret API Keys** (default) begin with `sk_` and are monitored by Stack Auth's secret scanner, which can revoke them if detected in public code repositories. * **Public API Keys** begin with `pk_` and are designed for client-side code where exposure is not a concern. ### Returns `Promise`: The newly created API key. Note that this is the only time the full API key value will be visible. ```typescript declare function createApiKey(options: { description: string; expiresAt: Date | null; isPublic?: boolean; }): Promise; ``` ```typescript Creating an API key const apiKey = await user.createApiKey({ description: "Backend integration", expiresAt: new Date(Date.now() + 90 * 24 * 60 * 60 * 1000), // 90 days isPublic: false, }); // Save the API key value securely, as it won't be retrievable later console.log("API Key:", apiKey.value); ``` Lists all API keys that belong to the user. ### Parameters None. ### Returns `Promise`: An array of API keys belonging to the user. ```typescript declare function listApiKeys(): Promise; ``` ```typescript Listing API keys const apiKeys = await user.listApiKeys(); console.log(`You have ${apiKeys.length} API keys`); // Find keys that are about to expire const soonToExpire = apiKeys.filter(key => key.expiresAt && key.expiresAt.getTime() - Date.now() < 7 * 24 * 60 * 60 * 1000 ); ``` {/* IF_PLATFORM next */} Lists all API keys that belong to the user, used as a React hook. ### Parameters None. ### Returns `UserApiKey[]`: An array of API keys belonging to the user. ```typescript declare function useApiKeys(): UserApiKey[]; ``` ```typescript Using API keys in a React component function ApiKeysList() { const user = useUser(); const apiKeys = user.useApiKeys(); return (

Your API Keys ({apiKeys.length})

{key.description} - Last four: {key.value.lastFour} {key.isValid() ? ' (valid)' : ` (invalid: ${key.whyInvalid()})`}

); } ``` {/* END_PLATFORM */} Updates the user's password. ### Parameters The fields required for updating the password. The current password of the user. The new password for the user. ### Returns `Promise`: Returns an error object if the operation fails, otherwise returns `void`. ```typescript declare function updatePassword(data: { oldPassword: string; newPassword: string; }): Promise; ``` ```typescript Updating user password const error = await user.updatePassword({ oldPassword: "currentPassword", newPassword: "newPassword", }); if (error) { console.error("Error updating password", error); } else { console.log("Password updated successfully"); } ``` Returns the value for the HTTP `Authorization` header for authenticated requests to external servers. Most commonly used in cross-origin requests. Similar to `getAuthJson`, but specifically for HTTP requests. If you are using `tokenStore: "cookie"`, you don't need this for same-origin requests. However, most browsers now disable third-party cookies by default, so we must pass authentication tokens by header instead if the client and server are on different origins. This function returns the header value in this format: `Bearer stackauth_<base64(getAuthJson())>`, or `null` if the user is not signed in. You can use this with `fetch` or other HTTP request libraries to send authenticated requests. On the server, you can then pass in the `Request` object to the `tokenStore` option of your Stack app. Please note that CORS does not allow most headers by default, so you must include `authorization` in the [`Access-Control-Allow-Headers` header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers) of the CORS preflight response. If you are not using HTTP (and hence cannot set headers), use `getAuthJson()` instead. ### Parameters No parameters. ### Returns `Promise`: A `Bearer stackauth_...` authorization header value, or `null` if not signed in. ```typescript declare function getAuthorizationHeader(): Promise; ``` ```typescript Passing an authorization header to an external server // client const authorizationHeader = await user.getAuthorizationHeader(); const res = await fetch("https://api.example.com", { headers: { ...(authorizationHeader ? { Authorization: authorizationHeader } : {}) // you can also add your own headers here }, }); // server function handleRequest(req: Request) { const user = await stackServerApp.getUser({ tokenStore: req }); return new Response("Welcome, " + user.displayName); } ``` React hook equivalent of `getAuthorizationHeader()`. Returns the value for the HTTP `Authorization` header for authenticated requests to external servers, or `null` if the user is not signed in. Use it when a React component needs to call an API on a different origin and same-origin cookies are not enough. ### Parameters No parameters. ### Returns `string | null`: A `Bearer stackauth_...` authorization header value, or `null` if not signed in. ```typescript declare function useAuthorizationHeader(): string | null; ``` ```tsx Passing an authorization header from React function ExternalApiButton() { const authorizationHeader = user.useAuthorizationHeader(); return ( ); } ``` **Deprecated:** Use `getAuthorizationHeader()` instead. Returns legacy headers for cross-origin authenticated requests. This is kept for backwards compatibility with existing `x-stack-auth` integrations. ### Parameters No parameters. ### Returns `Promise>`: An object containing the legacy authentication headers. ```typescript declare function getAuthHeaders(): Promise>; ``` ```typescript Legacy x-stack-auth integration const headers = await user.getAuthHeaders(); const res = await fetch("https://api.example.com", { headers }); ``` Creates a JSON-serializable object containing the information to authenticate a user on an external server. While `getAuthorizationHeader` is the recommended way to send authentication tokens over HTTP, your app may use a different protocol, for example WebSockets or gRPC. This function returns a token object that can be JSON-serialized and sent to the server in any way you like. On the server, you can pass in this token object into the `tokenStore` option to fetch user details. ### Parameters No parameters. ### Returns `Promise<{ accessToken: string | null }>`: An object containing the access token. ```typescript declare function getAuthJson(): Promise<{ accessToken: string | null }>; ``` ```typescript Passing auth tokens over an RPC call // client const res = await rpcCall(rpcEndpoint, { data: { auth: await user.getAuthJson(), }, }); // server function handleRequest(data) { const user = await stackServerApp.getUser({ tokenStore: data.auth }); return new Response("Welcome, " + user.displayName); } ``` Signs out the user and clears the session. ### Parameters An object containing multiple properties. The URL to redirect to after signing out. Defaults to the `afterSignOut` URL from the Stack app's `urls` object. ### Returns `Promise` ```typescript declare function signOut(options?: { redirectUrl?: string }): Promise; ``` ```typescript Signing out await user.signOut(); ``` Deletes the user. This action is irreversible and can only be used if client-side user deletion is enabled in the Stack dashboard. ### Parameters No parameters. ### Returns `Promise` ```typescript declare function delete(): Promise; ``` ```typescript Deleting the user await user.delete(); ``` Creates a checkout URL for purchasing a product. This method integrates with Stripe to generate a secure payment link. ### Parameters Options for creating the checkout URL. The ID of the product to purchase. ### Returns `Promise`: A URL that redirects to the Stripe checkout page for the specified product. ```typescript declare function createCheckoutUrl(options: { productId: string; }): Promise; ``` ```typescript Creating a checkout URL const checkoutUrl = await user.createCheckoutUrl({ productId: "prod_premium_plan", }); // Redirect user to checkout window.location.href = checkoutUrl; ``` Retrieves information about a specific item (such as credits, subscription quantities, etc.) for the user. ### Parameters The ID of the item to retrieve. ### Returns `Promise`: The item object containing display name, quantity, and other details. ```typescript declare function getItem(itemId: string): Promise; ``` ```typescript Getting user credits const credits = await user.getItem("credits"); console.log(`User has ${credits.quantity} credits`); console.log(`Non-negative quantity: ${credits.nonNegativeQuantity}`); ``` {/* IF_PLATFORM next */} Retrieves information about a specific item for the user, used as a React hook. ### Parameters The ID of the item to retrieve. ### Returns `Item`: The item object containing display name, quantity, and other details. ```typescript declare function useItem(itemId: string): Item; ``` ```typescript Using credits in a React component function CreditsDisplay() { const user = useUser(); const credits = user.useItem("credits"); return (

Available Credits: {credits.quantity}

Display Name: {credits.displayName}

); } ``` {/* END_PLATFORM */} ***

# `ServerUser` The `ServerUser` object contains most `CurrentUser` properties and methods with the exception of those that require an active session (`getAuthJson` and `signOut`). It also contains some additional functions that require [server-level permissions](/docs/concepts/stack-app#client-vs-server). ### Table of Contents //$stack-link-to:#currentuser & { lastActiveAt: Date; //$stack-link-to:#serveruserlastactiveat serverMetadata: Json; //$stack-link-to:#serveruserservermetadata update(data): Promise; //$stack-link-to:#serveruserupdate listContactChannels(): Promise; //$stack-link-to:#serveruserlistcontactchannels // NEXT_LINE_PLATFORM react-like ⤷ useContactChannels(): ContactChannel[]; //$stack-link-to:#serveruserusecontactchannels listTeamsPaginated([options]): Promise<{ items: ServerTeam[]; nextCursor: string | null }>; //$stack-link-to:#serveruserlistteamspaginated // NEXT_LINE_PLATFORM react-like ⤷ useTeamsPaginated([options]): { items: ServerTeam[]; nextCursor: string | null }; //$stack-link-to:#serveruseruseteamspaginated grantPermission(scope, permissionId): Promise; //$stack-link-to:#serverusergrantpermission revokePermission(scope, permissionId): Promise; //$stack-link-to:#serveruserrevokepermission };`} /> The last active date and time of the user as a `Date`. ```typescript declare const lastActiveAt: Date; ``` The server metadata of the user, accessible only on the server side. ```typescript declare const serverMetadata: Json; ``` Updates the user's information on the server side. This is similar to the `CurrentUser.update()` method but includes additional capabilities, such as updating server metadata or setting a new password directly. ### Parameters The fields to update. The new display name for the user. The new primary email for the user. Whether the primary email is verified. Whether auth should be enabled for the primary email. The new password for the user. The ID of the team to set as selected, or `null` to clear selection. The URL of the user's new profile image, or `null` to remove. Metadata visible on the client side. Metadata that is read-only on the client but modifiable on the server side. Metadata only accessible and modifiable on the server side. ### Returns `Promise` ```typescript declare function update(data: { displayName?: string; profileImageUrl?: string | null; primaryEmail?: string, primaryEmailVerified?: boolean, primaryEmailAuthEnabled?: boolean, password?: string; selectedTeamId?: string | null; clientMetadata?: Json; clientReadOnlyMetadata?: Json; serverMetadata?: Json; }): Promise; ``` ```typescript Updating user details on the server await serverUser.update({ displayName: "Updated Display Name", password: "newSecurePassword", serverMetadata: { internalNote: "Confidential information", }, }); ``` Lists all the contact channels of the user on the server side. This is similar to `CurrentUser.listContactChannels()` but returns a list of `ServerContactChannel` objects, which may include additional server-only details. ### Parameters No parameters. ### Returns `Promise`: An array of server-specific contact channels. ```typescript declare function listContactChannels(): Promise; ``` ```typescript Listing server-specific contact channels const contactChannels = await serverUser.listContactChannels(); ``` {/* IF_PLATFORM next */} Functionally equivalent to [`listContactChannels()`](#serveruserlistcontactchannels), but as a React hook. ```typescript declare function useContactChannels(): ContactChannel[]; ``` {/* END_PLATFORM */} Lists the teams the user belongs to with cursor-based pagination, optional filtering, and ordering. The returned array carries an extra `nextCursor` property; pass it back as `cursor` to load the next page. For unpaginated access (returning all matching teams), use `listTeams()`. ### Parameters Cursor returned as `nextCursor` from a previous response. Maximum number of items to return. If omitted, all matching teams are returned. The field to sort results by. Whether to sort in descending order. Free-text search on the team's display name (and team ID if the query is a UUID). ### Returns `Promise<{ items: ServerTeam[]; nextCursor: string | null }>` ```typescript declare function listTeamsPaginated(options?: { cursor?: string; limit?: number; orderBy?: "createdAt"; desc?: boolean; query?: string; }): Promise<{ items: ServerTeam[]; nextCursor: string | null }>; ``` ```typescript const teams = await serverUser.listTeamsPaginated({ limit: 20 }); if (teams.nextCursor) { const next = await serverUser.listTeamsPaginated({ cursor: teams.nextCursor, limit: 20, }); } ``` {/* IF_PLATFORM react-like */} Functionally equivalent to [`listTeamsPaginated()`](#serveruserlistteamspaginated), but as a React hook. ```typescript declare function useTeamsPaginated(options?: { cursor?: string; limit?: number; orderBy?: "createdAt"; desc?: boolean; query?: string; }): { items: ServerTeam[]; nextCursor: string | null }; ``` {/* END_PLATFORM */} Grants a specific permission to the user for a given team. ### Parameters The team to grant the permission for. The ID of the permission to grant. ### Returns `Promise` ```typescript declare function grantPermission(scope: Team, permissionId: string): Promise; ``` ```typescript Granting permission to a user await serverUser.grantPermission(team, "read_secret_info"); ``` Revokes a specific permission from the user for a given team. ### Parameters The team to revoke the permission from. The ID of the permission to revoke. ### Returns `Promise` ```typescript declare function revokePermission(scope: Team, permissionId: string): Promise; ``` ```typescript Revoking permission from a user await serverUser.revokePermission(team, "read_secret_info"); ``` Creates a new API key for the user, which can be used for programmatic access to your application's backend. ### Parameters Options for creating the API key. A human-readable description of the API key's purpose. The date when the API key will expire. Use null for keys that don't expire. Whether the API key is public. Defaults to false. * **Secret API Keys** (default) begin with `sk_` and are monitored by Stack Auth's secret scanner, which can revoke them if detected in public code repositories. * **Public API Keys** begin with `pk_` and are designed for client-side code where exposure is not a concern. ### Returns `Promise`: The newly created API key. Note that this is the only time the full API key value will be visible. ```typescript declare function createApiKey(options: { description: string; expiresAt: Date | null; isPublic?: boolean; }): Promise; ``` ```typescript Creating an API key const apiKey = await serverUser.createApiKey({ description: "Backend integration", expiresAt: new Date(Date.now() + 90 * 24 * 60 * 60 * 1000), // 90 days isPublic: false, }); // Save the API key value securely, as it won't be retrievable later console.log("API Key:", apiKey.value); ``` Lists all API keys that belong to the user. ### Parameters None. ### Returns `Promise`: An array of API keys belonging to the user. ```typescript declare function listApiKeys(): Promise; ``` ```typescript Listing API keys const apiKeys = await serverUser.listApiKeys(); console.log(`You have ${apiKeys.length} API keys`); // Find keys that are about to expire const soonToExpire = apiKeys.filter(key => key.expiresAt && key.expiresAt.getTime() - Date.now() < 7 * 24 * 60 * 60 * 1000 ); ``` {/* IF_PLATFORM next */} Lists all API keys that belong to the user, used as a React hook. ### Parameters None. ### Returns `UserApiKey[]`: An array of API keys belonging to the user. ```typescript declare function useApiKeys(): UserApiKey[]; ``` ```typescript Using API keys in a React component function ApiKeysList() { const user = useUser(); const apiKeys = user.useApiKeys(); return (

Your API Keys ({apiKeys.length})

{key.description} - Last four: {key.value.lastFour} {key.isValid() ? ' (valid)' : ` (invalid: ${key.whyInvalid()})`}

); } ``` {/* END_PLATFORM */} ***

# `CurrentServerUser` The `CurrentServerUser` object combines all the properties and methods of both `CurrentUser` and `ServerUser`. You can obtain a `CurrentServerUser` by calling `stackServerApp.getUser()` on the server side. ### Table of Contents # Apple URL: /docs/concepts/auth-providers/apple Source: /vercel/path0/docs/content/docs/(guides)/concepts/auth-providers/apple.mdx *** ## title: "Apple" This guide explains how to set up Apple as an authentication provider with Stack Auth. Sign in with Apple allows users to sign in to your application using their Apple ID. You will need to create an Apple Developer account, and generate an Apple Services ID, Apple Private Key, Apple Team ID, and Apple Key ID. ## Integration Steps ### Create an Apple App ID and Services ID 1. Log in to the [Apple Developer Portal](https://developer.apple.com/). 2. Navigate to **Certificates, IDs & Profiles**. 3. In the sidebar, select **Identifiers** and click the "+" button to register a new identifier. 4. Select **App IDs** and click **Continue**. 5. Select **App** as the type and click **Continue**. 6. Give your app a description and a Bundle ID (e.g., com.yourdomain.app). 7. Scroll down and enable **Sign in with Apple**, then click **Continue**, then **Register**. 8. In the top-right of the Identifiers page, switch to **Services IDs**. 9. Click the "+" button to create a new Service ID and click **Continue**. 10. Give it a description and an identifier (note: this cannot be the same as your App ID's bundle ID). 11. Click **Continue**, then **Register**. 12. From the list, select your new Service ID. 13. Enable **Sign in with Apple** by checking the box. 14. Click **Configure** next to Sign in with Apple. 15. Register your domains (add api.stack-auth.com). 16. Add the return URL: `https://api.stack-auth.com/api/v1/auth/oauth/callback/apple` 17. Click **Done**, then **Continue**, and then **Save**. ### Create a Private Key 1. In the sidebar, select **Keys** and click the "+" button. 2. Give your key a name and usage description. 3. Scroll down to enable **Sign in with Apple** and click **Configure**. 4. Select your Primary App ID that you created earlier and click **Save**. 5. Click **Continue**, then **Register**. 6. On the next page, **download your key file (.p8)**. This is critical as you won't be able to download it again. 7. Note your **Key ID** displayed on this page. 8. Click **Done**. 9. Find your **Account ID** at the very top-right of the Apple Developer Portal page. ### Generate Your Client Secret Use the tool below to generate your Apple Client Secret. You'll need: * **Team ID**: Your Apple Developer account ID found at the top-right of the portal * **Service ID**: The identifier of your Service ID (found in Identifiers > Service IDs) * **Key ID**: The ID of the private key you just created * **Private Key File**: Upload the .p8 private key file you downloaded Copy the generated secret immediately - you'll need it for the next step. ### Enable Apple OAuth in Stack Auth 1. On the Stack Auth dashboard, select **Auth Methods** in the left sidebar. 2. Click **Add SSO Providers** and select **Apple** as the provider. 3. Set the **Client ID** (your Service ID identifier), **Client Secret** (the generated secret from Supabase), and **Team ID** (your Apple Developer Team ID). ## Native App Configuration (iOS/macOS) Native iOS and macOS apps using the Stack Auth Swift SDK require Bundle ID configuration in addition to the web OAuth setup above. Native apps use Apple's native Sign in with Apple flow (`ASAuthorizationController`) instead of web-based OAuth. Bundle IDs are only required for native iOS/macOS apps. Web applications only need the Service ID configuration described above. ### Add Your Bundle IDs 1. On the Stack Auth dashboard, navigate to **Auth Methods** and select your Apple provider. 2. In the Apple configuration modal, add your app's **Bundle ID** (e.g., `com.yourdomain.app`). This is the same Bundle ID from your App ID in Apple Developer Portal (Step 1 above). 3. If you have multiple apps (e.g., separate iOS and macOS apps), add all their Bundle IDs. 4. Click **Save**. Your native app can now use `signInWithOAuth(provider: "apple")` from the Swift SDK. ### Need More Help? * Check the [Sign in with Apple Documentation](https://developer.apple.com/sign-in-with-apple/get-started/) * Join our [Discord](https://discord.stack-auth.com) # Bitbucket URL: /docs/concepts/auth-providers/bitbucket Source: /vercel/path0/docs/content/docs/(guides)/concepts/auth-providers/bitbucket.mdx *** ## title: "Bitbucket" This guide explains how to set up Bitbucket as an authentication provider with Stack Auth. Bitbucket OAuth allows users to sign in to your application using their Bitbucket account. ## Integration Steps ### Create a Bitbucket OAuth App 1. Log in to your [Bitbucket Workspaces account](https://bitbucket.org/account/workspaces/). 2. Under **Workspaces**, find your workspace and select **Manage**. 3. In the left sidebar, scroll down and select **OAuth consumers**. 4. Click **Add consumer**. 5. Fill out the form with the following details: * **Name**: Choose a name for your application * **Description**: Add a brief description of your application * **Callback URL**: Enter `https://api.stack-auth.com/api/v1/auth/oauth/callback/bitbucket` * **Permissions**: Under **Account**, select at minimum **Email** and **Read** 6. Click **Save**. 7. You'll be redirected to the OAuth consumers page. Select your newly created consumer to view its details. 8. Note the **Key** (Client ID) and **Secret** values. Save these somewhere secure as you'll need them for the next steps. ### Enable Bitbucket OAuth in Stack Auth 1. On the Stack Auth dashboard, select **Auth Methods** in the left sidebar. 2. Click **Add SSO Providers** and select **Bitbucket** as the provider. 3. Set the **Client ID** (the Key from your Bitbucket OAuth consumer) and **Client Secret** you obtained from Bitbucket earlier. ### Need More Help? * Check the [Bitbucket OAuth documentation](https://developer.atlassian.com/cloud/bitbucket/oauth-2/) * Join our [Discord](https://discord.stack-auth.com) # Discord URL: /docs/concepts/auth-providers/discord Source: /vercel/path0/docs/content/docs/(guides)/concepts/auth-providers/discord.mdx *** ## title: "Discord" This guide explains how to set up Discord as an authentication provider with Stack Auth. Discord OAuth2 allows users to sign in to your application using their Discord account. ## Integration Steps ### Create a Discord Developer App 1. Navigate to the [Discord Developer Portal](https://discord.com/developers/applications). 2. Click the **New Application** button in the top-right corner. 3. Enter a name for your application and click **Create**. You will be redirected to the General Information page. 4. Select **OAuth2** in the left sidebar. 5. Under **Redirects** add `https://api.stack-auth.com/api/v1/auth/oauth/callback/discord` 6. In the **OAuth2** section, enable the required scopes: 'identify' and 'email' 7. Click **Save Changes** 8. Save the **Client ID** and **Client Secret**. You may need to select **Reset Secret** to generate a new one. ### Enable Discord OAuth2 in Stack Auth 1. On the Stack Auth dashboard, select **Auth Methods** in the left sidebar. 2. Click **Add SSO Providers** and select **Discord** as the provider. 3. Set the **Client ID** and **Client Secret** you obtained from the Discord Developer Portal earlier. ### User Profile Data When a user signs in with Discord, Stack Auth will create a user profile with the following data: * **User ID**: Discord's unique user ID * **Username**: The user's Discord username * **Avatar**: The user's Discord avatar (if available) * **Email**: The user's email if the 'email' scope is requested ### Need More Help? * Check the [Discord OAuth2 Documentation](https://discord.com/developers/docs/topics/oauth2) * Visit our [Discord Support Channel](https://discord.stack-auth.com) # Facebook URL: /docs/concepts/auth-providers/facebook Source: /vercel/path0/docs/content/docs/(guides)/concepts/auth-providers/facebook.mdx *** ## title: "Facebook" This guide explains how to set up Facebook as an authentication provider with Stack Auth. Facebook OAuth allows users to sign in to your application using their Facebook account. ## Integration Steps ### Create a Facebook OAuth App 1. Navigate to the [Facebook Developers Portal](https://developers.facebook.com/). 2. In the top-right, select **My Apps** and then **Create App**. 3. You'll be redirected to the Create an app process. 4. In the **App details** step, select the app type (typically **Consumer** for authentication), fill out the necessary information, and select **Next**. 5. In the **Use Cases** step, select **Authenticate and request data from users with Facebook Login** and then select **Next**. 6. In the **Business** step, select the business portfolio to connect to your app and then select **Next**. 7. In the **Finalize** step, select **Go to dashboard**. You'll be redirected to the app's Dashboard page. 8. In the left sidenav, select **Use cases**. 9. Next to **Authenticate and request data from users with Facebook Login**, select **Customize**. 10. On the Permissions tab, next to **email**, select **Add** to allow Stack Auth to read your user's primary email address. 11. In the left sidenav, under **Facebook Login**, select **Settings**. 12. In the **Client OAuth settings** section, in the **Valid OAuth Redirect URIs** field, add `https://api.stack-auth.com/api/v1/auth/oauth/callback/facebook` 13. Select **Save changes**. 14. In the left sidenav, select **App settings** (hover over the settings icon), and then select **Basic**. 15. Note your **App ID** and **App Secret** for the next steps. ### Enable Facebook OAuth in Stack Auth 1. On the Stack Auth dashboard, select **Auth Methods** in the left sidebar. 2. Click **Add SSO Providers** and select **Facebook** as the provider. 3. Set the **App ID** and **App Secret** you obtained from the Facebook Developers Portal earlier. ### Need More Help? * Check the [Facebook Login Documentation](https://developers.facebook.com/docs/facebook-login/) * Join our [Discord](https://discord.stack-auth.com) # GitHub URL: /docs/concepts/auth-providers/github Source: /vercel/path0/docs/content/docs/(guides)/concepts/auth-providers/github.mdx *** title: "GitHub" lastModified: "2026-01-13" -------------------------- This guide explains how to set up GitHub as an authentication provider with Stack Auth. GitHub allows users to sign in to your Stack Auth-enabled app using their GitHub account. For Development purposes, Stack Auth uses shared keys for this provider. Shared keys are automatically created by Stack, but show Stack's logo on the OAuth sign-in page. You should replace these before you go into production. ## Integration Steps If you are unsure if you need to create a GitHub App, or a GitHub OAuth App, check the [Differences On GitHub](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps). More than likely, you will want to create a GitHub App. The installation process is the same for both. ### Create a GitHub App 1. Navigate to your [GitHub Developer App Settings](https://github.com/settings/apps). 2. Click the **New GitHub App** button. 3. Enter a name for your application, homepage URL, and a description. 4. For **Authorization callback URL**, add `https://api.stack-auth.com/api/v1/auth/oauth/callback/github` 5. For permissions, at a **minimum**, you will need **Account Permissions > Email Addresses** set to **Read Only**. Your sign-in flow will not work without this permission. 6. Select **Any Account** under the ***Where can this GitHub App be installed*** section. 7. Click **Create GitHub App** 8. Save the **Client ID** and click **Generate a new client secret** to create your **Client Secret**. ### Enable GitHub Provider in Stack Auth 1. On the Stack Auth dashboard, select **Auth Methods** in the left sidebar. 2. Click **Add SSO Providers** and select **GitHub** as the provider. 3. Set the **Client ID** and **Client Secret** you obtained from your GitHub App earlier. *** ### Create an OAuth App 1. Navigate to your [GitHub Developer Settings](https://github.com/settings/developers). 2. Click the **New OAuth App** button. 3. Enter a name for your application, homepage URL, and a description. 4. For **Authorization callback URL**, add `https://api.stack-auth.com/api/v1/auth/oauth/callback/github` 5. Click **Register application** 6. Save the **Client ID** and click **Generate a new client secret** to create your **Client Secret**. ### Enable GitHub OAuth in Stack Auth 1. On the Stack Auth dashboard, select **Auth Methods** in the left sidebar. 2. Click **Add SSO Providers** and select **GitHub** as the provider. 3. Set the **Client ID** and **Client Secret** you obtained from GitHub earlier. ### Need More Help? * Check the [GitHub OAuth Documentation](https://docs.github.com/en/developers/apps/building-oauth-apps/authorizing-oauth-apps) * Join our [Discord](https://discord.stack-auth.com) # GitLab URL: /docs/concepts/auth-providers/gitlab Source: /vercel/path0/docs/content/docs/(guides)/concepts/auth-providers/gitlab.mdx *** ## title: "GitLab" This guide explains how to set up GitLab as an authentication provider with Stack Auth. GitLab OAuth allows users to sign in to your application using their GitLab account. ## Integration Steps ### Create a GitLab OAuth App 1. Log in to your GitLab account. 2. In the top-right corner, click on your profile picture and select **Preferences**. 3. In the left sidebar, select **Applications** > **Add new application**. 4. Fill out the form with the following details: * **Name**: Choose a name for your application * **Redirect URI**: Enter `https://api.stack-auth.com/api/v1/auth/oauth/callback/gitlab` * **Scopes**: Select at minimum the `profile` and `email` scopes 5. Click **Save application**. 6. GitLab will display your **Application ID** and **Secret**. Make note of these values as you'll need them for the next steps. 7. If you're using a self-hosted GitLab instance, you'll also need the URL of your GitLab instance. ### Enable GitLab OAuth in Stack Auth 1. On the Stack Auth dashboard, select **Auth Methods** in the left sidebar. 2. Click **Add SSO Providers** and select **GitLab** as the provider. 3. Set the **Application ID** and **Secret** you obtained from GitLab earlier. 4. If you're using a self-hosted GitLab instance, you'll also need to provide the URL for your instance. For gitlab.com, you can leave this field blank or use the default value. ### Need More Help? * Check the [GitLab OAuth 2.0 documentation](https://docs.gitlab.com/ee/api/oauth2.html) * Join our [Discord](https://discord.stack-auth.com) # Google URL: /docs/concepts/auth-providers/google Source: /vercel/path0/docs/content/docs/(guides)/concepts/auth-providers/google.mdx *** ## title: "Google" This guide explains how to set up Google as an authentication provider with Stack Auth. Google OAuth2 allows users to sign in to your application using their Google account. For Development purposes, Stack Auth uses shared keys for this provider. Shared keys are automatically created by Stack, but show Stack's logo on the OAuth sign-in page. You should replace these before you go into production. ## Integration Steps ### Create a Google OAuth2 App 1. Navigate to the [Google Cloud Console](https://console.cloud.google.com/). 2. Create a new project or select an existing one. 3. In the sidebar, navigate to **APIs & Services** > **Credentials**. 4. Click **Create Credentials** and select **OAuth client ID**. 5. Select **Web application** as the application type. 6. Enter a name for your OAuth client. 7. Under **Authorized redirect URIs**, add `https://api.stack-auth.com/api/v1/auth/oauth/callback/google` 8. Click **Create**. 9. Save the **Client ID** and **Client Secret** that are displayed. ### Enable Google OAuth2 in Stack Auth 1. On the Stack Auth dashboard, select **Auth Methods** in the left sidebar. 2. Click **Add SSO Providers** and select **Google** as the provider. 3. Set the **Client ID** and **Client Secret** you obtained from Google Cloud Console earlier. ### Need More Help? * Check the [Google OAuth2 Documentation](https://developers.google.com/identity/protocols/oauth2) * Join our [Discord](https://discord.stack-auth.com) # Auth Providers Overview URL: /docs/concepts/auth-providers Source: /vercel/path0/docs/content/docs/(guides)/concepts/auth-providers/index.mdx *** title: "Auth Providers Overview" icon: Plug ---------- Stack Auth supports a wide range of authentication providers to help you add secure authentication to your application. This documentation covers all the supported providers and how to configure them. ## OAuth Providers

## Other Authentication Methods

Each provider has its own setup process and configuration requirements. Select a provider from the navigation to learn more about how to configure it with Stack Auth. # LinkedIn URL: /docs/concepts/auth-providers/linkedin Source: /vercel/path0/docs/content/docs/(guides)/concepts/auth-providers/linkedin.mdx *** ## title: "LinkedIn" This guide explains how to set up LinkedIn as an authentication provider with Stack Auth. LinkedIn OAuth2 allows users to sign in to your application using their LinkedIn account. ## Integration Steps ### Create a LinkedIn OAuth App 1. Log in to the [LinkedIn Developer Portal](https://www.linkedin.com/developers/apps). 2. Click **Create app** to create a new application. 3. Enter your **App name** and select a **LinkedIn Page** to associate with your app (or create a new one). 4. Upload an **App logo** (required for production apps). 5. Enter the **App description** and your **Business email**. 6. Check the **Legal agreement** box and click **Create app**. 7. On your app's dashboard, click **Auth** tab from the left sidebar. 8. Under **OAuth 2.0 settings**, add the following redirect URL: `https://api.stack-auth.com/api/v1/auth/oauth/callback/linkedin` 9. Under **Products**, request access to **Sign In with LinkedIn** by clicking **Request access**. Complete any required information. 10. Under **OAuth 2.0 scopes**, make sure at least the following scopes are selected: * `r_emailaddress` * `r_liteprofile` 11. Once approved, navigate to the **Auth** tab again to find your **Client ID** and **Client Secret**. ### Enable LinkedIn OAuth in Stack Auth 1. On the Stack Auth dashboard, select **Auth Methods** in the left sidebar. 2. Click **Add SSO Providers** and select **LinkedIn** as the provider. 3. Set the **Client ID** and **Client Secret** you obtained from the LinkedIn Developer Portal earlier. ### Need More Help? * Check the [LinkedIn OAuth2 Documentation](https://learn.microsoft.com/en-us/linkedin/shared/authentication/authorization-code-flow) * Join our [Discord](https://discord.stack-auth.com) # Microsoft URL: /docs/concepts/auth-providers/microsoft Source: /vercel/path0/docs/content/docs/(guides)/concepts/auth-providers/microsoft.mdx *** ## title: "Microsoft" This guide explains how to set up Microsoft as an authentication provider with Stack Auth. Microsoft OAuth allows users to sign in to your application using their Microsoft account. For Development purposes, Stack Auth uses shared keys for this provider. Shared keys are automatically created by Stack, but show Stack's logo on the OAuth sign-in page. You should replace these before you go into production. ## Integration Steps ### Create a Microsoft OAuth App 1. Navigate to the [Microsoft Entra admin center](https://entra.microsoft.com/) (formerly Azure AD). 2. In the left sidebar, go to **Applications** > **App registrations**. 3. Click **New registration** at the top of the page. 4. Enter a name for your application. 5. Under **Supported account types**, select the option that best suits your needs (typically **Accounts in any organizational directory and personal Microsoft accounts**). 6. In the **Redirect URI** section, select **Web** as the platform and enter `https://api.stack-auth.com/api/v1/auth/oauth/callback/microsoft` 7. Click **Register** to create the application. 8. You'll be redirected to the app's Overview page. Note the **Application (client) ID** displayed at the top. 9. In the left sidebar, click **Certificates & secrets**. 10. Under **Client secrets**, click **New client secret**. 11. Add a description, select an expiration period, and click **Add**. 12. Copy the **Value** of the client secret immediately (you won't be able to see it again). ### Enable Microsoft OAuth in Stack Auth 1. On the Stack Auth dashboard, select **Auth Methods** in the left sidebar. 2. Click **Add SSO Providers** and select **Microsoft** as the provider. 3. Set the **Client ID** (Application ID) and **Client Secret** you obtained from the Microsoft Entra admin center. ### Need More Help? * Check the [Microsoft identity platform Documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/) * Join our [Discord](https://discord.stack-auth.com) # Passkey URL: /docs/concepts/auth-providers/passkey Source: /vercel/path0/docs/content/docs/(guides)/concepts/auth-providers/passkey.mdx *** ## title: "Passkey" This guide explains how to set up Passkey authentication with Stack Auth. Passkeys allow users to sign in to your application securely using biometrics, mobile devices, or security keys. Passkeys provide a more secure and convenient authentication method compared to traditional passwords by using WebAuthn standard. ## Integration Steps ### Enable Passkey Authentication in Stack Auth 1. Log in to the [Stack Auth dashboard](https://app.stack-auth.com/). 2. Select your project from the dashboard. 3. In the left sidebar, select **Auth Methods**. 4. Find the **Passkey** authentication method and toggle it to enable. 5. Save your changes. ### Implement Passkey Authentication in Your Application 1. Make sure you've installed the Stack Auth SDK in your application: ```bash npm install @stackframe/stack ``` 2. Add Passkey support to your sign-in component by using the built-in Stack Auth components or creating your own implementation with the SDK. Using built-in components: ```jsx import { SignIn } from "@stackframe/stack"; export default function SignInPage() { return ; } ``` The built-in components will automatically show the passkey option when it's enabled in your project. ## How Passkey Authentication Works 1. **Registration**: When a user creates a new passkey, their device generates a unique public-private key pair. The private key stays on the user's device, while the public key is sent to Stack Auth's servers. 2. **Authentication**: When a user wants to sign in, Stack Auth sends a challenge to the user's device. The device uses the private key to sign the challenge, and sends the signature back to Stack Auth for verification. 3. **Cross-device authentication**: Users can create passkeys on one device and use them to sign in on another device using QR codes or nearby device detection. For the most up-to-date compatibility information, refer to the [WebAuthn browser compatibility chart](https://caniuse.com/webauthn). # Spotify URL: /docs/concepts/auth-providers/spotify Source: /vercel/path0/docs/content/docs/(guides)/concepts/auth-providers/spotify.mdx *** ## title: "Spotify" This guide explains how to set up Spotify as an authentication provider with Stack Auth. Spotify OAuth allows users to sign in to your application using their Spotify account. For Development purposes, Stack Auth uses shared keys for this provider. Shared keys are automatically created by Stack, but show Stack's logo on the OAuth sign-in page. You should replace these before you go into production. ## Integration Steps ### Create a Spotify OAuth App 1. Navigate to the [Spotify Developer Dashboard](https://developer.spotify.com/dashboard/). 2. Log in with your Spotify account. 3. Click **Create app** to create a new application. 4. Enter an **App name** and **App description**. 5. Under **Redirect URI**, add `https://api.stack-auth.com/api/v1/auth/oauth/callback/spotify` 6. Check the agreement checkbox and click **Create**. 7. You'll be redirected to your app's dashboard. Note your **Client ID** displayed on this page. 8. Click **Settings** to view more details about your app. 9. In the settings page, you can view your **Client Secret** by clicking **Show client secret**. 10. If needed, you can adjust the app settings, including adding additional redirect URIs. ### Enable Spotify OAuth in Stack Auth 1. On the Stack Auth dashboard, select **Auth Methods** in the left sidebar. 2. Click **Add SSO Providers** and select **Spotify** as the provider. 3. Set the **Client ID** and **Client Secret** you obtained from the Spotify Developer Dashboard earlier. ### Need More Help? * Check the [Spotify Web API Authorization Documentation](https://developer.spotify.com/documentation/general/guides/authorization/) * Join our [Discord](https://discord.stack-auth.com) # Twitch URL: /docs/concepts/auth-providers/twitch Source: /vercel/path0/docs/content/docs/(guides)/concepts/auth-providers/twitch.mdx *** ## title: "Twitch" This guide explains how to set up Twitch as an authentication provider with Stack Auth. Twitch OAuth allows users to sign in to your application using their Twitch account. ## Integration Steps ### Create a Twitch OAuth App 1. Navigate to the [Twitch Developer Console](https://dev.twitch.tv/console). 2. Log in with your Twitch account. 3. Navigate to **Applications** and click **Register New Application**. 4. Enter a **Name** and select a **Category**. 5. Under **OAuth Redirect URLs**, add `https://api.stack-auth.com/api/v1/auth/oauth/callback/twitch` 6. Click **Create**. 7. You'll be redirected to your app's dashboard. 8. Click **Manage** of the app you just created to view more details about your app. 9. Click "New Secret" to generate a new secret. 10. Copy and save the **Client ID** and **Client Secret**. ### Enable Twitch OAuth in Stack Auth 1. On the Stack Auth dashboard, select **Auth Methods** in the left sidebar. 2. Click **Add SSO Providers** and select **Twitch** as the provider. 3. Set the **Client ID** and **Client Secret** you obtained from the Twitch Developer Console earlier. ### Need More Help? * Check the [Twitch OAuth Documentation](https://dev.twitch.tv/docs/authentication/getting-tokens-oauth/) * Join our [Discord](https://discord.stack-auth.com) # Two-Factor Authentication (2FA) URL: /docs/concepts/auth-providers/two-factor-auth Source: /vercel/path0/docs/content/docs/(guides)/concepts/auth-providers/two-factor-auth.mdx *** ## title: "Two-Factor Authentication (2FA)" This guide explains how Two-Factor Authentication (2FA) works with Stack Auth. 2FA adds an extra layer of security by requiring users to provide a verification code in addition to their password. Stack Auth implements TOTP (Time-based One-Time Password) for two-factor authentication, which is compatible with standard authenticator apps like Google Authenticator, Microsoft Authenticator, and Authy. 2FA is enabled by default at the platform level and can be configured by individual users. ## Integration Steps ### No Developer Configuration Required 2FA is enabled by default on the Stack Auth platform. Unlike other authentication methods, you don't need to enable it specifically for your project. ### Implement User Settings in Your Application To allow your users to set up 2FA for their accounts: 1. Make sure you've installed the Stack Auth SDK in your application: ```bash npm install @stackframe/stack ``` 2. Use the Stack Auth components to give users access to their account settings, where they can enable 2FA: ```jsx import { AccountSettings } from "@stackframe/stack"; export default function SettingsPage() { return ; } ``` 3. The built-in Stack Auth components will handle the entire 2FA setup process, including QR code generation, verification, and recovery codes. ## How Stack Auth 2FA Works Stack Auth uses the industry-standard TOTP (Time-based One-Time Password) algorithm for two-factor authentication: 1. **User Setup**: When a user enables 2FA in their account settings, Stack Auth generates a secret key that is shared with the user's authenticator app (usually via a QR code). 2. **Code Generation**: The authenticator app generates a 6-digit code that changes every 30 seconds, based on the shared secret and the current time. ## Recommended Authenticator Apps The following authenticator apps are compatible with Stack Auth 2FA: * Google Authenticator (Android, iOS) * Microsoft Authenticator (Android, iOS) * Authy (Android, iOS, desktop) * 1Password (Android, iOS, desktop) * LastPass Authenticator (Android, iOS) # X (Twitter) URL: /docs/concepts/auth-providers/x-twitter Source: /vercel/path0/docs/content/docs/(guides)/concepts/auth-providers/x-twitter.mdx *** ## title: "X (Twitter)" This guide explains how to set up X (formerly Twitter) as an authentication provider with Stack Auth. X OAuth 2.0 allows users to sign in to your application using their X account. ## Integration Steps ### Create an X Developer Account and Project 1. Log in to the [X Developer Portal](https://developer.twitter.com/). 2. Navigate to the [Developer Portal Dashboard](https://developer.twitter.com/en/portal/dashboard). 3. Click on **+ Create Project** to create a new project. 4. Enter a name for your project and select **Web App, Automated App or Bot** as the use case, then click **Next**. 5. Enter a description for your project and click **Next**. 6. Name your app and click **Next**. 7. In the **App settings** section, find your API Key and Secret. These will serve as your OAuth 2.0 Client ID and Client Secret. 8. In the left sidebar, click on your project, then select the app you just created. 9. Click on the **Settings** tab and scroll to the **User authentication settings**. 10. Click **Set up** or **Edit** if already configured. 11. Enable **OAuth 2.0** and set the following details: * **Type of App**: Web App * **Callback URL / Redirect URL**: `https://api.stack-auth.com/api/v1/auth/oauth/callback/x` * **Website URL**: Your website's URL 12. Under **App permissions**, select your scopes. 13. Click **Save** to apply your changes. ### Enable X OAuth in Stack Auth 1. On the Stack Auth dashboard, select **Auth Methods** in the left sidebar. 2. Click **Add SSO Providers** and select **X (Twitter)** as the provider. 3. Set the **Client ID** (your API Key) and **Client Secret** you obtained from the X Developer Portal earlier. ### Need More Help? * Check the [X OAuth 2.0 documentation](https://developer.twitter.com/en/docs/authentication/oauth-2-0) * Join our [Discord](https://discord.stack-auth.com) # Forgot Password URL: /docs/customization/page-examples/forgot-password Source: /vercel/path0/docs/content/docs/(guides)/customization/page-examples/forgot-password.mdx *** ## title: Forgot Password This page provides examples of how to create custom "forgot password" pages for your application. The forgot password functionality allows users to request a password reset email when they can't remember their current password. ## Custom page with `ForgotPassword` component The `ForgotPassword` component provides a complete form for users to request a password reset email. When a user submits their email, Stack Auth will send them an email with a link to reset their password. ```tsx 'use client'; import { ForgotPassword } from "@stackframe/stack"; export default function DefaultForgotPassword() { return ; } ``` ## Integration with Application Routing To integrate the forgot password page with your application's routing: 1. Create a route for your forgot password page (e.g., `/forgot-password`) 2. Configure Stack Auth to use your custom route in your `stack/server.ts` file: ```tsx export const stackServerApp = new StackServerApp({ // ... urls: { forgotPassword: '/forgot-password', } }); ``` This ensures that links to the forgot password page will direct users to your custom implementation. When a user submits their email, Stack Auth will send them an email with a link to the password reset page configured in your application. ## Custom forgot password form If you need more control over the forgot password process, you can build your own form. This approach allows you to customize the UI and error handling to match your application's design. ```tsx 'use client'; import { useStackApp } from "@stackframe/stack"; import { useState } from "react"; export default function CustomForgotPasswordForm() { const [email, setEmail] = useState(''); const [error, setError] = useState(''); const [message, setMessage] = useState(''); const app = useStackApp(); const onSubmit = async () => { if (!email) { setError('Please enter your email address'); setMessage(''); return; } try { const result = await app.sendForgotPasswordEmail(email); if (result?.status === 'error') { if (result.error.code === 'user_not_found') { // For security reasons, don't reveal if a user exists or not setError(''); setMessage('If an account exists with this email, a password reset link has been sent.'); } else { setError(`Error: ${result.error.message}`); setMessage(''); } } else { setError(''); setMessage('Password reset email sent! Please check your inbox.'); } } catch (err) { const message = err instanceof Error ? err.message : 'Unknown error'; setError(`An unexpected error occurred: ${message}`); setMessage(''); } }; return ( ); } ``` # Page Examples URL: /docs/customization/page-examples Source: /vercel/path0/docs/content/docs/(guides)/customization/page-examples/index.mdx *** ## title: Page Examples This section contains examples of how to customize various authentication pages in your Stack Auth application. Browse the examples to learn how to: * Create custom sign-in pages * Build custom sign-up forms * Implement password reset flows * Handle forgotten password scenarios Each example shows both the basic component usage and advanced customization techniques. # Password Reset URL: /docs/customization/page-examples/password-reset Source: /vercel/path0/docs/content/docs/(guides)/customization/page-examples/password-reset.mdx *** ## title: Password Reset This page provides examples of how to create custom password reset pages for your application. Password reset functionality allows users to securely create a new password when they've forgotten their current one. ## Custom page with `PasswordReset` component The `PasswordReset` component provides a complete password reset form with built-in validation and error handling. This is the simplest way to add password reset functionality to your application. ```tsx 'use client'; import { PasswordReset } from "@stackframe/stack"; export default function DefaultPasswordReset() { return ; } ``` ## Integration with Application Routing To integrate the password reset page with your application's routing: 1. Create a route handler that extracts the reset code from the URL (e.g., `/reset-password?code=xyz123`) 2. Pass the code to your password reset component 3. Configure Stack Auth to use your custom route in your `stack/server.ts` file: ```tsx export const stackServerApp = new StackServerApp({ // ... urls: { passwordReset: '/reset-password', } }); ``` This ensures that password reset links in emails will direct users to your custom page. ## Custom password reset form If you need more control over the password reset process, you can build your own form using the Stack Auth API. This approach allows you to customize the UI and error handling to match your application's design. The `code` parameter used below is typically extracted from the URL query parameters. This code is sent to the user's email when they request a password reset and is required to validate the reset request. ```tsx 'use client'; import { useStackApp } from "@stackframe/stack"; import { useState } from "react"; export default function CustomPasswordResetForm({ code }: { code: string }) { const [password, setPassword] = useState(''); const [confirmPassword, setConfirmPassword] = useState(''); const [error, setError] = useState(''); const [success, setSuccess] = useState(false); const app = useStackApp(); const onSubmit = async () => { if (password !== confirmPassword) { setError('Passwords do not match'); return; } try { const result = await app.resetPassword({ password, code }); if (result.status === 'error') { setError('Failed to reset password'); return; } setSuccess(true); } catch (err) { if (err instanceof Error) { setError(`An unexpected error occurred: ${err.message}`); } else { setError('An unexpected error occurred'); } } }; if (success) { return

Password successfully reset!

; } return ( ); } ``` # Sign-In Page Examples URL: /docs/customization/page-examples/sign-in Source: /vercel/path0/docs/content/docs/(guides)/customization/page-examples/sign-in.mdx *** title: Sign-In Page Examples lastModified: "2026-01-12" -------------------------- This page provides examples of how to create custom sign-in pages for your application using Stack Auth components and functions. ## Custom page with `SignIn` component ```tsx title="app/handler/sign-in/page.tsx" 'use client'; import { SignIn } from "@stackframe/stack"; export default function DefaultSignIn() { // optionally redirect to some other page if the user is already signed in // const user = useUser(); // if (user) { redirect to some other page } return ; } ``` You can also use `useUser` at the beginning of the sign-in page to check whether the user is already signed in and redirect them to another page if they are. ## Other useful components `CredentialSignIn`: A component that renders a complete form for signing in with email and password. It handles validation, error states, and submission automatically. `OAuthGroup`: A component that displays a list of available OAuth provider sign-in buttons. The available provider list is automatically fetched from the server based on your project configuration. `OAuthButton`: A component that renders a single OAuth sign-in button for a specific provider. Use this when you only want to offer specific OAuth providers. ## Custom OAuth Sign In ```tsx title="app/handler/sign-in/page.tsx" 'use client'; import { useStackApp } from "@stackframe/stack"; export default function CustomOAuthSignIn() { const app = useStackApp(); return (

My Custom Sign In page

); } ``` ## Custom Credential Sign In ```tsx title="app/handler/sign-in/page.tsx" 'use client'; import { useStackApp } from "@stackframe/stack"; import { useState } from "react"; export default function CustomCredentialSignIn() { const [email, setEmail] = useState(''); const [password, setPassword] = useState(''); const [error, setError] = useState(''); const app = useStackApp(); const onSubmit = async () => { if (!password) { setError('Please enter your password'); return; } // This will redirect to app.urls.afterSignIn if successful. // You can customize the redirect URL in the StackServerApp constructor. const result = await app.signInWithCredential({ email, password }); // It's better to handle each error code separately, but for simplicity, // we'll just display the error message directly here. if (result.status === 'error') { setError(result.error.message); } }; return ( ); } ``` ## Custom Magic Link Sign In ```tsx title="app/handler/sign-in/page.tsx" 'use client'; import { useStackApp } from "@stackframe/stack"; import { useState } from "react"; export default function CustomMagicLinkSignIn() { const [email, setEmail] = useState(''); const [error, setError] = useState(''); const [message, setMessage] = useState(''); const app = useStackApp(); const onSubmit = async () => { if (!email) { setError('Please enter your email address'); return; } // This will send a magic link email to the user's email address. // When they click the link, they will be redirected to your application. const result = await app.sendMagicLinkEmail(email); // It's better to handle each error code separately, but for simplicity, // we'll just display the error message directly here. if (result.status === 'error') { setError(result.error.message); } else { setMessage('Magic link sent! Please check your email.'); } }; return ( ); } ``` # Sign-Up Page Examples URL: /docs/customization/page-examples/sign-up Source: /vercel/path0/docs/content/docs/(guides)/customization/page-examples/sign-up.mdx *** title: Sign-Up Page Examples lastModified: "2026-01-12" -------------------------- This page provides examples of how to create custom sign-up pages for your application using Stack Auth components and functions. ## Custom page with `SignUp` component ```tsx title="app/handler/sign-up/page.tsx" 'use client'; import { SignUp } from "@stackframe/stack"; export default function DefaultSignUp() { // optionally redirect to some other page if the user is already signed in // const user = useUser(); // if (user) { redirect to some other page } return ; } ``` You can also use `useUser` at the beginning of the sign-up page to check whether the user is already signed in and redirect them to another page if they are. ## Other useful components `CredentialSignUp`: A component that renders a complete form for signing up with email and password. It handles validation, error states, and submission automatically. `OAuthGroup`: A component that displays a list of available OAuth provider sign-up buttons. The available provider list is automatically fetched from the server based on your project configuration. `OAuthButton`: A component that renders a single OAuth sign-up button for a specific provider. Use this when you only want to offer specific OAuth providers. ## Custom OAuth Sign Up OAuth sign-in and sign-up share the same function. Check out the [Sign In example](/customization/page-examples/sign-in#custom-oauth-sign-in) for more information. ## Custom Credential Sign Up ```tsx title="app/handler/sign-up/page.tsx" 'use client'; import { useStackApp } from "@stackframe/stack"; import { useState } from "react"; export default function CustomCredentialSignUp() { const [email, setEmail] = useState(''); const [password, setPassword] = useState(''); const [error, setError] = useState(''); const app = useStackApp(); const onSubmit = async () => { if (!password) { setError('Please enter your password'); return; } // This will redirect to app.urls.afterSignUp if successful. // You can customize the redirect URL in the StackServerApp constructor. const result = await app.signUpWithCredential({ email, password }); // It's better to handle each error code separately, but for simplicity, // we'll just display the error message directly here. if (result.status === 'error') { setError(result.error.message); } }; return ( ); } ``` ## Custom Magic Link Sign Up Magic link sign-in and sign-up shares the same function. Check out the [Sign In example](/customization/page-examples/signin#custom-magic-link-sign-in) for more information. # API Reference URL: /api/overview Source: /vercel/path0/docs/content/api/overview.mdx Complete REST API documentation for Stack Auth *** title: API Reference description: Complete REST API documentation for Stack Auth full: true lastModified: "2026-01-16" -------------------------- # REST API & Webhooks Stack products a REST API for backends & frontends of any programming language or framework. This API is used to authenticate users, manage user data, and more. ## Authentication The following authentication headers are common to every endpoint: ```http curl https://api.stack-auth.com/api/v1/ \ -H "X-Stack-Access-Type: " \ -H "X-Stack-Project-Id: " \ -H "X-Stack-Publishable-Client-Key: pck_" \ -H "X-Stack-Secret-Server-Key: ssk_" \ -H "X-Stack-Access-Token: " ``` | Header | Type | Description | | -------------------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------- | | `X-Stack-Access-Type` | "client" \| "server" | Required. "client" (without quotes) for the frontend API, or "server" for the backend API. | | `X-Stack-Project-Id` | UUID | Required. The project ID as found on the Stack dashboard. | | `X-Stack-Publishable-Client-Key` | string | Required for client access. The API key as found on the Stack dashboard. | | `X-Stack-Secret-Server-Key` | string | Required for server access. The API key as found on the Stack dashboard. | | `X-Stack-Access-Token` | string | Optional. The access token for the current user. If not given, the request is considered to be logged out. | {/* IF_PLATFORM python */} To see how to use these headers in various programming languages, see the [Getting Started guide](./../getting-started/setup.mdx). {/* ELSE_IF_PLATFORM js-like */} To see how to use these headers in various programming languages, see the [examples](./../concepts/backend-integration.mdx). {/* END_IF_PLATFORM */} ## Getting Started **Choose the right API**: Select the API category that matches your use case from the cards above **Set up authentication**: Configure the appropriate authentication method (sessions, API keys, or webhook verification) **Make requests**: Use the documented endpoints with proper authentication headers **Handle responses**: Process the API responses according to the documentation and error handling guidelines ## FAQ Any language that has the ability to send HTTP requests can use the Stack REST API. This includes JavaScript, Python, Ruby, Java, Go, C#, Dart, and many more. **Client access type** is mostly used for client-side applications, like a browser or mobile app. The client APIs can only read and update the currently authenticated user's data, and it is usually fine to post the publishable client key in the client-side code. **Server access type**, on the other hand, is for your backend server that you control. It has full access over all user data, and the secret server key should never be exposed to client-side code. For more information, see the concept documentation on [StackApp](../concepts/stack-app#client-vs-server). If you'd like to build your own version of the Stack dashboard (or update project configuration programmatically), you can use the `admin` access type. These endpoints are very dangerous and you should only use them if you know what you're doing. For more information, see the concept documentation on [StackApp](../concepts/stack-app#client-vs-server). Stack Auth API returns standard HTTP status codes. Common error responses include: * `400 Bad Request` - Invalid request parameters * `401 Unauthorized` - Invalid or missing authentication * `403 Forbidden` - Insufficient permissions * `404 Not Found` - Resource not found * `429 Too Many Requests` - Rate limit exceeded * `500 Internal Server Error` - Server error Error responses include a JSON body with additional details about the error. Yes, Stack Auth implements rate limiting to ensure fair usage and system stability. Rate limits vary by endpoint and access type. When you exceed the rate limit, you'll receive a `429 Too Many Requests` response with headers indicating when you can retry. ## Need Help? * Check out our [Getting Started Guide](/docs/getting-started/setup) for initial setup * Join our [Discord community](https://discord.stack-auth.com/) for support and discussions # List project permissions URL: /api/admin/permissions/project-permissions Source: /vercel/path0/docs/content/api/admin/permissions/project-permissions.mdx # API Documentation: List project permissions Query and filter the permission with `user_id` and `permission_id`. `(user_id, permission_id)` together uniquely identify a permission. ## GET /project-permissions **Summary:** List project permissions **Description:** Query and filter the permission with `user_id` and `permission_id`. `(user_id, permission_id)` together uniquely identify a permission. **Parameters:** - `user_id` (query): Filter with the user ID. If set, only the permissions this user has will be returned. Client request must set `user_id=me` - `permission_id` (query): Filter with the permission ID. If set, only the permissions with this specific ID will be returned - `recursive` (query): Whether to list permissions recursively. If set to `false`, only the permission the users directly have will be listed. If set to `true` all the direct and indirect permissions will be listed. **Responses:** - 200: Successful response # List team permissions of a user URL: /api/admin/permissions/team-permissions Source: /vercel/path0/docs/content/api/admin/permissions/team-permissions.mdx # API Documentation: List team permissions of a user Query and filter the permission with `team_id`, `user_id`, and `permission_id`. Note that this might contain the permissions with the same permission ID across different teams and users. `(team_id, user_id, permission_id)` together uniquely identify a permission. ## GET /team-permissions **Summary:** List team permissions of a user **Description:** Query and filter the permission with `team_id`, `user_id`, and `permission_id`. Note that this might contain the permissions with the same permission ID across different teams and users. `(team_id, user_id, permission_id)` together uniquely identify a permission. **Parameters:** - `team_id` (query): Filter with the team ID. If set, only the permissions of the members in a specific team will be returned. - `user_id` (query): Filter with the user ID. If set, only the permissions this user has will be returned. Client request must set `user_id=me` - `permission_id` (query): Filter with the permission ID. If set, only the permissions with this specific ID will be returned - `recursive` (query): Whether to list permissions recursively. If set to `false`, only the permission the users directly have will be listed. If set to `true` all the direct and indirect permissions will be listed. **Responses:** - 200: Successful response # List team invitations URL: /api/admin/teams/team-invitations Source: /vercel/path0/docs/content/api/admin/teams/team-invitations.mdx # API Documentation: List team invitations ## GET /team-invitations **Summary:** List team invitations **Parameters:** - `team_id` (query): The team ID to list invitations for. Required unless user_id is provided. - `user_id` (query): List invitations sent to this user's verified emails. Must be "me" for client access. Cannot be combined with team_id. **Responses:** - 200: Successful response # List team members profiles URL: /api/admin/teams/team-member-profiles Source: /vercel/path0/docs/content/api/admin/teams/team-member-profiles.mdx # API Documentation: List team members profiles List team members profiles and filter by team ID and user ID ## GET /team-member-profiles **Summary:** List team members profiles **Description:** List team members profiles and filter by team ID and user ID **Parameters:** - `user_id` (query): No description - `team_id` (query): No description **Responses:** - 200: Successful response # List OAuth providers URL: /api/client/oauth/oauth-providers Source: /vercel/path0/docs/content/api/client/oauth/oauth-providers.mdx # API Documentation: List OAuth providers Retrieves a list of all OAuth providers for a user. ## GET /oauth-providers **Summary:** List OAuth providers **Description:** Retrieves a list of all OAuth providers for a user. **Parameters:** - `user_id` (query): No description **Responses:** - 200: Successful response # List project permissions URL: /api/client/permissions/project-permissions Source: /vercel/path0/docs/content/api/client/permissions/project-permissions.mdx # API Documentation: List project permissions List global permissions of the current user. `user_id=me` must be set for client requests. `(user_id, permission_id)` together uniquely identify a permission. ## GET /project-permissions **Summary:** List project permissions **Description:** List global permissions of the current user. `user_id=me` must be set for client requests. `(user_id, permission_id)` together uniquely identify a permission. **Parameters:** - `user_id` (query): Filter with the user ID. If set, only the permissions this user has will be returned. Client request must set `user_id=me` - `permission_id` (query): Filter with the permission ID. If set, only the permissions with this specific ID will be returned - `recursive` (query): Whether to list permissions recursively. If set to `false`, only the permission the users directly have will be listed. If set to `true` all the direct and indirect permissions will be listed. **Responses:** - 200: Successful response # List team permissions URL: /api/client/permissions/team-permissions Source: /vercel/path0/docs/content/api/client/permissions/team-permissions.mdx # API Documentation: List team permissions List team permissions of the current user. `user_id=me` must be set for client requests. Note that this might contain the permissions with the same permission ID across different teams. `(team_id, user_id, permission_id)` together uniquely identify a permission. ## GET /team-permissions **Summary:** List team permissions **Description:** List team permissions of the current user. `user_id=me` must be set for client requests. Note that this might contain the permissions with the same permission ID across different teams. `(team_id, user_id, permission_id)` together uniquely identify a permission. **Parameters:** - `team_id` (query): Filter with the team ID. If set, only the permissions of the members in a specific team will be returned. - `user_id` (query): Filter with the user ID. If set, only the permissions this user has will be returned. Client request must set `user_id=me` - `permission_id` (query): Filter with the permission ID. If set, only the permissions with this specific ID will be returned - `recursive` (query): Whether to list permissions recursively. If set to `false`, only the permission the users directly have will be listed. If set to `true` all the direct and indirect permissions will be listed. **Responses:** - 200: Successful response # List team invitations URL: /api/client/teams/team-invitations Source: /vercel/path0/docs/content/api/client/teams/team-invitations.mdx # API Documentation: List team invitations ## GET /team-invitations **Summary:** List team invitations **Parameters:** - `team_id` (query): The team ID to list invitations for. Required unless user_id is provided. - `user_id` (query): List invitations sent to this user's verified emails. Must be "me" for client access. Cannot be combined with team_id. **Responses:** - 200: Successful response # List team members profiles URL: /api/client/teams/team-member-profiles Source: /vercel/path0/docs/content/api/client/teams/team-member-profiles.mdx # API Documentation: List team members profiles List team members profiles. You always need to specify a `team_id` that your are a member of on the client. You can always filter for your own profile by setting `me` as the `user_id` in the path parameters. If you want list all the profiles in a team, you need to have the `$read_members` permission in that team. ## GET /team-member-profiles **Summary:** List team members profiles **Description:** List team members profiles. You always need to specify a `team_id` that your are a member of on the client. You can always filter for your own profile by setting `me` as the `user_id` in the path parameters. If you want list all the profiles in a team, you need to have the `$read_members` permission in that team. **Parameters:** - `user_id` (query): No description - `team_id` (query): No description **Responses:** - 200: Successful response # List project permissions URL: /api/server/permissions/project-permissions Source: /vercel/path0/docs/content/api/server/permissions/project-permissions.mdx # API Documentation: List project permissions Query and filter the permission with `user_id` and `permission_id`. `(user_id, permission_id)` together uniquely identify a permission. ## GET /project-permissions **Summary:** List project permissions **Description:** Query and filter the permission with `user_id` and `permission_id`. `(user_id, permission_id)` together uniquely identify a permission. **Parameters:** - `user_id` (query): Filter with the user ID. If set, only the permissions this user has will be returned. Client request must set `user_id=me` - `permission_id` (query): Filter with the permission ID. If set, only the permissions with this specific ID will be returned - `recursive` (query): Whether to list permissions recursively. If set to `false`, only the permission the users directly have will be listed. If set to `true` all the direct and indirect permissions will be listed. **Responses:** - 200: Successful response # List team permissions of a user URL: /api/server/permissions/team-permissions Source: /vercel/path0/docs/content/api/server/permissions/team-permissions.mdx # API Documentation: List team permissions of a user Query and filter the permission with `team_id`, `user_id`, and `permission_id`. Note that this might contain the permissions with the same permission ID across different teams and users. `(team_id, user_id, permission_id)` together uniquely identify a permission. ## GET /team-permissions **Summary:** List team permissions of a user **Description:** Query and filter the permission with `team_id`, `user_id`, and `permission_id`. Note that this might contain the permissions with the same permission ID across different teams and users. `(team_id, user_id, permission_id)` together uniquely identify a permission. **Parameters:** - `team_id` (query): Filter with the team ID. If set, only the permissions of the members in a specific team will be returned. - `user_id` (query): Filter with the user ID. If set, only the permissions this user has will be returned. Client request must set `user_id=me` - `permission_id` (query): Filter with the permission ID. If set, only the permissions with this specific ID will be returned - `recursive` (query): Whether to list permissions recursively. If set to `false`, only the permission the users directly have will be listed. If set to `true` all the direct and indirect permissions will be listed. **Responses:** - 200: Successful response # List team invitations URL: /api/server/teams/team-invitations Source: /vercel/path0/docs/content/api/server/teams/team-invitations.mdx # API Documentation: List team invitations ## GET /team-invitations **Summary:** List team invitations **Parameters:** - `team_id` (query): The team ID to list invitations for. Required unless user_id is provided. - `user_id` (query): List invitations sent to this user's verified emails. Must be "me" for client access. Cannot be combined with team_id. **Responses:** - 200: Successful response # List team members profiles URL: /api/server/teams/team-member-profiles Source: /vercel/path0/docs/content/api/server/teams/team-member-profiles.mdx # API Documentation: List team members profiles List team members profiles and filter by team ID and user ID ## GET /team-member-profiles **Summary:** List team members profiles **Description:** List team members profiles and filter by team ID and user ID **Parameters:** - `user_id` (query): No description - `team_id` (query): No description **Responses:** - 200: Successful response # team.created URL: /api/webhooks/teams/team.created Source: /vercel/path0/docs/content/api/webhooks/teams/team.created.mdx This event is triggered when a team is created. *** title: team.created description: This event is triggered when a team is created. full: true \_openapi: toc: \[] structuredData: headings: \[] contents: \[] ------------- # team.deleted URL: /api/webhooks/teams/team.deleted Source: /vercel/path0/docs/content/api/webhooks/teams/team.deleted.mdx This event is triggered when a team is deleted. *** title: team.deleted description: This event is triggered when a team is deleted. full: true \_openapi: toc: \[] structuredData: headings: \[] contents: \[] ------------- # team.updated URL: /api/webhooks/teams/team.updated Source: /vercel/path0/docs/content/api/webhooks/teams/team.updated.mdx This event is triggered when a team is updated. *** title: team.updated description: This event is triggered when a team is updated. full: true \_openapi: toc: \[] structuredData: headings: \[] contents: \[] ------------- # team_membership.created URL: /api/webhooks/teams/team_membership.created Source: /vercel/path0/docs/content/api/webhooks/teams/team_membership.created.mdx This event is triggered when a user is added to a team. *** title: team\_membership.created description: This event is triggered when a user is added to a team. full: true \_openapi: toc: \[] structuredData: headings: \[] contents: \[] ------------- # team_membership.deleted URL: /api/webhooks/teams/team_membership.deleted Source: /vercel/path0/docs/content/api/webhooks/teams/team_membership.deleted.mdx This event is triggered when a user is removed from a team. *** title: team\_membership.deleted description: This event is triggered when a user is removed from a team. full: true \_openapi: toc: \[] structuredData: headings: \[] contents: \[] ------------- # team_permission.created URL: /api/webhooks/teams/team_permission.created Source: /vercel/path0/docs/content/api/webhooks/teams/team_permission.created.mdx This event is triggered when a team permission is created. *** title: team\_permission.created description: This event is triggered when a team permission is created. full: true \_openapi: toc: \[] structuredData: headings: \[] contents: \[] ------------- # team_permission.deleted URL: /api/webhooks/teams/team_permission.deleted Source: /vercel/path0/docs/content/api/webhooks/teams/team_permission.deleted.mdx This event is triggered when a team permission is deleted. *** title: team\_permission.deleted description: This event is triggered when a team permission is deleted. full: true \_openapi: toc: \[] structuredData: headings: \[] contents: \[] ------------- # user.created URL: /api/webhooks/users/user.created Source: /vercel/path0/docs/content/api/webhooks/users/user.created.mdx This event is triggered when a user is created. *** title: user.created description: This event is triggered when a user is created. full: true \_openapi: toc: \[] structuredData: headings: \[] contents: \[] ------------- # user.deleted URL: /api/webhooks/users/user.deleted Source: /vercel/path0/docs/content/api/webhooks/users/user.deleted.mdx This event is triggered when a user is deleted. *** title: user.deleted description: This event is triggered when a user is deleted. full: true \_openapi: toc: \[] structuredData: headings: \[] contents: \[] ------------- # user.updated URL: /api/webhooks/users/user.updated Source: /vercel/path0/docs/content/api/webhooks/users/user.updated.mdx This event is triggered when a user is updated. *** title: user.updated description: This event is triggered when a user is updated. full: true \_openapi: toc: \[] structuredData: headings: \[] contents: \[] ------------- # Check team API key validity URL: /api/admin/api-keys/team-api-keys/check Source: /vercel/path0/docs/content/api/admin/api-keys/team-api-keys/check.mdx # API Documentation: Check team API key validity Validate a team API key ## POST /team-api-keys/check **Summary:** Check team API key validity **Description:** Validate a team API key **Request Body:** Request body required **Responses:** - 200: Successful response # List team API keys URL: /api/admin/api-keys/team-api-keys/get Source: /vercel/path0/docs/content/api/admin/api-keys/team-api-keys/get.mdx # API Documentation: List team API keys List all team API keys for the project with their metadata and status ## GET /team-api-keys **Summary:** List team API keys **Description:** List all team API keys for the project with their metadata and status **Parameters:** - `team_id` (query): No description **Responses:** - 200: Successful response # Create team API key URL: /api/admin/api-keys/team-api-keys/post Source: /vercel/path0/docs/content/api/admin/api-keys/team-api-keys/post.mdx # API Documentation: Create team API key Create a new API key for a user or team ## POST /team-api-keys **Summary:** Create team API key **Description:** Create a new API key for a user or team **Request Body:** Request body required **Responses:** - 200: Successful response # Check user API key validity URL: /api/admin/api-keys/user-api-keys/check Source: /vercel/path0/docs/content/api/admin/api-keys/user-api-keys/check.mdx # API Documentation: Check user API key validity Validate a user API key ## POST /user-api-keys/check **Summary:** Check user API key validity **Description:** Validate a user API key **Request Body:** Request body required **Responses:** - 200: Successful response # List user API keys URL: /api/admin/api-keys/user-api-keys/get Source: /vercel/path0/docs/content/api/admin/api-keys/user-api-keys/get.mdx # API Documentation: List user API keys List all user API keys for the project with their metadata and status ## GET /user-api-keys **Summary:** List user API keys **Description:** List all user API keys for the project with their metadata and status **Parameters:** - `user_id` (query): No description **Responses:** - 200: Successful response # Create user API key URL: /api/admin/api-keys/user-api-keys/post Source: /vercel/path0/docs/content/api/admin/api-keys/user-api-keys/post.mdx # API Documentation: Create user API key Create a new API key for a user or team ## POST /user-api-keys **Summary:** Create user API key **Description:** Create a new API key for a user or team **Request Body:** Request body required **Responses:** - 200: Successful response # Initiate CLI authentication URL: /api/admin/cli-authentication/auth/cli Source: /vercel/path0/docs/content/api/admin/cli-authentication/auth/cli.mdx # API Documentation: Initiate CLI authentication Create a new CLI authentication session and return polling and login codes ## POST /auth/cli **Summary:** Initiate CLI authentication **Description:** Create a new CLI authentication session and return polling and login codes **Request Body:** Request body required **Responses:** - 200: Successful response # List contact channels URL: /api/admin/contact-channels/contact-channels/get Source: /vercel/path0/docs/content/api/admin/contact-channels/contact-channels/get.mdx # API Documentation: List contact channels Retrieves a list of all contact channels for a user. ## GET /contact-channels **Summary:** List contact channels **Description:** Retrieves a list of all contact channels for a user. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `contact_channel_id` (query): No description **Responses:** - 200: Successful response # Create a contact channel URL: /api/admin/contact-channels/contact-channels/post Source: /vercel/path0/docs/content/api/admin/contact-channels/contact-channels/post.mdx # API Documentation: Create a contact channel Add a new contact channel for a user. ## POST /contact-channels **Summary:** Create a contact channel **Description:** Add a new contact channel for a user. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `contact_channel_id` (query): No description **Request Body:** Request body required **Responses:** - 201: Successful response # Verify an email URL: /api/admin/contact-channels/contact-channels/verify Source: /vercel/path0/docs/content/api/admin/contact-channels/contact-channels/verify.mdx # API Documentation: Verify an email Verify an email address of a user ## POST /contact-channels/verify **Summary:** Verify an email **Description:** Verify an email address of a user **Request Body:** Request body required **Responses:** - 200: Successful response # Activate email capacity boost URL: /api/admin/emails/emails/capacity-boost Source: /vercel/path0/docs/content/api/admin/emails/emails/capacity-boost.mdx # API Documentation: Activate email capacity boost Temporarily increases email capacity by 4x for 4 hours. ## POST /emails/capacity-boost **Summary:** Activate email capacity boost **Description:** Temporarily increases email capacity by 4x for 4 hours. **Responses:** - 200: Successful response # Get email delivery info URL: /api/admin/emails/emails/delivery-info Source: /vercel/path0/docs/content/api/admin/emails/emails/delivery-info.mdx # API Documentation: Get email delivery info Returns delivery statistics and capacity information for the current tenancy. ## GET /emails/delivery-info **Summary:** Get email delivery info **Description:** Returns delivery statistics and capacity information for the current tenancy. **Responses:** - 200: Successful response # List email outbox URL: /api/admin/emails/emails/outbox Source: /vercel/path0/docs/content/api/admin/emails/emails/outbox.mdx # API Documentation: List email outbox Lists all emails in the outbox with optional filtering by status or simple_status. ## GET /emails/outbox **Summary:** List email outbox **Description:** Lists all emails in the outbox with optional filtering by status or simple_status. **Parameters:** - `status` (query): No description - `simple_status` (query): No description - `limit` (query): The maximum number of items to return. Maximum allowed is 100 - `cursor` (query): The cursor to start the result set from (email ID) **Responses:** - 200: Successful response # Render email theme URL: /api/admin/emails/emails/render-email Source: /vercel/path0/docs/content/api/admin/emails/emails/render-email.mdx # API Documentation: Render email theme Renders HTML content using the specified email theme ## POST /emails/render-email **Summary:** Render email theme **Description:** Renders HTML content using the specified email theme **Responses:** - 200: Successful response # Send email URL: /api/admin/emails/emails/send-email Source: /vercel/path0/docs/content/api/admin/emails/emails/send-email.mdx # API Documentation: Send email Send an email to a list of users. The content field should contain either {html} for HTML emails, {template_id, variables} for template-based emails, or {draft_id} for a draft email. ## POST /emails/send-email **Summary:** Send email **Description:** Send an email to a list of users. The content field should contain either {html} for HTML emails, {template_id, variables} for template-based emails, or {draft_id} for a draft email. **Responses:** - 200: Successful response # List OAuth providers URL: /api/admin/oauth/oauth-providers/get Source: /vercel/path0/docs/content/api/admin/oauth/oauth-providers/get.mdx # API Documentation: List OAuth providers Retrieves a list of all OAuth providers for a user. ## GET /oauth-providers **Summary:** List OAuth providers **Description:** Retrieves a list of all OAuth providers for a user. **Parameters:** - `user_id` (query): No description **Responses:** - 200: Successful response # Create an OAuth provider URL: /api/admin/oauth/oauth-providers/post Source: /vercel/path0/docs/content/api/admin/oauth/oauth-providers/post.mdx # API Documentation: Create an OAuth provider Add a new OAuth provider for a user. ## POST /oauth-providers **Summary:** Create an OAuth provider **Description:** Add a new OAuth provider for a user. **Request Body:** Request body required **Responses:** - 201: Successful response # List project permission definitions URL: /api/admin/permissions/project-permission-definitions/get Source: /vercel/path0/docs/content/api/admin/permissions/project-permission-definitions/get.mdx # API Documentation: List project permission definitions Query and filter project permission definitions (the equivalent of listing permissions on the Stack dashboard) ## GET /project-permission-definitions **Summary:** List project permission definitions **Description:** Query and filter project permission definitions (the equivalent of listing permissions on the Stack dashboard) **Responses:** - 200: Successful response # Create a new project permission definition URL: /api/admin/permissions/project-permission-definitions/post Source: /vercel/path0/docs/content/api/admin/permissions/project-permission-definitions/post.mdx # API Documentation: Create a new project permission definition Create a new project permission definition (the equivalent of creating a new permission on the Stack dashboard) ## POST /project-permission-definitions **Summary:** Create a new project permission definition **Description:** Create a new project permission definition (the equivalent of creating a new permission on the Stack dashboard) **Request Body:** Request body required **Responses:** - 201: Successful response # List team permission definitions URL: /api/admin/permissions/team-permission-definitions/get Source: /vercel/path0/docs/content/api/admin/permissions/team-permission-definitions/get.mdx # API Documentation: List team permission definitions Query and filter the permission with team_id, user_id, and permission_id (the equivalent of listing permissions on the Stack dashboard) ## GET /team-permission-definitions **Summary:** List team permission definitions **Description:** Query and filter the permission with team_id, user_id, and permission_id (the equivalent of listing permissions on the Stack dashboard) **Parameters:** - `limit` (query): Maximum number of items to return (capped at 200). When set, the response is paginated via cursor. - `cursor` (query): Cursor (permission id) to start the next page from. Requires `limit` to also be set. - `query` (query): Free-text filter applied to permission id and description (case-insensitive). **Responses:** - 200: Successful response # Create a new team permission definition URL: /api/admin/permissions/team-permission-definitions/post Source: /vercel/path0/docs/content/api/admin/permissions/team-permission-definitions/post.mdx # API Documentation: Create a new team permission definition Create a new permission definition (the equivalent of creating a new permission on the Stack dashboard) ## POST /team-permission-definitions **Summary:** Create a new team permission definition **Description:** Create a new permission definition (the equivalent of creating a new permission on the Stack dashboard) **Request Body:** Request body required **Responses:** - 201: Successful response # Get the current project URL: /api/admin/projects/projects/current Source: /vercel/path0/docs/content/api/admin/projects/projects/current.mdx # API Documentation: Get the current project Get the current project information including display name, OAuth providers and authentication methods. Useful for displaying the available login options to the user. ## GET /projects/current **Summary:** Get the current project **Description:** Get the current project information including display name, OAuth providers and authentication methods. Useful for displaying the available login options to the user. **Responses:** - 200: Successful response # Accept the team invitation URL: /api/admin/teams/team-invitations/accept Source: /vercel/path0/docs/content/api/admin/teams/team-invitations/accept.mdx # API Documentation: Accept the team invitation Accept invitation and add user to the team ## POST /team-invitations/accept **Summary:** Accept the team invitation **Description:** Accept invitation and add user to the team **Request Body:** Request body required **Responses:** - 200: Successful response # Delete a team invitation URL: /api/admin/teams/team-invitations/id Source: /vercel/path0/docs/content/api/admin/teams/team-invitations/id.mdx # API Documentation: Delete a team invitation ## DELETE /team-invitations/{id} **Summary:** Delete a team invitation **Parameters:** - `team_id` (query): The team ID to list invitations for. Required unless user_id is provided. - `id` (path): No description **Responses:** - 200: Successful response # Send an email to invite a user to a team URL: /api/admin/teams/team-invitations/send-code Source: /vercel/path0/docs/content/api/admin/teams/team-invitations/send-code.mdx # API Documentation: Send an email to invite a user to a team The user receiving this email can join the team by clicking on the link in the email. If the user does not have an account yet, they will be prompted to create one. ## POST /team-invitations/send-code **Summary:** Send an email to invite a user to a team **Description:** The user receiving this email can join the team by clicking on the link in the email. If the user does not have an account yet, they will be prompted to create one. **Request Body:** Request body required **Responses:** - 200: Successful response # List teams URL: /api/admin/teams/teams/get Source: /vercel/path0/docs/content/api/admin/teams/teams/get.mdx # API Documentation: List teams List all the teams in the project. ## GET /teams **Summary:** List teams **Description:** List all the teams in the project. **Parameters:** - `user_id` (query): Filter for the teams that the user is a member of. Can be either `me` or an ID. Must be `me` in the client API - `order_by` (query): Field to order results by. Currently only `created_at` is supported. - `desc` (query): Whether to order results in descending order. Defaults to false (ascending). - `limit` (query): The maximum number of items to return (capped at 200). - `cursor` (query): The cursor to start the result set from. Requires `limit` to also be set. - `query` (query): A search query to filter the results by. Free-text search applied to the team's id (exact-match) and display name. **Responses:** - 200: Successful response # Create a team URL: /api/admin/teams/teams/post Source: /vercel/path0/docs/content/api/admin/teams/teams/post.mdx # API Documentation: Create a team Create a new team and optionally add the current user as a member. ## POST /teams **Summary:** Create a team **Description:** Create a new team and optionally add the current user as a member. **Request Body:** Request body required **Responses:** - 201: Successful response # List users URL: /api/admin/users/users/get Source: /vercel/path0/docs/content/api/admin/users/users/get.mdx # API Documentation: List users Lists all the users in the project. By default, only fully onboarded users are returned. Restricted users (those who haven't completed onboarding requirements like email verification) are included if `include_restricted` is set to `true`. Anonymous users are included if `include_anonymous` is set to `true` (which also includes restricted users). ## GET /users **Summary:** List users **Description:** Lists all the users in the project. By default, only fully onboarded users are returned. Restricted users (those who haven't completed onboarding requirements like email verification) are included if `include_restricted` is set to `true`. Anonymous users are included if `include_anonymous` is set to `true` (which also includes restricted users). **Parameters:** - `team_id` (query): Only return users who are members of the given team - `limit` (query): The maximum number of items to return - `cursor` (query): The cursor to start the result set from. - `order_by` (query): The field to sort the results by. Defaults to signed_up_at - `desc` (query): Whether to sort the results in descending order. Defaults to false - `query` (query): A search query to filter the results by. This is a free-text search that is applied to the user's id (exact-match only), display name and primary email. - `include_anonymous` (query): Whether to include anonymous users in the results. When true, also includes restricted users. Defaults to false - `only_anonymous` (query): Whether to return only anonymous users. When true, implies include_anonymous=true. Defaults to false - `include_restricted` (query): Whether to include restricted users in the results. Defaults to false **Responses:** - 200: Successful response # Create user URL: /api/admin/users/users/post Source: /vercel/path0/docs/content/api/admin/users/users/post.mdx # API Documentation: Create user Creates a new user. E-mail authentication is always enabled, and no password is set, meaning the only way to authenticate the newly created user is through magic link. ## POST /users **Summary:** Create user **Description:** Creates a new user. E-mail authentication is always enabled, and no password is set, meaning the only way to authenticate the newly created user is through magic link. **Request Body:** Request body required **Responses:** - 201: Successful response # List team API keys URL: /api/client/api-keys/team-api-keys/get Source: /vercel/path0/docs/content/api/client/api-keys/team-api-keys/get.mdx # API Documentation: List team API keys List all team API keys for the project with their metadata and status ## GET /team-api-keys **Summary:** List team API keys **Description:** List all team API keys for the project with their metadata and status **Parameters:** - `team_id` (query): No description **Responses:** - 200: Successful response # Create team API key URL: /api/client/api-keys/team-api-keys/post Source: /vercel/path0/docs/content/api/client/api-keys/team-api-keys/post.mdx # API Documentation: Create team API key Create a new API key for a user or team ## POST /team-api-keys **Summary:** Create team API key **Description:** Create a new API key for a user or team **Request Body:** Request body required **Responses:** - 200: Successful response # List user API keys URL: /api/client/api-keys/user-api-keys/get Source: /vercel/path0/docs/content/api/client/api-keys/user-api-keys/get.mdx # API Documentation: List user API keys List all user API keys for the project with their metadata and status ## GET /user-api-keys **Summary:** List user API keys **Description:** List all user API keys for the project with their metadata and status **Parameters:** - `user_id` (query): No description **Responses:** - 200: Successful response # Create user API key URL: /api/client/api-keys/user-api-keys/post Source: /vercel/path0/docs/content/api/client/api-keys/user-api-keys/post.mdx # API Documentation: Create user API key Create a new API key for a user or team ## POST /user-api-keys **Summary:** Create user API key **Description:** Create a new API key for a user or team **Request Body:** Request body required **Responses:** - 200: Successful response # List contact channels URL: /api/client/contact-channels/contact-channels/get Source: /vercel/path0/docs/content/api/client/contact-channels/contact-channels/get.mdx # API Documentation: List contact channels Retrieves a list of all contact channels for a user. ## GET /contact-channels **Summary:** List contact channels **Description:** Retrieves a list of all contact channels for a user. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `contact_channel_id` (query): No description **Responses:** - 200: Successful response # Create a contact channel URL: /api/client/contact-channels/contact-channels/post Source: /vercel/path0/docs/content/api/client/contact-channels/contact-channels/post.mdx # API Documentation: Create a contact channel Add a new contact channel for a user. ## POST /contact-channels **Summary:** Create a contact channel **Description:** Add a new contact channel for a user. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `contact_channel_id` (query): No description **Request Body:** Request body required **Responses:** - 201: Successful response # Verify an email URL: /api/client/contact-channels/contact-channels/verify Source: /vercel/path0/docs/content/api/client/contact-channels/contact-channels/verify.mdx # API Documentation: Verify an email Verify an email address of a user ## POST /contact-channels/verify **Summary:** Verify an email **Description:** Verify an email address of a user **Request Body:** Request body required **Responses:** - 200: Successful response # Initiate CLI authentication URL: /api/client/cli-authentication/auth/cli Source: /vercel/path0/docs/content/api/client/cli-authentication/auth/cli.mdx # API Documentation: Initiate CLI authentication Create a new CLI authentication session and return polling and login codes ## POST /auth/cli **Summary:** Initiate CLI authentication **Description:** Create a new CLI authentication session and return polling and login codes **Request Body:** Request body required **Responses:** - 200: Successful response # Get the current project URL: /api/client/projects/projects/current Source: /vercel/path0/docs/content/api/client/projects/projects/current.mdx # API Documentation: Get the current project Get the current project information including display name, OAuth providers and authentication methods. Useful for displaying the available login options to the user. ## GET /projects/current **Summary:** Get the current project **Description:** Get the current project information including display name, OAuth providers and authentication methods. Useful for displaying the available login options to the user. **Responses:** - 200: Successful response # List sessions URL: /api/client/sessions/auth/sessions Source: /vercel/path0/docs/content/api/client/sessions/auth/sessions.mdx # API Documentation: List sessions List all sessions for the current user. ## GET /auth/sessions **Summary:** List sessions **Description:** List all sessions for the current user. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Accept the team invitation URL: /api/client/teams/team-invitations/accept Source: /vercel/path0/docs/content/api/client/teams/team-invitations/accept.mdx # API Documentation: Accept the team invitation Accept invitation and add user to the team ## POST /team-invitations/accept **Summary:** Accept the team invitation **Description:** Accept invitation and add user to the team **Request Body:** Request body required **Responses:** - 200: Successful response # Delete a team invitation URL: /api/client/teams/team-invitations/id Source: /vercel/path0/docs/content/api/client/teams/team-invitations/id.mdx # API Documentation: Delete a team invitation ## DELETE /team-invitations/{id} **Summary:** Delete a team invitation **Parameters:** - `team_id` (query): The team ID to list invitations for. Required unless user_id is provided. - `id` (path): No description **Responses:** - 200: Successful response # Send an email to invite a user to a team URL: /api/client/teams/team-invitations/send-code Source: /vercel/path0/docs/content/api/client/teams/team-invitations/send-code.mdx # API Documentation: Send an email to invite a user to a team The user receiving this email can join the team by clicking on the link in the email. If the user does not have an account yet, they will be prompted to create one. ## POST /team-invitations/send-code **Summary:** Send an email to invite a user to a team **Description:** The user receiving this email can join the team by clicking on the link in the email. If the user does not have an account yet, they will be prompted to create one. **Request Body:** Request body required **Responses:** - 200: Successful response # List teams URL: /api/client/teams/teams/get Source: /vercel/path0/docs/content/api/client/teams/teams/get.mdx # API Documentation: List teams List all the teams that the current user is a member of. `user_id=me` must be passed in the query parameters. ## GET /teams **Summary:** List teams **Description:** List all the teams that the current user is a member of. `user_id=me` must be passed in the query parameters. **Parameters:** - `user_id` (query): Filter for the teams that the user is a member of. Can be either `me` or an ID. Must be `me` in the client API - `order_by` (query): Field to order results by. Currently only `created_at` is supported. - `desc` (query): Whether to order results in descending order. Defaults to false (ascending). - `limit` (query): The maximum number of items to return (capped at 200). - `cursor` (query): The cursor to start the result set from. Requires `limit` to also be set. - `query` (query): A search query to filter the results by. Free-text search applied to the team's id (exact-match) and display name. **Responses:** - 200: Successful response # Create a team URL: /api/client/teams/teams/post Source: /vercel/path0/docs/content/api/client/teams/teams/post.mdx # API Documentation: Create a team Create a new team and optionally add the current user as a member. ## POST /teams **Summary:** Create a team **Description:** Create a new team and optionally add the current user as a member. **Request Body:** Request body required **Responses:** - 201: Successful response # Check team API key validity URL: /api/server/api-keys/team-api-keys/check Source: /vercel/path0/docs/content/api/server/api-keys/team-api-keys/check.mdx # API Documentation: Check team API key validity Validate a team API key ## POST /team-api-keys/check **Summary:** Check team API key validity **Description:** Validate a team API key **Request Body:** Request body required **Responses:** - 200: Successful response # List team API keys URL: /api/server/api-keys/team-api-keys/get Source: /vercel/path0/docs/content/api/server/api-keys/team-api-keys/get.mdx # API Documentation: List team API keys List all team API keys for the project with their metadata and status ## GET /team-api-keys **Summary:** List team API keys **Description:** List all team API keys for the project with their metadata and status **Parameters:** - `team_id` (query): No description **Responses:** - 200: Successful response # Create team API key URL: /api/server/api-keys/team-api-keys/post Source: /vercel/path0/docs/content/api/server/api-keys/team-api-keys/post.mdx # API Documentation: Create team API key Create a new API key for a user or team ## POST /team-api-keys **Summary:** Create team API key **Description:** Create a new API key for a user or team **Request Body:** Request body required **Responses:** - 200: Successful response # Check user API key validity URL: /api/server/api-keys/user-api-keys/check Source: /vercel/path0/docs/content/api/server/api-keys/user-api-keys/check.mdx # API Documentation: Check user API key validity Validate a user API key ## POST /user-api-keys/check **Summary:** Check user API key validity **Description:** Validate a user API key **Request Body:** Request body required **Responses:** - 200: Successful response # List user API keys URL: /api/server/api-keys/user-api-keys/get Source: /vercel/path0/docs/content/api/server/api-keys/user-api-keys/get.mdx # API Documentation: List user API keys List all user API keys for the project with their metadata and status ## GET /user-api-keys **Summary:** List user API keys **Description:** List all user API keys for the project with their metadata and status **Parameters:** - `user_id` (query): No description **Responses:** - 200: Successful response # Create user API key URL: /api/server/api-keys/user-api-keys/post Source: /vercel/path0/docs/content/api/server/api-keys/user-api-keys/post.mdx # API Documentation: Create user API key Create a new API key for a user or team ## POST /user-api-keys **Summary:** Create user API key **Description:** Create a new API key for a user or team **Request Body:** Request body required **Responses:** - 200: Successful response # Initiate CLI authentication URL: /api/server/cli-authentication/auth/cli Source: /vercel/path0/docs/content/api/server/cli-authentication/auth/cli.mdx # API Documentation: Initiate CLI authentication Create a new CLI authentication session and return polling and login codes ## POST /auth/cli **Summary:** Initiate CLI authentication **Description:** Create a new CLI authentication session and return polling and login codes **Request Body:** Request body required **Responses:** - 200: Successful response # List contact channels URL: /api/server/contact-channels/contact-channels/get Source: /vercel/path0/docs/content/api/server/contact-channels/contact-channels/get.mdx # API Documentation: List contact channels Retrieves a list of all contact channels for a user. ## GET /contact-channels **Summary:** List contact channels **Description:** Retrieves a list of all contact channels for a user. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `contact_channel_id` (query): No description **Responses:** - 200: Successful response # Create a contact channel URL: /api/server/contact-channels/contact-channels/post Source: /vercel/path0/docs/content/api/server/contact-channels/contact-channels/post.mdx # API Documentation: Create a contact channel Add a new contact channel for a user. ## POST /contact-channels **Summary:** Create a contact channel **Description:** Add a new contact channel for a user. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `contact_channel_id` (query): No description **Request Body:** Request body required **Responses:** - 201: Successful response # Verify an email URL: /api/server/contact-channels/contact-channels/verify Source: /vercel/path0/docs/content/api/server/contact-channels/contact-channels/verify.mdx # API Documentation: Verify an email Verify an email address of a user ## POST /contact-channels/verify **Summary:** Verify an email **Description:** Verify an email address of a user **Request Body:** Request body required **Responses:** - 200: Successful response # Activate email capacity boost URL: /api/server/emails/emails/capacity-boost Source: /vercel/path0/docs/content/api/server/emails/emails/capacity-boost.mdx # API Documentation: Activate email capacity boost Temporarily increases email capacity by 4x for 4 hours. ## POST /emails/capacity-boost **Summary:** Activate email capacity boost **Description:** Temporarily increases email capacity by 4x for 4 hours. **Responses:** - 200: Successful response # Get email delivery info URL: /api/server/emails/emails/delivery-info Source: /vercel/path0/docs/content/api/server/emails/emails/delivery-info.mdx # API Documentation: Get email delivery info Returns delivery statistics and capacity information for the current tenancy. ## GET /emails/delivery-info **Summary:** Get email delivery info **Description:** Returns delivery statistics and capacity information for the current tenancy. **Responses:** - 200: Successful response # List email outbox URL: /api/server/emails/emails/outbox Source: /vercel/path0/docs/content/api/server/emails/emails/outbox.mdx # API Documentation: List email outbox Lists all emails in the outbox with optional filtering by status or simple_status. ## GET /emails/outbox **Summary:** List email outbox **Description:** Lists all emails in the outbox with optional filtering by status or simple_status. **Parameters:** - `status` (query): No description - `simple_status` (query): No description - `limit` (query): The maximum number of items to return. Maximum allowed is 100 - `cursor` (query): The cursor to start the result set from (email ID) **Responses:** - 200: Successful response # Send email URL: /api/server/emails/emails/send-email Source: /vercel/path0/docs/content/api/server/emails/emails/send-email.mdx # API Documentation: Send email Send an email to a list of users. The content field should contain either {html} for HTML emails, {template_id, variables} for template-based emails, or {draft_id} for a draft email. ## POST /emails/send-email **Summary:** Send email **Description:** Send an email to a list of users. The content field should contain either {html} for HTML emails, {template_id, variables} for template-based emails, or {draft_id} for a draft email. **Responses:** - 200: Successful response # List OAuth providers URL: /api/server/oauth/oauth-providers/get Source: /vercel/path0/docs/content/api/server/oauth/oauth-providers/get.mdx # API Documentation: List OAuth providers Retrieves a list of all OAuth providers for a user. ## GET /oauth-providers **Summary:** List OAuth providers **Description:** Retrieves a list of all OAuth providers for a user. **Parameters:** - `user_id` (query): No description **Responses:** - 200: Successful response # Create an OAuth provider URL: /api/server/oauth/oauth-providers/post Source: /vercel/path0/docs/content/api/server/oauth/oauth-providers/post.mdx # API Documentation: Create an OAuth provider Add a new OAuth provider for a user. ## POST /oauth-providers **Summary:** Create an OAuth provider **Description:** Add a new OAuth provider for a user. **Request Body:** Request body required **Responses:** - 201: Successful response # Get the current project URL: /api/server/projects/projects/current Source: /vercel/path0/docs/content/api/server/projects/projects/current.mdx # API Documentation: Get the current project Get the current project information including display name, OAuth providers and authentication methods. Useful for displaying the available login options to the user. ## GET /projects/current **Summary:** Get the current project **Description:** Get the current project information including display name, OAuth providers and authentication methods. Useful for displaying the available login options to the user. **Responses:** - 200: Successful response # Accept the team invitation URL: /api/server/teams/team-invitations/accept Source: /vercel/path0/docs/content/api/server/teams/team-invitations/accept.mdx # API Documentation: Accept the team invitation Accept invitation and add user to the team ## POST /team-invitations/accept **Summary:** Accept the team invitation **Description:** Accept invitation and add user to the team **Request Body:** Request body required **Responses:** - 200: Successful response # Delete a team invitation URL: /api/server/teams/team-invitations/id Source: /vercel/path0/docs/content/api/server/teams/team-invitations/id.mdx # API Documentation: Delete a team invitation ## DELETE /team-invitations/{id} **Summary:** Delete a team invitation **Parameters:** - `team_id` (query): The team ID to list invitations for. Required unless user_id is provided. - `id` (path): No description **Responses:** - 200: Successful response # Send an email to invite a user to a team URL: /api/server/teams/team-invitations/send-code Source: /vercel/path0/docs/content/api/server/teams/team-invitations/send-code.mdx # API Documentation: Send an email to invite a user to a team The user receiving this email can join the team by clicking on the link in the email. If the user does not have an account yet, they will be prompted to create one. ## POST /team-invitations/send-code **Summary:** Send an email to invite a user to a team **Description:** The user receiving this email can join the team by clicking on the link in the email. If the user does not have an account yet, they will be prompted to create one. **Request Body:** Request body required **Responses:** - 200: Successful response # List teams URL: /api/server/teams/teams/get Source: /vercel/path0/docs/content/api/server/teams/teams/get.mdx # API Documentation: List teams List all the teams in the project. ## GET /teams **Summary:** List teams **Description:** List all the teams in the project. **Parameters:** - `user_id` (query): Filter for the teams that the user is a member of. Can be either `me` or an ID. Must be `me` in the client API - `order_by` (query): Field to order results by. Currently only `created_at` is supported. - `desc` (query): Whether to order results in descending order. Defaults to false (ascending). - `limit` (query): The maximum number of items to return (capped at 200). - `cursor` (query): The cursor to start the result set from. Requires `limit` to also be set. - `query` (query): A search query to filter the results by. Free-text search applied to the team's id (exact-match) and display name. **Responses:** - 200: Successful response # Create a team URL: /api/server/teams/teams/post Source: /vercel/path0/docs/content/api/server/teams/teams/post.mdx # API Documentation: Create a team Create a new team and optionally add the current user as a member. ## POST /teams **Summary:** Create a team **Description:** Create a new team and optionally add the current user as a member. **Request Body:** Request body required **Responses:** - 201: Successful response # List users URL: /api/server/users/users/get Source: /vercel/path0/docs/content/api/server/users/users/get.mdx # API Documentation: List users Lists all the users in the project. By default, only fully onboarded users are returned. Restricted users (those who haven't completed onboarding requirements like email verification) are included if `include_restricted` is set to `true`. Anonymous users are included if `include_anonymous` is set to `true` (which also includes restricted users). ## GET /users **Summary:** List users **Description:** Lists all the users in the project. By default, only fully onboarded users are returned. Restricted users (those who haven't completed onboarding requirements like email verification) are included if `include_restricted` is set to `true`. Anonymous users are included if `include_anonymous` is set to `true` (which also includes restricted users). **Parameters:** - `team_id` (query): Only return users who are members of the given team - `limit` (query): The maximum number of items to return - `cursor` (query): The cursor to start the result set from. - `order_by` (query): The field to sort the results by. Defaults to signed_up_at - `desc` (query): Whether to sort the results in descending order. Defaults to false - `query` (query): A search query to filter the results by. This is a free-text search that is applied to the user's id (exact-match only), display name and primary email. - `include_anonymous` (query): Whether to include anonymous users in the results. When true, also includes restricted users. Defaults to false - `only_anonymous` (query): Whether to return only anonymous users. When true, implies include_anonymous=true. Defaults to false - `include_restricted` (query): Whether to include restricted users in the results. Defaults to false **Responses:** - 200: Successful response # Create user URL: /api/server/users/users/post Source: /vercel/path0/docs/content/api/server/users/users/post.mdx # API Documentation: Create user Creates a new user. E-mail authentication is always enabled, and no password is set, meaning the only way to authenticate the newly created user is through magic link. ## POST /users **Summary:** Create user **Description:** Creates a new user. E-mail authentication is always enabled, and no password is set, meaning the only way to authenticate the newly created user is through magic link. **Request Body:** Request body required **Responses:** - 201: Successful response # Sign up anonymously URL: /api/admin/anonymous/auth/anonymous/sign-up Source: /vercel/path0/docs/content/api/admin/anonymous/auth/anonymous/sign-up.mdx # API Documentation: Sign up anonymously Create a new anonymous account with no email ## POST /auth/anonymous/sign-up **Summary:** Sign up anonymously **Description:** Create a new anonymous account with no email **Responses:** - 200: Successful response # Get team API key details URL: /api/admin/api-keys/team-api-keys/api_key_id/get Source: /vercel/path0/docs/content/api/admin/api-keys/team-api-keys/api_key_id/get.mdx # API Documentation: Get team API key details Get details of a specific team API key ## GET /team-api-keys/{api_key_id} **Summary:** Get team API key details **Description:** Get details of a specific team API key **Parameters:** - `api_key_id` (path): No description **Responses:** - 200: Successful response # Update team API key URL: /api/admin/api-keys/team-api-keys/api_key_id/patch Source: /vercel/path0/docs/content/api/admin/api-keys/team-api-keys/api_key_id/patch.mdx # API Documentation: Update team API key Update an team API key ## PATCH /team-api-keys/{api_key_id} **Summary:** Update team API key **Description:** Update an team API key **Parameters:** - `api_key_id` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Get user API key details URL: /api/admin/api-keys/user-api-keys/api_key_id/get Source: /vercel/path0/docs/content/api/admin/api-keys/user-api-keys/api_key_id/get.mdx # API Documentation: Get user API key details Get details of a specific user API key ## GET /user-api-keys/{api_key_id} **Summary:** Get user API key details **Description:** Get details of a specific user API key **Parameters:** - `api_key_id` (path): No description **Responses:** - 200: Successful response # Update user API key URL: /api/admin/api-keys/user-api-keys/api_key_id/patch Source: /vercel/path0/docs/content/api/admin/api-keys/user-api-keys/api_key_id/patch.mdx # API Documentation: Update user API key Update an user API key ## PATCH /user-api-keys/{api_key_id} **Summary:** Update user API key **Description:** Update an user API key **Parameters:** - `api_key_id` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Complete CLI authentication URL: /api/admin/cli-authentication/auth/cli/complete Source: /vercel/path0/docs/content/api/admin/cli-authentication/auth/cli/complete.mdx # API Documentation: Complete CLI authentication Inspect, claim, or complete a CLI authentication session ## POST /auth/cli/complete **Summary:** Complete CLI authentication **Description:** Inspect, claim, or complete a CLI authentication session **Request Body:** Request body required **Responses:** - 200: Successful response # Poll CLI authentication status URL: /api/admin/cli-authentication/auth/cli/poll Source: /vercel/path0/docs/content/api/admin/cli-authentication/auth/cli/poll.mdx # API Documentation: Poll CLI authentication status Check the status of a CLI authentication session using the polling code ## POST /auth/cli/poll **Summary:** Poll CLI authentication status **Description:** Check the status of a CLI authentication session using the polling code **Request Body:** Request body required **Responses:** - 200: Successful response - 201: Successful response # Check email verification code URL: /api/admin/contact-channels/contact-channels/verify/check-code Source: /vercel/path0/docs/content/api/admin/contact-channels/contact-channels/verify/check-code.mdx # API Documentation: Check email verification code Check if an email verification code is valid without using it ## POST /contact-channels/verify/check-code **Summary:** Check email verification code **Description:** Check if an email verification code is valid without using it **Request Body:** Request body required **Responses:** - 200: Successful response # List notification preferences URL: /api/admin/emails/emails/notification-preference/user_id Source: /vercel/path0/docs/content/api/admin/emails/emails/notification-preference/user_id.mdx # API Documentation: List notification preferences Get all notification preferences for a user, showing which notification categories are enabled or disabled. ## GET /emails/notification-preference/{user_id} **Summary:** List notification preferences **Description:** Get all notification preferences for a user, showing which notification categories are enabled or disabled. **Parameters:** - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # OAuth token endpoints URL: /api/admin/oauth/auth/oauth/token Source: /vercel/path0/docs/content/api/admin/oauth/auth/oauth/token.mdx # API Documentation: OAuth token endpoints This endpoint is used to exchange an authorization code or refresh token for an access token. ## POST /auth/oauth/token **Summary:** OAuth token endpoints **Description:** This endpoint is used to exchange an authorization code or refresh token for an access token. **Request Body:** Request body required **Responses:** - 200: Successful response # List AI conversations URL: /api/admin/others/internal/ai-conversations/get Source: /vercel/path0/docs/content/api/admin/others/internal/ai-conversations/get.mdx # API Documentation: List AI conversations List AI conversations for the current user filtered by project ## GET /internal/ai-conversations **Summary:** List AI conversations **Description:** List AI conversations for the current user filtered by project **Parameters:** - `projectId` (query): No description **Responses:** - 200: Successful response # Create AI conversation URL: /api/admin/others/internal/ai-conversations/post Source: /vercel/path0/docs/content/api/admin/others/internal/ai-conversations/post.mdx # API Documentation: Create AI conversation Create a new AI conversation with optional initial messages ## POST /internal/ai-conversations **Summary:** Create AI conversation **Description:** Create a new AI conversation with optional initial messages **Request Body:** Request body required **Responses:** - 200: Successful response # List conversations URL: /api/admin/others/internal/conversations/get Source: /vercel/path0/docs/content/api/admin/others/internal/conversations/get.mdx # API Documentation: List conversations List conversations for a managed project ## GET /internal/conversations **Summary:** List conversations **Description:** List conversations for a managed project **Parameters:** - `projectId` (query): The unique identifier of the project - `query` (query): No description - `status` (query): No description - `userId` (query): The unique identifier of the user - `limit` (query): No description - `offset` (query): No description **Responses:** - 200: Successful response # Create conversation URL: /api/admin/others/internal/conversations/post Source: /vercel/path0/docs/content/api/admin/others/internal/conversations/post.mdx # API Documentation: Create conversation Create a managed project conversation for a user ## POST /internal/conversations **Summary:** Create conversation **Description:** Create a managed project conversation for a user **Request Body:** Request body required **Responses:** - 200: Successful response # MFA sign in URL: /api/admin/otp/auth/mfa/sign-in Source: /vercel/path0/docs/content/api/admin/otp/auth/mfa/sign-in.mdx # API Documentation: MFA sign in Complete multi-factor authorization to sign in, with a TOTP and an MFA attempt code ## POST /auth/mfa/sign-in **Summary:** MFA sign in **Description:** Complete multi-factor authorization to sign in, with a TOTP and an MFA attempt code **Request Body:** Request body required **Responses:** - 200: Successful response # Send sign-in code URL: /api/admin/otp/auth/otp/send-sign-in-code Source: /vercel/path0/docs/content/api/admin/otp/auth/otp/send-sign-in-code.mdx # API Documentation: Send sign-in code Send a code to the user's email address for sign-in. ## POST /auth/otp/send-sign-in-code **Summary:** Send sign-in code **Description:** Send a code to the user's email address for sign-in. **Request Body:** Request body required **Responses:** - 200: Successful response # Sign in with a code URL: /api/admin/otp/auth/otp/sign-in Source: /vercel/path0/docs/content/api/admin/otp/auth/otp/sign-in.mdx # API Documentation: Sign in with a code ## POST /auth/otp/sign-in **Summary:** Sign in with a code **Request Body:** Request body required **Responses:** - 200: Successful response # Reset password with a code URL: /api/admin/password/auth/password/reset Source: /vercel/path0/docs/content/api/admin/password/auth/password/reset.mdx # API Documentation: Reset password with a code Reset password with a code ## POST /auth/password/reset **Summary:** Reset password with a code **Description:** Reset password with a code **Request Body:** Request body required **Responses:** - 200: Successful response # Send reset password code URL: /api/admin/password/auth/password/send-reset-code Source: /vercel/path0/docs/content/api/admin/password/auth/password/send-reset-code.mdx # API Documentation: Send reset password code Send a code to the user's email address for resetting the password. ## POST /auth/password/send-reset-code **Summary:** Send reset password code **Description:** Send a code to the user's email address for resetting the password. **Request Body:** Request body required **Responses:** - 200: Successful response # Set password URL: /api/admin/password/auth/password/set Source: /vercel/path0/docs/content/api/admin/password/auth/password/set.mdx # API Documentation: Set password Set a new password for the current user ## POST /auth/password/set **Summary:** Set password **Description:** Set a new password for the current user **Request Body:** Request body required **Responses:** - 200: Successful response # Sign in with email and password URL: /api/admin/password/auth/password/sign-in Source: /vercel/path0/docs/content/api/admin/password/auth/password/sign-in.mdx # API Documentation: Sign in with email and password Sign in to an account with email and password ## POST /auth/password/sign-in **Summary:** Sign in with email and password **Description:** Sign in to an account with email and password **Request Body:** Request body required **Responses:** - 200: Successful response # Sign up with email and password URL: /api/admin/password/auth/password/sign-up Source: /vercel/path0/docs/content/api/admin/password/auth/password/sign-up.mdx # API Documentation: Sign up with email and password Create a new account with email and password ## POST /auth/password/sign-up **Summary:** Sign up with email and password **Description:** Create a new account with email and password **Request Body:** Request body required **Responses:** - 200: Successful response # Update password URL: /api/admin/password/auth/password/update Source: /vercel/path0/docs/content/api/admin/password/auth/password/update.mdx # API Documentation: Update password Update the password of the current user, requires the old password ## POST /auth/password/update **Summary:** Update password **Description:** Update the password of the current user, requires the old password **Parameters:** - `x-stack-refresh-token` (header): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Create Purchase URL URL: /api/admin/payments/payments/purchases/create-purchase-url Source: /vercel/path0/docs/content/api/admin/payments/payments/purchases/create-purchase-url.mdx # API Documentation: Create Purchase URL Creates a secure checkout URL for purchasing a product. ## POST /payments/purchases/create-purchase-url **Summary:** Create Purchase URL **Description:** Creates a secure checkout URL for purchasing a product. **Request Body:** Request body required **Responses:** - 200: Successful response # Create Purchase Session URL: /api/admin/payments/payments/purchases/purchase-session Source: /vercel/path0/docs/content/api/admin/payments/payments/purchases/purchase-session.mdx # API Documentation: Create Purchase Session Creates a purchase session for completing a purchase. ## POST /payments/purchases/purchase-session **Summary:** Create Purchase Session **Description:** Creates a purchase session for completing a purchase. **Request Body:** Request body required **Responses:** - 200: Successful response # Validate Purchase Code URL: /api/admin/payments/payments/purchases/validate-code Source: /vercel/path0/docs/content/api/admin/payments/payments/purchases/validate-code.mdx # API Documentation: Validate Purchase Code Validates a purchase verification code and returns purchase details including available prices. ## POST /payments/purchases/validate-code **Summary:** Validate Purchase Code **Description:** Validates a purchase verification code and returns purchase details including available prices. **Request Body:** Request body required **Responses:** - 200: Successful response # Delete a project permission definition URL: /api/admin/permissions/project-permission-definitions/permission_id/delete Source: /vercel/path0/docs/content/api/admin/permissions/project-permission-definitions/permission_id/delete.mdx # API Documentation: Delete a project permission definition Delete a project permission definition (the equivalent of deleting a permission on the Stack dashboard) ## DELETE /project-permission-definitions/{permission_id} **Summary:** Delete a project permission definition **Description:** Delete a project permission definition (the equivalent of deleting a permission on the Stack dashboard) **Parameters:** - `permission_id` (path): The permission ID used to uniquely identify a permission. Can either be a custom permission with lowercase letters, numbers, `:`, and `_` characters, or one of the system permissions: `$update_team`, `$delete_team`, `$read_members`, `$remove_members`, `$invite_members`, `$manage_api_keys` **Responses:** - 200: Successful response # Update a project permission definition URL: /api/admin/permissions/project-permission-definitions/permission_id/patch Source: /vercel/path0/docs/content/api/admin/permissions/project-permission-definitions/permission_id/patch.mdx # API Documentation: Update a project permission definition Update a project permission definition (the equivalent of updating a permission on the Stack dashboard) ## PATCH /project-permission-definitions/{permission_id} **Summary:** Update a project permission definition **Description:** Update a project permission definition (the equivalent of updating a permission on the Stack dashboard) **Parameters:** - `permission_id` (path): The permission ID used to uniquely identify a permission. Can either be a custom permission with lowercase letters, numbers, `:`, and `_` characters, or one of the system permissions: `$update_team`, `$delete_team`, `$read_members`, `$remove_members`, `$invite_members`, `$manage_api_keys` **Request Body:** Request body required **Responses:** - 200: Successful response # Delete a team permission definition URL: /api/admin/permissions/team-permission-definitions/permission_id/delete Source: /vercel/path0/docs/content/api/admin/permissions/team-permission-definitions/permission_id/delete.mdx # API Documentation: Delete a team permission definition Delete a permission definition (the equivalent of deleting a permission on the Stack dashboard) ## DELETE /team-permission-definitions/{permission_id} **Summary:** Delete a team permission definition **Description:** Delete a permission definition (the equivalent of deleting a permission on the Stack dashboard) **Parameters:** - `permission_id` (path): The permission ID used to uniquely identify a permission. Can either be a custom permission with lowercase letters, numbers, `:`, and `_` characters, or one of the system permissions: `$update_team`, `$delete_team`, `$read_members`, `$remove_members`, `$invite_members`, `$manage_api_keys` **Responses:** - 200: Successful response # Update a team permission definition URL: /api/admin/permissions/team-permission-definitions/permission_id/patch Source: /vercel/path0/docs/content/api/admin/permissions/team-permission-definitions/permission_id/patch.mdx # API Documentation: Update a team permission definition Update a permission definition (the equivalent of updating a permission on the Stack dashboard) ## PATCH /team-permission-definitions/{permission_id} **Summary:** Update a team permission definition **Description:** Update a permission definition (the equivalent of updating a permission on the Stack dashboard) **Parameters:** - `permission_id` (path): The permission ID used to uniquely identify a permission. Can either be a custom permission with lowercase letters, numbers, `:`, and `_` characters, or one of the system permissions: `$update_team`, `$delete_team`, `$read_members`, `$remove_members`, `$invite_members`, `$manage_api_keys` **Request Body:** Request body required **Responses:** - 200: Successful response # Sign out of the current session URL: /api/admin/sessions/auth/sessions/current Source: /vercel/path0/docs/content/api/admin/sessions/auth/sessions/current.mdx # API Documentation: Sign out of the current session Sign out of the current session and invalidate the refresh token ## DELETE /auth/sessions/current **Summary:** Sign out of the current session **Description:** Sign out of the current session and invalidate the refresh token **Responses:** - 200: Successful response # List sessions URL: /api/admin/sessions/auth/sessions/get Source: /vercel/path0/docs/content/api/admin/sessions/auth/sessions/get.mdx # API Documentation: List sessions List all sessions for the current user. ## GET /auth/sessions **Summary:** List sessions **Description:** List all sessions for the current user. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Delete session URL: /api/admin/sessions/auth/sessions/id Source: /vercel/path0/docs/content/api/admin/sessions/auth/sessions/id.mdx # API Documentation: Delete session Delete a session by ID. ## DELETE /auth/sessions/{id} **Summary:** Delete session **Description:** Delete a session by ID. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `id` (path): No description **Responses:** - 200: Successful response # Create session URL: /api/admin/sessions/auth/sessions/post Source: /vercel/path0/docs/content/api/admin/sessions/auth/sessions/post.mdx # API Documentation: Create session Create a new session for a given user. This will return a refresh token that can be used to impersonate the user. ## POST /auth/sessions **Summary:** Create session **Description:** Create a new session for a given user. This will return a refresh token that can be used to impersonate the user. **Request Body:** Request body required **Responses:** - 200: Successful response # Check if a team invitation code is valid URL: /api/admin/teams/team-invitations/accept/check-code Source: /vercel/path0/docs/content/api/admin/teams/team-invitations/accept/check-code.mdx # API Documentation: Check if a team invitation code is valid Check if a team invitation code is valid without using it ## POST /team-invitations/accept/check-code **Summary:** Check if a team invitation code is valid **Description:** Check if a team invitation code is valid without using it **Request Body:** Request body required **Responses:** - 200: Successful response # Get team invitation details URL: /api/admin/teams/team-invitations/accept/details Source: /vercel/path0/docs/content/api/admin/teams/team-invitations/accept/details.mdx # API Documentation: Get team invitation details Get additional information about a team invitation code ## POST /team-invitations/accept/details **Summary:** Get team invitation details **Description:** Get additional information about a team invitation code **Request Body:** Request body required **Responses:** - 200: Successful response # Accept a team invitation by ID URL: /api/admin/teams/team-invitations/id/accept Source: /vercel/path0/docs/content/api/admin/teams/team-invitations/id/accept.mdx # API Documentation: Accept a team invitation by ID Accepts a team invitation for the specified user. The user must have a verified email matching the invitation's recipient email. This marks the invitation as used and adds the user to the team. ## POST /team-invitations/{id}/accept **Summary:** Accept a team invitation by ID **Description:** Accepts a team invitation for the specified user. The user must have a verified email matching the invitation's recipient email. This marks the invitation as used and adds the user to the team. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `id` (path): No description **Responses:** - 200: Successful response # Delete a team URL: /api/admin/teams/teams/team_id/delete Source: /vercel/path0/docs/content/api/admin/teams/teams/team_id/delete.mdx # API Documentation: Delete a team Delete a team by ID. ## DELETE /teams/{team_id} **Summary:** Delete a team **Description:** Delete a team by ID. **Parameters:** - `team_id` (path): No description **Responses:** - 200: Successful response # Get a team URL: /api/admin/teams/teams/team_id/get Source: /vercel/path0/docs/content/api/admin/teams/teams/team_id/get.mdx # API Documentation: Get a team Get a team by ID. ## GET /teams/{team_id} **Summary:** Get a team **Description:** Get a team by ID. **Parameters:** - `team_id` (path): No description **Responses:** - 200: Successful response # Update a team URL: /api/admin/teams/teams/team_id/patch Source: /vercel/path0/docs/content/api/admin/teams/teams/team_id/patch.mdx # API Documentation: Update a team Update the team information by ID. ## PATCH /teams/{team_id} **Summary:** Update a team **Description:** Update the team information by ID. **Parameters:** - `team_id` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Delete current user URL: /api/admin/users/users/me/delete Source: /vercel/path0/docs/content/api/admin/users/users/me/delete.mdx # API Documentation: Delete current user Deletes the currently authenticated user. Use this with caution. ## DELETE /users/me **Summary:** Delete current user **Description:** Deletes the currently authenticated user. Use this with caution. **Responses:** - 200: Successful response # Get current user URL: /api/admin/users/users/me/get Source: /vercel/path0/docs/content/api/admin/users/users/me/get.mdx # API Documentation: Get current user Gets the currently authenticated user. ## GET /users/me **Summary:** Get current user **Description:** Gets the currently authenticated user. **Responses:** - 200: Successful response # Update current user URL: /api/admin/users/users/me/patch Source: /vercel/path0/docs/content/api/admin/users/users/me/patch.mdx # API Documentation: Update current user Updates the currently authenticated user. Only the values provided will be updated. ## PATCH /users/me **Summary:** Update current user **Description:** Updates the currently authenticated user. Only the values provided will be updated. **Request Body:** Request body required **Responses:** - 200: Successful response # Delete user URL: /api/admin/users/users/user_id/delete Source: /vercel/path0/docs/content/api/admin/users/users/user_id/delete.mdx # API Documentation: Delete user Deletes a user. Use this with caution. ## DELETE /users/{user_id} **Summary:** Delete user **Description:** Deletes a user. Use this with caution. **Parameters:** - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Get user URL: /api/admin/users/users/user_id/get Source: /vercel/path0/docs/content/api/admin/users/users/user_id/get.mdx # API Documentation: Get user Gets a user by user ID. ## GET /users/{user_id} **Summary:** Get user **Description:** Gets a user by user ID. **Parameters:** - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Update user URL: /api/admin/users/users/user_id/patch Source: /vercel/path0/docs/content/api/admin/users/users/user_id/patch.mdx # API Documentation: Update user Updates a user. Only the values provided will be updated. ## PATCH /users/{user_id} **Summary:** Update user **Description:** Updates a user. Only the values provided will be updated. **Parameters:** - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Request Body:** Request body required **Responses:** - 200: Successful response # Sign up anonymously URL: /api/client/anonymous/auth/anonymous/sign-up Source: /vercel/path0/docs/content/api/client/anonymous/auth/anonymous/sign-up.mdx # API Documentation: Sign up anonymously Create a new anonymous account with no email ## POST /auth/anonymous/sign-up **Summary:** Sign up anonymously **Description:** Create a new anonymous account with no email **Responses:** - 200: Successful response # Get team API key details URL: /api/client/api-keys/team-api-keys/api_key_id/get Source: /vercel/path0/docs/content/api/client/api-keys/team-api-keys/api_key_id/get.mdx # API Documentation: Get team API key details Get details of a specific team API key ## GET /team-api-keys/{api_key_id} **Summary:** Get team API key details **Description:** Get details of a specific team API key **Parameters:** - `api_key_id` (path): No description **Responses:** - 200: Successful response # Update team API key URL: /api/client/api-keys/team-api-keys/api_key_id/patch Source: /vercel/path0/docs/content/api/client/api-keys/team-api-keys/api_key_id/patch.mdx # API Documentation: Update team API key Update an team API key ## PATCH /team-api-keys/{api_key_id} **Summary:** Update team API key **Description:** Update an team API key **Parameters:** - `api_key_id` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Get user API key details URL: /api/client/api-keys/user-api-keys/api_key_id/get Source: /vercel/path0/docs/content/api/client/api-keys/user-api-keys/api_key_id/get.mdx # API Documentation: Get user API key details Get details of a specific user API key ## GET /user-api-keys/{api_key_id} **Summary:** Get user API key details **Description:** Get details of a specific user API key **Parameters:** - `api_key_id` (path): No description **Responses:** - 200: Successful response # Update user API key URL: /api/client/api-keys/user-api-keys/api_key_id/patch Source: /vercel/path0/docs/content/api/client/api-keys/user-api-keys/api_key_id/patch.mdx # API Documentation: Update user API key Update an user API key ## PATCH /user-api-keys/{api_key_id} **Summary:** Update user API key **Description:** Update an user API key **Parameters:** - `api_key_id` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Check email verification code URL: /api/client/contact-channels/contact-channels/verify/check-code Source: /vercel/path0/docs/content/api/client/contact-channels/contact-channels/verify/check-code.mdx # API Documentation: Check email verification code Check if an email verification code is valid without using it ## POST /contact-channels/verify/check-code **Summary:** Check email verification code **Description:** Check if an email verification code is valid without using it **Request Body:** Request body required **Responses:** - 200: Successful response # Complete CLI authentication URL: /api/client/cli-authentication/auth/cli/complete Source: /vercel/path0/docs/content/api/client/cli-authentication/auth/cli/complete.mdx # API Documentation: Complete CLI authentication Inspect, claim, or complete a CLI authentication session ## POST /auth/cli/complete **Summary:** Complete CLI authentication **Description:** Inspect, claim, or complete a CLI authentication session **Request Body:** Request body required **Responses:** - 200: Successful response # Poll CLI authentication status URL: /api/client/cli-authentication/auth/cli/poll Source: /vercel/path0/docs/content/api/client/cli-authentication/auth/cli/poll.mdx # API Documentation: Poll CLI authentication status Check the status of a CLI authentication session using the polling code ## POST /auth/cli/poll **Summary:** Poll CLI authentication status **Description:** Check the status of a CLI authentication session using the polling code **Request Body:** Request body required **Responses:** - 200: Successful response - 201: Successful response # List notification preferences URL: /api/client/emails/emails/notification-preference/user_id Source: /vercel/path0/docs/content/api/client/emails/emails/notification-preference/user_id.mdx # API Documentation: List notification preferences Get all notification preferences for a user, showing which notification categories are enabled or disabled. ## GET /emails/notification-preference/{user_id} **Summary:** List notification preferences **Description:** Get all notification preferences for a user, showing which notification categories are enabled or disabled. **Parameters:** - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # OAuth token endpoints URL: /api/client/oauth/auth/oauth/token Source: /vercel/path0/docs/content/api/client/oauth/auth/oauth/token.mdx # API Documentation: OAuth token endpoints This endpoint is used to exchange an authorization code or refresh token for an access token. ## POST /auth/oauth/token **Summary:** OAuth token endpoints **Description:** This endpoint is used to exchange an authorization code or refresh token for an access token. **Request Body:** Request body required **Responses:** - 200: Successful response # List AI conversations URL: /api/client/others/internal/ai-conversations/get Source: /vercel/path0/docs/content/api/client/others/internal/ai-conversations/get.mdx # API Documentation: List AI conversations List AI conversations for the current user filtered by project ## GET /internal/ai-conversations **Summary:** List AI conversations **Description:** List AI conversations for the current user filtered by project **Parameters:** - `projectId` (query): No description **Responses:** - 200: Successful response # Create AI conversation URL: /api/client/others/internal/ai-conversations/post Source: /vercel/path0/docs/content/api/client/others/internal/ai-conversations/post.mdx # API Documentation: Create AI conversation Create a new AI conversation with optional initial messages ## POST /internal/ai-conversations **Summary:** Create AI conversation **Description:** Create a new AI conversation with optional initial messages **Request Body:** Request body required **Responses:** - 200: Successful response # List conversations URL: /api/client/others/internal/conversations/get Source: /vercel/path0/docs/content/api/client/others/internal/conversations/get.mdx # API Documentation: List conversations List conversations for a managed project ## GET /internal/conversations **Summary:** List conversations **Description:** List conversations for a managed project **Parameters:** - `projectId` (query): The unique identifier of the project - `query` (query): No description - `status` (query): No description - `userId` (query): The unique identifier of the user - `limit` (query): No description - `offset` (query): No description **Responses:** - 200: Successful response # Create conversation URL: /api/client/others/internal/conversations/post Source: /vercel/path0/docs/content/api/client/others/internal/conversations/post.mdx # API Documentation: Create conversation Create a managed project conversation for a user ## POST /internal/conversations **Summary:** Create conversation **Description:** Create a managed project conversation for a user **Request Body:** Request body required **Responses:** - 200: Successful response # MFA sign in URL: /api/client/otp/auth/mfa/sign-in Source: /vercel/path0/docs/content/api/client/otp/auth/mfa/sign-in.mdx # API Documentation: MFA sign in Complete multi-factor authorization to sign in, with a TOTP and an MFA attempt code ## POST /auth/mfa/sign-in **Summary:** MFA sign in **Description:** Complete multi-factor authorization to sign in, with a TOTP and an MFA attempt code **Request Body:** Request body required **Responses:** - 200: Successful response # Send sign-in code URL: /api/client/otp/auth/otp/send-sign-in-code Source: /vercel/path0/docs/content/api/client/otp/auth/otp/send-sign-in-code.mdx # API Documentation: Send sign-in code Send a code to the user's email address for sign-in. ## POST /auth/otp/send-sign-in-code **Summary:** Send sign-in code **Description:** Send a code to the user's email address for sign-in. **Request Body:** Request body required **Responses:** - 200: Successful response # Sign in with a code URL: /api/client/otp/auth/otp/sign-in Source: /vercel/path0/docs/content/api/client/otp/auth/otp/sign-in.mdx # API Documentation: Sign in with a code ## POST /auth/otp/sign-in **Summary:** Sign in with a code **Request Body:** Request body required **Responses:** - 200: Successful response # Reset password with a code URL: /api/client/password/auth/password/reset Source: /vercel/path0/docs/content/api/client/password/auth/password/reset.mdx # API Documentation: Reset password with a code Reset password with a code ## POST /auth/password/reset **Summary:** Reset password with a code **Description:** Reset password with a code **Request Body:** Request body required **Responses:** - 200: Successful response # Send reset password code URL: /api/client/password/auth/password/send-reset-code Source: /vercel/path0/docs/content/api/client/password/auth/password/send-reset-code.mdx # API Documentation: Send reset password code Send a code to the user's email address for resetting the password. ## POST /auth/password/send-reset-code **Summary:** Send reset password code **Description:** Send a code to the user's email address for resetting the password. **Request Body:** Request body required **Responses:** - 200: Successful response # Set password URL: /api/client/password/auth/password/set Source: /vercel/path0/docs/content/api/client/password/auth/password/set.mdx # API Documentation: Set password Set a new password for the current user ## POST /auth/password/set **Summary:** Set password **Description:** Set a new password for the current user **Request Body:** Request body required **Responses:** - 200: Successful response # Sign in with email and password URL: /api/client/password/auth/password/sign-in Source: /vercel/path0/docs/content/api/client/password/auth/password/sign-in.mdx # API Documentation: Sign in with email and password Sign in to an account with email and password ## POST /auth/password/sign-in **Summary:** Sign in with email and password **Description:** Sign in to an account with email and password **Request Body:** Request body required **Responses:** - 200: Successful response # Sign up with email and password URL: /api/client/password/auth/password/sign-up Source: /vercel/path0/docs/content/api/client/password/auth/password/sign-up.mdx # API Documentation: Sign up with email and password Create a new account with email and password ## POST /auth/password/sign-up **Summary:** Sign up with email and password **Description:** Create a new account with email and password **Request Body:** Request body required **Responses:** - 200: Successful response # Update password URL: /api/client/password/auth/password/update Source: /vercel/path0/docs/content/api/client/password/auth/password/update.mdx # API Documentation: Update password Update the password of the current user, requires the old password ## POST /auth/password/update **Summary:** Update password **Description:** Update the password of the current user, requires the old password **Parameters:** - `x-stack-refresh-token` (header): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Create Purchase URL URL: /api/client/payments/payments/purchases/create-purchase-url Source: /vercel/path0/docs/content/api/client/payments/payments/purchases/create-purchase-url.mdx # API Documentation: Create Purchase URL Creates a secure checkout URL for purchasing a product. ## POST /payments/purchases/create-purchase-url **Summary:** Create Purchase URL **Description:** Creates a secure checkout URL for purchasing a product. **Request Body:** Request body required **Responses:** - 200: Successful response # Create Purchase Session URL: /api/client/payments/payments/purchases/purchase-session Source: /vercel/path0/docs/content/api/client/payments/payments/purchases/purchase-session.mdx # API Documentation: Create Purchase Session Creates a purchase session for completing a purchase. ## POST /payments/purchases/purchase-session **Summary:** Create Purchase Session **Description:** Creates a purchase session for completing a purchase. **Request Body:** Request body required **Responses:** - 200: Successful response # Validate Purchase Code URL: /api/client/payments/payments/purchases/validate-code Source: /vercel/path0/docs/content/api/client/payments/payments/purchases/validate-code.mdx # API Documentation: Validate Purchase Code Validates a purchase verification code and returns purchase details including available prices. ## POST /payments/purchases/validate-code **Summary:** Validate Purchase Code **Description:** Validates a purchase verification code and returns purchase details including available prices. **Request Body:** Request body required **Responses:** - 200: Successful response # Sign out of the current session URL: /api/client/sessions/auth/sessions/current Source: /vercel/path0/docs/content/api/client/sessions/auth/sessions/current.mdx # API Documentation: Sign out of the current session Sign out of the current session and invalidate the refresh token ## DELETE /auth/sessions/current **Summary:** Sign out of the current session **Description:** Sign out of the current session and invalidate the refresh token **Responses:** - 200: Successful response # Delete session URL: /api/client/sessions/auth/sessions/id Source: /vercel/path0/docs/content/api/client/sessions/auth/sessions/id.mdx # API Documentation: Delete session Delete a session by ID. ## DELETE /auth/sessions/{id} **Summary:** Delete session **Description:** Delete a session by ID. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `id` (path): No description **Responses:** - 200: Successful response # Check if a team invitation code is valid URL: /api/client/teams/team-invitations/accept/check-code Source: /vercel/path0/docs/content/api/client/teams/team-invitations/accept/check-code.mdx # API Documentation: Check if a team invitation code is valid Check if a team invitation code is valid without using it ## POST /team-invitations/accept/check-code **Summary:** Check if a team invitation code is valid **Description:** Check if a team invitation code is valid without using it **Request Body:** Request body required **Responses:** - 200: Successful response # Get team invitation details URL: /api/client/teams/team-invitations/accept/details Source: /vercel/path0/docs/content/api/client/teams/team-invitations/accept/details.mdx # API Documentation: Get team invitation details Get additional information about a team invitation code ## POST /team-invitations/accept/details **Summary:** Get team invitation details **Description:** Get additional information about a team invitation code **Request Body:** Request body required **Responses:** - 200: Successful response # Accept a team invitation by ID URL: /api/client/teams/team-invitations/id/accept Source: /vercel/path0/docs/content/api/client/teams/team-invitations/id/accept.mdx # API Documentation: Accept a team invitation by ID Accepts a team invitation for the specified user. The user must have a verified email matching the invitation's recipient email. This marks the invitation as used and adds the user to the team. ## POST /team-invitations/{id}/accept **Summary:** Accept a team invitation by ID **Description:** Accepts a team invitation for the specified user. The user must have a verified email matching the invitation's recipient email. This marks the invitation as used and adds the user to the team. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `id` (path): No description **Responses:** - 200: Successful response # Remove a user from a team URL: /api/client/teams/team-memberships/team_id/user_id Source: /vercel/path0/docs/content/api/client/teams/team-memberships/team_id/user_id.mdx # API Documentation: Remove a user from a team All the users are allowed to remove themselves from a team (`user_id=me`). Only the users who have the `$remove_members` permission are allowed to remove other users from a team. `team_id` is must an ID of a team that the user is a member of. ## DELETE /team-memberships/{team_id}/{user_id} **Summary:** Remove a user from a team **Description:** All the users are allowed to remove themselves from a team (`user_id=me`). Only the users who have the `$remove_members` permission are allowed to remove other users from a team. `team_id` is must an ID of a team that the user is a member of. **Parameters:** - `team_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Delete a team URL: /api/client/teams/teams/team_id/delete Source: /vercel/path0/docs/content/api/client/teams/teams/team_id/delete.mdx # API Documentation: Delete a team Delete a team. Only allowed if the current user is a member of the team and has the `$delete_team` permission. ## DELETE /teams/{team_id} **Summary:** Delete a team **Description:** Delete a team. Only allowed if the current user is a member of the team and has the `$delete_team` permission. **Parameters:** - `team_id` (path): No description **Responses:** - 200: Successful response # Get a team URL: /api/client/teams/teams/team_id/get Source: /vercel/path0/docs/content/api/client/teams/teams/team_id/get.mdx # API Documentation: Get a team Get a team that the current user is a member of. ## GET /teams/{team_id} **Summary:** Get a team **Description:** Get a team that the current user is a member of. **Parameters:** - `team_id` (path): No description **Responses:** - 200: Successful response # Update a team URL: /api/client/teams/teams/team_id/patch Source: /vercel/path0/docs/content/api/client/teams/teams/team_id/patch.mdx # API Documentation: Update a team Update the team information. Only allowed if the current user is a member of the team and has the `$update_team` permission. ## PATCH /teams/{team_id} **Summary:** Update a team **Description:** Update the team information. Only allowed if the current user is a member of the team and has the `$update_team` permission. **Parameters:** - `team_id` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Delete current user URL: /api/client/users/users/me/delete Source: /vercel/path0/docs/content/api/client/users/users/me/delete.mdx # API Documentation: Delete current user Deletes the currently authenticated user. Use this with caution. ## DELETE /users/me **Summary:** Delete current user **Description:** Deletes the currently authenticated user. Use this with caution. **Responses:** - 200: Successful response # Get current user URL: /api/client/users/users/me/get Source: /vercel/path0/docs/content/api/client/users/users/me/get.mdx # API Documentation: Get current user Gets the currently authenticated user. ## GET /users/me **Summary:** Get current user **Description:** Gets the currently authenticated user. **Responses:** - 200: Successful response # Update current user URL: /api/client/users/users/me/patch Source: /vercel/path0/docs/content/api/client/users/users/me/patch.mdx # API Documentation: Update current user Updates the currently authenticated user. Only the values provided will be updated. ## PATCH /users/me **Summary:** Update current user **Description:** Updates the currently authenticated user. Only the values provided will be updated. **Request Body:** Request body required **Responses:** - 200: Successful response # Sign up anonymously URL: /api/server/anonymous/auth/anonymous/sign-up Source: /vercel/path0/docs/content/api/server/anonymous/auth/anonymous/sign-up.mdx # API Documentation: Sign up anonymously Create a new anonymous account with no email ## POST /auth/anonymous/sign-up **Summary:** Sign up anonymously **Description:** Create a new anonymous account with no email **Responses:** - 200: Successful response # Get team API key details URL: /api/server/api-keys/team-api-keys/api_key_id/get Source: /vercel/path0/docs/content/api/server/api-keys/team-api-keys/api_key_id/get.mdx # API Documentation: Get team API key details Get details of a specific team API key ## GET /team-api-keys/{api_key_id} **Summary:** Get team API key details **Description:** Get details of a specific team API key **Parameters:** - `api_key_id` (path): No description **Responses:** - 200: Successful response # Update team API key URL: /api/server/api-keys/team-api-keys/api_key_id/patch Source: /vercel/path0/docs/content/api/server/api-keys/team-api-keys/api_key_id/patch.mdx # API Documentation: Update team API key Update an team API key ## PATCH /team-api-keys/{api_key_id} **Summary:** Update team API key **Description:** Update an team API key **Parameters:** - `api_key_id` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Get user API key details URL: /api/server/api-keys/user-api-keys/api_key_id/get Source: /vercel/path0/docs/content/api/server/api-keys/user-api-keys/api_key_id/get.mdx # API Documentation: Get user API key details Get details of a specific user API key ## GET /user-api-keys/{api_key_id} **Summary:** Get user API key details **Description:** Get details of a specific user API key **Parameters:** - `api_key_id` (path): No description **Responses:** - 200: Successful response # Update user API key URL: /api/server/api-keys/user-api-keys/api_key_id/patch Source: /vercel/path0/docs/content/api/server/api-keys/user-api-keys/api_key_id/patch.mdx # API Documentation: Update user API key Update an user API key ## PATCH /user-api-keys/{api_key_id} **Summary:** Update user API key **Description:** Update an user API key **Parameters:** - `api_key_id` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Complete CLI authentication URL: /api/server/cli-authentication/auth/cli/complete Source: /vercel/path0/docs/content/api/server/cli-authentication/auth/cli/complete.mdx # API Documentation: Complete CLI authentication Inspect, claim, or complete a CLI authentication session ## POST /auth/cli/complete **Summary:** Complete CLI authentication **Description:** Inspect, claim, or complete a CLI authentication session **Request Body:** Request body required **Responses:** - 200: Successful response # Poll CLI authentication status URL: /api/server/cli-authentication/auth/cli/poll Source: /vercel/path0/docs/content/api/server/cli-authentication/auth/cli/poll.mdx # API Documentation: Poll CLI authentication status Check the status of a CLI authentication session using the polling code ## POST /auth/cli/poll **Summary:** Poll CLI authentication status **Description:** Check the status of a CLI authentication session using the polling code **Request Body:** Request body required **Responses:** - 200: Successful response - 201: Successful response # Check email verification code URL: /api/server/contact-channels/contact-channels/verify/check-code Source: /vercel/path0/docs/content/api/server/contact-channels/contact-channels/verify/check-code.mdx # API Documentation: Check email verification code Check if an email verification code is valid without using it ## POST /contact-channels/verify/check-code **Summary:** Check email verification code **Description:** Check if an email verification code is valid without using it **Request Body:** Request body required **Responses:** - 200: Successful response # List notification preferences URL: /api/server/emails/emails/notification-preference/user_id Source: /vercel/path0/docs/content/api/server/emails/emails/notification-preference/user_id.mdx # API Documentation: List notification preferences Get all notification preferences for a user, showing which notification categories are enabled or disabled. ## GET /emails/notification-preference/{user_id} **Summary:** List notification preferences **Description:** Get all notification preferences for a user, showing which notification categories are enabled or disabled. **Parameters:** - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # OAuth token endpoints URL: /api/server/oauth/auth/oauth/token Source: /vercel/path0/docs/content/api/server/oauth/auth/oauth/token.mdx # API Documentation: OAuth token endpoints This endpoint is used to exchange an authorization code or refresh token for an access token. ## POST /auth/oauth/token **Summary:** OAuth token endpoints **Description:** This endpoint is used to exchange an authorization code or refresh token for an access token. **Request Body:** Request body required **Responses:** - 200: Successful response # List AI conversations URL: /api/server/others/internal/ai-conversations/get Source: /vercel/path0/docs/content/api/server/others/internal/ai-conversations/get.mdx # API Documentation: List AI conversations List AI conversations for the current user filtered by project ## GET /internal/ai-conversations **Summary:** List AI conversations **Description:** List AI conversations for the current user filtered by project **Parameters:** - `projectId` (query): No description **Responses:** - 200: Successful response # Create AI conversation URL: /api/server/others/internal/ai-conversations/post Source: /vercel/path0/docs/content/api/server/others/internal/ai-conversations/post.mdx # API Documentation: Create AI conversation Create a new AI conversation with optional initial messages ## POST /internal/ai-conversations **Summary:** Create AI conversation **Description:** Create a new AI conversation with optional initial messages **Request Body:** Request body required **Responses:** - 200: Successful response # List conversations URL: /api/server/others/internal/conversations/get Source: /vercel/path0/docs/content/api/server/others/internal/conversations/get.mdx # API Documentation: List conversations List conversations for a managed project ## GET /internal/conversations **Summary:** List conversations **Description:** List conversations for a managed project **Parameters:** - `projectId` (query): The unique identifier of the project - `query` (query): No description - `status` (query): No description - `userId` (query): The unique identifier of the user - `limit` (query): No description - `offset` (query): No description **Responses:** - 200: Successful response # Create conversation URL: /api/server/others/internal/conversations/post Source: /vercel/path0/docs/content/api/server/others/internal/conversations/post.mdx # API Documentation: Create conversation Create a managed project conversation for a user ## POST /internal/conversations **Summary:** Create conversation **Description:** Create a managed project conversation for a user **Request Body:** Request body required **Responses:** - 200: Successful response # MFA sign in URL: /api/server/otp/auth/mfa/sign-in Source: /vercel/path0/docs/content/api/server/otp/auth/mfa/sign-in.mdx # API Documentation: MFA sign in Complete multi-factor authorization to sign in, with a TOTP and an MFA attempt code ## POST /auth/mfa/sign-in **Summary:** MFA sign in **Description:** Complete multi-factor authorization to sign in, with a TOTP and an MFA attempt code **Request Body:** Request body required **Responses:** - 200: Successful response # Send sign-in code URL: /api/server/otp/auth/otp/send-sign-in-code Source: /vercel/path0/docs/content/api/server/otp/auth/otp/send-sign-in-code.mdx # API Documentation: Send sign-in code Send a code to the user's email address for sign-in. ## POST /auth/otp/send-sign-in-code **Summary:** Send sign-in code **Description:** Send a code to the user's email address for sign-in. **Request Body:** Request body required **Responses:** - 200: Successful response # Sign in with a code URL: /api/server/otp/auth/otp/sign-in Source: /vercel/path0/docs/content/api/server/otp/auth/otp/sign-in.mdx # API Documentation: Sign in with a code ## POST /auth/otp/sign-in **Summary:** Sign in with a code **Request Body:** Request body required **Responses:** - 200: Successful response # Reset password with a code URL: /api/server/password/auth/password/reset Source: /vercel/path0/docs/content/api/server/password/auth/password/reset.mdx # API Documentation: Reset password with a code Reset password with a code ## POST /auth/password/reset **Summary:** Reset password with a code **Description:** Reset password with a code **Request Body:** Request body required **Responses:** - 200: Successful response # Send reset password code URL: /api/server/password/auth/password/send-reset-code Source: /vercel/path0/docs/content/api/server/password/auth/password/send-reset-code.mdx # API Documentation: Send reset password code Send a code to the user's email address for resetting the password. ## POST /auth/password/send-reset-code **Summary:** Send reset password code **Description:** Send a code to the user's email address for resetting the password. **Request Body:** Request body required **Responses:** - 200: Successful response # Set password URL: /api/server/password/auth/password/set Source: /vercel/path0/docs/content/api/server/password/auth/password/set.mdx # API Documentation: Set password Set a new password for the current user ## POST /auth/password/set **Summary:** Set password **Description:** Set a new password for the current user **Request Body:** Request body required **Responses:** - 200: Successful response # Sign in with email and password URL: /api/server/password/auth/password/sign-in Source: /vercel/path0/docs/content/api/server/password/auth/password/sign-in.mdx # API Documentation: Sign in with email and password Sign in to an account with email and password ## POST /auth/password/sign-in **Summary:** Sign in with email and password **Description:** Sign in to an account with email and password **Request Body:** Request body required **Responses:** - 200: Successful response # Sign up with email and password URL: /api/server/password/auth/password/sign-up Source: /vercel/path0/docs/content/api/server/password/auth/password/sign-up.mdx # API Documentation: Sign up with email and password Create a new account with email and password ## POST /auth/password/sign-up **Summary:** Sign up with email and password **Description:** Create a new account with email and password **Request Body:** Request body required **Responses:** - 200: Successful response # Update password URL: /api/server/password/auth/password/update Source: /vercel/path0/docs/content/api/server/password/auth/password/update.mdx # API Documentation: Update password Update the password of the current user, requires the old password ## POST /auth/password/update **Summary:** Update password **Description:** Update the password of the current user, requires the old password **Parameters:** - `x-stack-refresh-token` (header): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Create Purchase URL URL: /api/server/payments/payments/purchases/create-purchase-url Source: /vercel/path0/docs/content/api/server/payments/payments/purchases/create-purchase-url.mdx # API Documentation: Create Purchase URL Creates a secure checkout URL for purchasing a product. ## POST /payments/purchases/create-purchase-url **Summary:** Create Purchase URL **Description:** Creates a secure checkout URL for purchasing a product. **Request Body:** Request body required **Responses:** - 200: Successful response # Create Purchase Session URL: /api/server/payments/payments/purchases/purchase-session Source: /vercel/path0/docs/content/api/server/payments/payments/purchases/purchase-session.mdx # API Documentation: Create Purchase Session Creates a purchase session for completing a purchase. ## POST /payments/purchases/purchase-session **Summary:** Create Purchase Session **Description:** Creates a purchase session for completing a purchase. **Request Body:** Request body required **Responses:** - 200: Successful response # Validate Purchase Code URL: /api/server/payments/payments/purchases/validate-code Source: /vercel/path0/docs/content/api/server/payments/payments/purchases/validate-code.mdx # API Documentation: Validate Purchase Code Validates a purchase verification code and returns purchase details including available prices. ## POST /payments/purchases/validate-code **Summary:** Validate Purchase Code **Description:** Validates a purchase verification code and returns purchase details including available prices. **Request Body:** Request body required **Responses:** - 200: Successful response # Sign out of the current session URL: /api/server/sessions/auth/sessions/current Source: /vercel/path0/docs/content/api/server/sessions/auth/sessions/current.mdx # API Documentation: Sign out of the current session Sign out of the current session and invalidate the refresh token ## DELETE /auth/sessions/current **Summary:** Sign out of the current session **Description:** Sign out of the current session and invalidate the refresh token **Responses:** - 200: Successful response # List sessions URL: /api/server/sessions/auth/sessions/get Source: /vercel/path0/docs/content/api/server/sessions/auth/sessions/get.mdx # API Documentation: List sessions List all sessions for the current user. ## GET /auth/sessions **Summary:** List sessions **Description:** List all sessions for the current user. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Delete session URL: /api/server/sessions/auth/sessions/id Source: /vercel/path0/docs/content/api/server/sessions/auth/sessions/id.mdx # API Documentation: Delete session Delete a session by ID. ## DELETE /auth/sessions/{id} **Summary:** Delete session **Description:** Delete a session by ID. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `id` (path): No description **Responses:** - 200: Successful response # Create session URL: /api/server/sessions/auth/sessions/post Source: /vercel/path0/docs/content/api/server/sessions/auth/sessions/post.mdx # API Documentation: Create session Create a new session for a given user. This will return a refresh token that can be used to impersonate the user. ## POST /auth/sessions **Summary:** Create session **Description:** Create a new session for a given user. This will return a refresh token that can be used to impersonate the user. **Request Body:** Request body required **Responses:** - 200: Successful response # Check if a team invitation code is valid URL: /api/server/teams/team-invitations/accept/check-code Source: /vercel/path0/docs/content/api/server/teams/team-invitations/accept/check-code.mdx # API Documentation: Check if a team invitation code is valid Check if a team invitation code is valid without using it ## POST /team-invitations/accept/check-code **Summary:** Check if a team invitation code is valid **Description:** Check if a team invitation code is valid without using it **Request Body:** Request body required **Responses:** - 200: Successful response # Get team invitation details URL: /api/server/teams/team-invitations/accept/details Source: /vercel/path0/docs/content/api/server/teams/team-invitations/accept/details.mdx # API Documentation: Get team invitation details Get additional information about a team invitation code ## POST /team-invitations/accept/details **Summary:** Get team invitation details **Description:** Get additional information about a team invitation code **Request Body:** Request body required **Responses:** - 200: Successful response # Accept a team invitation by ID URL: /api/server/teams/team-invitations/id/accept Source: /vercel/path0/docs/content/api/server/teams/team-invitations/id/accept.mdx # API Documentation: Accept a team invitation by ID Accepts a team invitation for the specified user. The user must have a verified email matching the invitation's recipient email. This marks the invitation as used and adds the user to the team. ## POST /team-invitations/{id}/accept **Summary:** Accept a team invitation by ID **Description:** Accepts a team invitation for the specified user. The user must have a verified email matching the invitation's recipient email. This marks the invitation as used and adds the user to the team. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `id` (path): No description **Responses:** - 200: Successful response # Delete a team URL: /api/server/teams/teams/team_id/delete Source: /vercel/path0/docs/content/api/server/teams/teams/team_id/delete.mdx # API Documentation: Delete a team Delete a team by ID. ## DELETE /teams/{team_id} **Summary:** Delete a team **Description:** Delete a team by ID. **Parameters:** - `team_id` (path): No description **Responses:** - 200: Successful response # Get a team URL: /api/server/teams/teams/team_id/get Source: /vercel/path0/docs/content/api/server/teams/teams/team_id/get.mdx # API Documentation: Get a team Get a team by ID. ## GET /teams/{team_id} **Summary:** Get a team **Description:** Get a team by ID. **Parameters:** - `team_id` (path): No description **Responses:** - 200: Successful response # Update a team URL: /api/server/teams/teams/team_id/patch Source: /vercel/path0/docs/content/api/server/teams/teams/team_id/patch.mdx # API Documentation: Update a team Update the team information by ID. ## PATCH /teams/{team_id} **Summary:** Update a team **Description:** Update the team information by ID. **Parameters:** - `team_id` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Delete current user URL: /api/server/users/users/me/delete Source: /vercel/path0/docs/content/api/server/users/users/me/delete.mdx # API Documentation: Delete current user Deletes the currently authenticated user. Use this with caution. ## DELETE /users/me **Summary:** Delete current user **Description:** Deletes the currently authenticated user. Use this with caution. **Responses:** - 200: Successful response # Get current user URL: /api/server/users/users/me/get Source: /vercel/path0/docs/content/api/server/users/users/me/get.mdx # API Documentation: Get current user Gets the currently authenticated user. ## GET /users/me **Summary:** Get current user **Description:** Gets the currently authenticated user. **Responses:** - 200: Successful response # Update current user URL: /api/server/users/users/me/patch Source: /vercel/path0/docs/content/api/server/users/users/me/patch.mdx # API Documentation: Update current user Updates the currently authenticated user. Only the values provided will be updated. ## PATCH /users/me **Summary:** Update current user **Description:** Updates the currently authenticated user. Only the values provided will be updated. **Request Body:** Request body required **Responses:** - 200: Successful response # Delete user URL: /api/server/users/users/user_id/delete Source: /vercel/path0/docs/content/api/server/users/users/user_id/delete.mdx # API Documentation: Delete user Deletes a user. Use this with caution. ## DELETE /users/{user_id} **Summary:** Delete user **Description:** Deletes a user. Use this with caution. **Parameters:** - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Get user URL: /api/server/users/users/user_id/get Source: /vercel/path0/docs/content/api/server/users/users/user_id/get.mdx # API Documentation: Get user Gets a user by user ID. ## GET /users/{user_id} **Summary:** Get user **Description:** Gets a user by user ID. **Parameters:** - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Update user URL: /api/server/users/users/user_id/patch Source: /vercel/path0/docs/content/api/server/users/users/user_id/patch.mdx # API Documentation: Update user Updates a user. Only the values provided will be updated. ## PATCH /users/{user_id} **Summary:** Update user **Description:** Updates a user. Only the values provided will be updated. **Parameters:** - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Request Body:** Request body required **Responses:** - 200: Successful response # Delete a contact channel URL: /api/admin/contact-channels/contact-channels/user_id/contact_channel_id/delete Source: /vercel/path0/docs/content/api/admin/contact-channels/contact-channels/user_id/contact_channel_id/delete.mdx # API Documentation: Delete a contact channel Removes a contact channel for a given user. ## DELETE /contact-channels/{user_id}/{contact_channel_id} **Summary:** Delete a contact channel **Description:** Removes a contact channel for a given user. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `contact_channel_id` (query): No description - `user_id` (path): the user that the contact channel belongs to - `contact_channel_id` (path): the target contact channel **Responses:** - 200: Successful response # Get a contact channel URL: /api/admin/contact-channels/contact-channels/user_id/contact_channel_id/get Source: /vercel/path0/docs/content/api/admin/contact-channels/contact-channels/user_id/contact_channel_id/get.mdx # API Documentation: Get a contact channel Retrieves a specific contact channel by the user ID and the contact channel ID. ## GET /contact-channels/{user_id}/{contact_channel_id} **Summary:** Get a contact channel **Description:** Retrieves a specific contact channel by the user ID and the contact channel ID. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `contact_channel_id` (query): No description - `user_id` (path): the user that the contact channel belongs to - `contact_channel_id` (path): the target contact channel **Responses:** - 200: Successful response # Update a contact channel URL: /api/admin/contact-channels/contact-channels/user_id/contact_channel_id/patch Source: /vercel/path0/docs/content/api/admin/contact-channels/contact-channels/user_id/contact_channel_id/patch.mdx # API Documentation: Update a contact channel Updates an existing contact channel. Only the values provided will be updated. ## PATCH /contact-channels/{user_id}/{contact_channel_id} **Summary:** Update a contact channel **Description:** Updates an existing contact channel. Only the values provided will be updated. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `contact_channel_id` (query): No description - `user_id` (path): the user that the contact channel belongs to - `contact_channel_id` (path): the target contact channel **Request Body:** Request body required **Responses:** - 200: Successful response # Send contact channel verification code URL: /api/admin/contact-channels/contact-channels/user_id/contact_channel_id/send-verification-code Source: /vercel/path0/docs/content/api/admin/contact-channels/contact-channels/user_id/contact_channel_id/send-verification-code.mdx # API Documentation: Send contact channel verification code Send a code to the user's contact channel for verifying the contact channel. ## POST /contact-channels/{user_id}/{contact_channel_id}/send-verification-code **Summary:** Send contact channel verification code **Description:** Send a code to the user's contact channel for verifying the contact channel. **Parameters:** - `user_id` (path): The user to send the verification code to. - `contact_channel_id` (path): The contact channel to send the verification code to. **Request Body:** Request body required **Responses:** - 200: Successful response # Update notification preference URL: /api/admin/emails/emails/notification-preference/user_id/notification_category_id Source: /vercel/path0/docs/content/api/admin/emails/emails/notification-preference/user_id/notification_category_id.mdx # API Documentation: Update notification preference Enable or disable a specific notification category for a user. ## PATCH /emails/notification-preference/{user_id}/{notification_category_id} **Summary:** Update notification preference **Description:** Enable or disable a specific notification category for a user. **Parameters:** - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user - `notification_category_id` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Get email outbox entry URL: /api/admin/emails/emails/outbox/id/get Source: /vercel/path0/docs/content/api/admin/emails/emails/outbox/id/get.mdx # API Documentation: Get email outbox entry Gets a single email from the outbox by ID. ## GET /emails/outbox/{id} **Summary:** Get email outbox entry **Description:** Gets a single email from the outbox by ID. **Parameters:** - `status` (query): No description - `simple_status` (query): No description - `id` (path): No description **Responses:** - 200: Successful response # Update email outbox entry URL: /api/admin/emails/emails/outbox/id/patch Source: /vercel/path0/docs/content/api/admin/emails/emails/outbox/id/patch.mdx # API Documentation: Update email outbox entry Updates an email in the outbox. Can be used to edit email content, pause/resume, or cancel emails. Only emails in editable states (`paused`, `preparing`, `rendering`, `render-error`, `scheduled`, `queued`, `server-error`) can be modified. ## PATCH /emails/outbox/{id} **Summary:** Update email outbox entry **Description:** Updates an email in the outbox. Can be used to edit email content, pause/resume, or cancel emails. Only emails in editable states (`paused`, `preparing`, `rendering`, `render-error`, `scheduled`, `queued`, `server-error`) can be modified. **Parameters:** - `status` (query): No description - `simple_status` (query): No description - `id` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # OAuth authorize endpoint URL: /api/admin/oauth/auth/oauth/authorize/provider_id Source: /vercel/path0/docs/content/api/admin/oauth/auth/oauth/authorize/provider_id.mdx # API Documentation: OAuth authorize endpoint This endpoint is used to initiate the OAuth authorization flow. there are two purposes for this endpoint: 1. Authenticate a user with an OAuth provider. 2. Link an existing user with an OAuth provider. ## GET /auth/oauth/authorize/{provider_id} **Summary:** OAuth authorize endpoint **Description:** This endpoint is used to initiate the OAuth authorization flow. there are two purposes for this endpoint: 1. Authenticate a user with an OAuth provider. 2. Link an existing user with an OAuth provider. **Parameters:** - `type` (query): No description - `token` (query): No description - `provider_scope` (query): No description - `error_redirect_uri` (query): No description - `after_callback_redirect_url` (query): No description - `stack_response_mode` (query): Response mode for the OAuth authorize endpoint. Defaults to 'redirect' if not provided. - `hexclave_response_mode` (query): Response mode for the OAuth authorize endpoint. Defaults to 'redirect' if not provided. - `bot_challenge_token` (query): No description - `bot_challenge_phase` (query): No description - `bot_challenge_unavailable` (query): No description - `client_id` (query): No description - `client_secret` (query): No description - `redirect_uri` (query): No description - `scope` (query): No description - `state` (query): No description - `grant_type` (query): No description - `code_challenge` (query): No description - `code_challenge_method` (query): No description - `response_type` (query): No description - `provider_id` (path): No description **Responses:** - 200: Successful response - 307: Successful response # Create cross-domain auth handoff redirect URL: /api/admin/oauth/auth/oauth/cross-domain/authorize Source: /vercel/path0/docs/content/api/admin/oauth/auth/oauth/cross-domain/authorize.mdx # API Documentation: Create cross-domain auth handoff redirect Creates a one-time OAuth authorization code redirect for cross-domain sign-in handoff using PKCE. ## POST /auth/oauth/cross-domain/authorize **Summary:** Create cross-domain auth handoff redirect **Description:** Creates a one-time OAuth authorization code redirect for cross-domain sign-in handoff using PKCE. **Parameters:** - `x-stack-publishable-client-key` (header): No description - `x-stack-refresh-token` (header): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Delete an OAuth provider URL: /api/admin/oauth/oauth-providers/user_id/provider_id/delete Source: /vercel/path0/docs/content/api/admin/oauth/oauth-providers/user_id/provider_id/delete.mdx # API Documentation: Delete an OAuth provider Removes an OAuth provider for a given user. ## DELETE /oauth-providers/{user_id}/{provider_id} **Summary:** Delete an OAuth provider **Description:** Removes an OAuth provider for a given user. **Parameters:** - `provider_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Get an OAuth provider URL: /api/admin/oauth/oauth-providers/user_id/provider_id/get Source: /vercel/path0/docs/content/api/admin/oauth/oauth-providers/user_id/provider_id/get.mdx # API Documentation: Get an OAuth provider Retrieves a specific OAuth provider by the user ID and the OAuth provider ID. ## GET /oauth-providers/{user_id}/{provider_id} **Summary:** Get an OAuth provider **Description:** Retrieves a specific OAuth provider by the user ID and the OAuth provider ID. **Parameters:** - `provider_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Update an OAuth provider URL: /api/admin/oauth/oauth-providers/user_id/provider_id/patch Source: /vercel/path0/docs/content/api/admin/oauth/oauth-providers/user_id/provider_id/patch.mdx # API Documentation: Update an OAuth provider Updates an existing OAuth provider. Only the values provided will be updated. ## PATCH /oauth-providers/{user_id}/{provider_id} **Summary:** Update an OAuth provider **Description:** Updates an existing OAuth provider. Only the values provided will be updated. **Parameters:** - `provider_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Request Body:** Request body required **Responses:** - 200: Successful response # Delete AI conversation URL: /api/admin/others/internal/ai-conversations/conversationid/delete Source: /vercel/path0/docs/content/api/admin/others/internal/ai-conversations/conversationid/delete.mdx # API Documentation: Delete AI conversation Delete an AI conversation and all its messages ## DELETE /internal/ai-conversations/{conversationId} **Summary:** Delete AI conversation **Description:** Delete an AI conversation and all its messages **Parameters:** - `conversationId` (path): No description **Responses:** - 200: Successful response # Get AI conversation URL: /api/admin/others/internal/ai-conversations/conversationid/get Source: /vercel/path0/docs/content/api/admin/others/internal/ai-conversations/conversationid/get.mdx # API Documentation: Get AI conversation Fetch a single AI conversation with all its messages ## GET /internal/ai-conversations/{conversationId} **Summary:** Get AI conversation **Description:** Fetch a single AI conversation with all its messages **Parameters:** - `conversationId` (path): No description **Responses:** - 200: Successful response # Replace conversation messages URL: /api/admin/others/internal/ai-conversations/conversationid/messages Source: /vercel/path0/docs/content/api/admin/others/internal/ai-conversations/conversationid/messages.mdx # API Documentation: Replace conversation messages Replace all messages in a conversation ## PUT /internal/ai-conversations/{conversationId}/messages **Summary:** Replace conversation messages **Description:** Replace all messages in a conversation **Parameters:** - `conversationId` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Update AI conversation URL: /api/admin/others/internal/ai-conversations/conversationid/patch Source: /vercel/path0/docs/content/api/admin/others/internal/ai-conversations/conversationid/patch.mdx # API Documentation: Update AI conversation Update the title of an AI conversation ## PATCH /internal/ai-conversations/{conversationId} **Summary:** Update AI conversation **Description:** Update the title of an AI conversation **Parameters:** - `conversationId` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Get conversation detail URL: /api/admin/others/internal/conversations/conversationid/get Source: /vercel/path0/docs/content/api/admin/others/internal/conversations/conversationid/get.mdx # API Documentation: Get conversation detail Get conversation detail for a managed project ## GET /internal/conversations/{conversationId} **Summary:** Get conversation detail **Description:** Get conversation detail for a managed project **Parameters:** - `projectId` (query): The unique identifier of the project - `conversationId` (path): No description **Responses:** - 200: Successful response # Update conversation URL: /api/admin/others/internal/conversations/conversationid/patch Source: /vercel/path0/docs/content/api/admin/others/internal/conversations/conversationid/patch.mdx # API Documentation: Update conversation Append a message or update conversation attributes on a managed project conversation ## PATCH /internal/conversations/{conversationId} **Summary:** Update conversation **Description:** Append a message or update conversation attributes on a managed project conversation **Parameters:** - `conversationId` (path): No description **Responses:** - 200: Successful response # Check sign in code URL: /api/admin/otp/auth/otp/sign-in/check-code Source: /vercel/path0/docs/content/api/admin/otp/auth/otp/sign-in/check-code.mdx # API Documentation: Check sign in code Check if a sign in code is valid without using it ## POST /auth/otp/sign-in/check-code **Summary:** Check sign in code **Description:** Check if a sign in code is valid without using it **Request Body:** Request body required **Responses:** - 200: Successful response # Check reset password code URL: /api/admin/password/auth/password/reset/check-code Source: /vercel/path0/docs/content/api/admin/password/auth/password/reset/check-code.mdx # API Documentation: Check reset password code Check if a reset password code is valid without using it ## POST /auth/password/reset/check-code **Summary:** Check reset password code **Description:** Check if a reset password code is valid without using it **Request Body:** Request body required **Responses:** - 200: Successful response # Revoke a global permission from a user URL: /api/admin/permissions/project-permissions/user_id/permission_id/delete Source: /vercel/path0/docs/content/api/admin/permissions/project-permissions/user_id/permission_id/delete.mdx # API Documentation: Revoke a global permission from a user Revoke a global permission from a user ## DELETE /project-permissions/{user_id}/{permission_id} **Summary:** Revoke a global permission from a user **Description:** Revoke a global permission from a user **Parameters:** - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user - `permission_id` (path): The permission ID used to uniquely identify a permission. Can either be a custom permission with lowercase letters, numbers, `:`, and `_` characters, or one of the system permissions: `$update_team`, `$delete_team`, `$read_members`, `$remove_members`, `$invite_members`, `$manage_api_keys` **Responses:** - 200: Successful response # Grant a global permission to a user URL: /api/admin/permissions/project-permissions/user_id/permission_id/post Source: /vercel/path0/docs/content/api/admin/permissions/project-permissions/user_id/permission_id/post.mdx # API Documentation: Grant a global permission to a user Grant a global permission to a user (the permission must be created first on the Stack dashboard) ## POST /project-permissions/{user_id}/{permission_id} **Summary:** Grant a global permission to a user **Description:** Grant a global permission to a user (the permission must be created first on the Stack dashboard) **Parameters:** - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user - `permission_id` (path): The permission ID used to uniquely identify a permission. Can either be a custom permission with lowercase letters, numbers, `:`, and `_` characters, or one of the system permissions: `$update_team`, `$delete_team`, `$read_members`, `$remove_members`, `$invite_members`, `$manage_api_keys` **Request Body:** Request body required **Responses:** - 201: Successful response # Refresh access token URL: /api/admin/sessions/auth/sessions/current/refresh Source: /vercel/path0/docs/content/api/admin/sessions/auth/sessions/current/refresh.mdx # API Documentation: Refresh access token Get a new access token using a refresh token ## POST /auth/sessions/current/refresh **Summary:** Refresh access token **Description:** Get a new access token using a refresh token **Parameters:** - `x-stack-refresh-token` (header): No description **Responses:** - 200: Successful response # Get a team member profile URL: /api/admin/teams/team-member-profiles/team_id/user_id/get Source: /vercel/path0/docs/content/api/admin/teams/team-member-profiles/team_id/user_id/get.mdx # API Documentation: Get a team member profile Get a team member profile by user ID ## GET /team-member-profiles/{team_id}/{user_id} **Summary:** Get a team member profile **Description:** Get a team member profile by user ID **Parameters:** - `team_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Update a team member profile URL: /api/admin/teams/team-member-profiles/team_id/user_id/patch Source: /vercel/path0/docs/content/api/admin/teams/team-member-profiles/team_id/user_id/patch.mdx # API Documentation: Update a team member profile Update a team member profile by user ID ## PATCH /team-member-profiles/{team_id}/{user_id} **Summary:** Update a team member profile **Description:** Update a team member profile by user ID **Parameters:** - `team_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Request Body:** Request body required **Responses:** - 200: Successful response # Remove a user from a team URL: /api/admin/teams/team-memberships/team_id/user_id/delete Source: /vercel/path0/docs/content/api/admin/teams/team-memberships/team_id/user_id/delete.mdx # API Documentation: Remove a user from a team ## DELETE /team-memberships/{team_id}/{user_id} **Summary:** Remove a user from a team **Parameters:** - `team_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Add a user to a team URL: /api/admin/teams/team-memberships/team_id/user_id/post Source: /vercel/path0/docs/content/api/admin/teams/team-memberships/team_id/user_id/post.mdx # API Documentation: Add a user to a team ## POST /team-memberships/{team_id}/{user_id} **Summary:** Add a user to a team **Parameters:** - `team_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Request Body:** Request body required **Responses:** - 201: Successful response # Delete a contact channel URL: /api/client/contact-channels/contact-channels/user_id/contact_channel_id/delete Source: /vercel/path0/docs/content/api/client/contact-channels/contact-channels/user_id/contact_channel_id/delete.mdx # API Documentation: Delete a contact channel Removes a contact channel for a given user. ## DELETE /contact-channels/{user_id}/{contact_channel_id} **Summary:** Delete a contact channel **Description:** Removes a contact channel for a given user. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `contact_channel_id` (query): No description - `user_id` (path): the user that the contact channel belongs to - `contact_channel_id` (path): the target contact channel **Responses:** - 200: Successful response # Get a contact channel URL: /api/client/contact-channels/contact-channels/user_id/contact_channel_id/get Source: /vercel/path0/docs/content/api/client/contact-channels/contact-channels/user_id/contact_channel_id/get.mdx # API Documentation: Get a contact channel Retrieves a specific contact channel by the user ID and the contact channel ID. ## GET /contact-channels/{user_id}/{contact_channel_id} **Summary:** Get a contact channel **Description:** Retrieves a specific contact channel by the user ID and the contact channel ID. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `contact_channel_id` (query): No description - `user_id` (path): the user that the contact channel belongs to - `contact_channel_id` (path): the target contact channel **Responses:** - 200: Successful response # Update a contact channel URL: /api/client/contact-channels/contact-channels/user_id/contact_channel_id/patch Source: /vercel/path0/docs/content/api/client/contact-channels/contact-channels/user_id/contact_channel_id/patch.mdx # API Documentation: Update a contact channel Updates an existing contact channel. Only the values provided will be updated. ## PATCH /contact-channels/{user_id}/{contact_channel_id} **Summary:** Update a contact channel **Description:** Updates an existing contact channel. Only the values provided will be updated. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `contact_channel_id` (query): No description - `user_id` (path): the user that the contact channel belongs to - `contact_channel_id` (path): the target contact channel **Request Body:** Request body required **Responses:** - 200: Successful response # Send contact channel verification code URL: /api/client/contact-channels/contact-channels/user_id/contact_channel_id/send-verification-code Source: /vercel/path0/docs/content/api/client/contact-channels/contact-channels/user_id/contact_channel_id/send-verification-code.mdx # API Documentation: Send contact channel verification code Send a code to the user's contact channel for verifying the contact channel. ## POST /contact-channels/{user_id}/{contact_channel_id}/send-verification-code **Summary:** Send contact channel verification code **Description:** Send a code to the user's contact channel for verifying the contact channel. **Parameters:** - `user_id` (path): The user to send the verification code to. - `contact_channel_id` (path): The contact channel to send the verification code to. **Request Body:** Request body required **Responses:** - 200: Successful response # Update notification preference URL: /api/client/emails/emails/notification-preference/user_id/notification_category_id Source: /vercel/path0/docs/content/api/client/emails/emails/notification-preference/user_id/notification_category_id.mdx # API Documentation: Update notification preference Enable or disable a specific notification category for a user. ## PATCH /emails/notification-preference/{user_id}/{notification_category_id} **Summary:** Update notification preference **Description:** Enable or disable a specific notification category for a user. **Parameters:** - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user - `notification_category_id` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # OAuth authorize endpoint URL: /api/client/oauth/auth/oauth/authorize/provider_id Source: /vercel/path0/docs/content/api/client/oauth/auth/oauth/authorize/provider_id.mdx # API Documentation: OAuth authorize endpoint This endpoint is used to initiate the OAuth authorization flow. there are two purposes for this endpoint: 1. Authenticate a user with an OAuth provider. 2. Link an existing user with an OAuth provider. ## GET /auth/oauth/authorize/{provider_id} **Summary:** OAuth authorize endpoint **Description:** This endpoint is used to initiate the OAuth authorization flow. there are two purposes for this endpoint: 1. Authenticate a user with an OAuth provider. 2. Link an existing user with an OAuth provider. **Parameters:** - `type` (query): No description - `token` (query): No description - `provider_scope` (query): No description - `error_redirect_uri` (query): No description - `after_callback_redirect_url` (query): No description - `stack_response_mode` (query): Response mode for the OAuth authorize endpoint. Defaults to 'redirect' if not provided. - `hexclave_response_mode` (query): Response mode for the OAuth authorize endpoint. Defaults to 'redirect' if not provided. - `bot_challenge_token` (query): No description - `bot_challenge_phase` (query): No description - `bot_challenge_unavailable` (query): No description - `client_id` (query): No description - `client_secret` (query): No description - `redirect_uri` (query): No description - `scope` (query): No description - `state` (query): No description - `grant_type` (query): No description - `code_challenge` (query): No description - `code_challenge_method` (query): No description - `response_type` (query): No description - `provider_id` (path): No description **Responses:** - 200: Successful response - 307: Successful response # Create cross-domain auth handoff redirect URL: /api/client/oauth/auth/oauth/cross-domain/authorize Source: /vercel/path0/docs/content/api/client/oauth/auth/oauth/cross-domain/authorize.mdx # API Documentation: Create cross-domain auth handoff redirect Creates a one-time OAuth authorization code redirect for cross-domain sign-in handoff using PKCE. ## POST /auth/oauth/cross-domain/authorize **Summary:** Create cross-domain auth handoff redirect **Description:** Creates a one-time OAuth authorization code redirect for cross-domain sign-in handoff using PKCE. **Parameters:** - `x-stack-publishable-client-key` (header): No description - `x-stack-refresh-token` (header): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Delete an OAuth provider URL: /api/client/oauth/oauth-providers/user_id/provider_id/delete Source: /vercel/path0/docs/content/api/client/oauth/oauth-providers/user_id/provider_id/delete.mdx # API Documentation: Delete an OAuth provider Removes an OAuth provider for a given user. ## DELETE /oauth-providers/{user_id}/{provider_id} **Summary:** Delete an OAuth provider **Description:** Removes an OAuth provider for a given user. **Parameters:** - `provider_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Get an OAuth provider URL: /api/client/oauth/oauth-providers/user_id/provider_id/get Source: /vercel/path0/docs/content/api/client/oauth/oauth-providers/user_id/provider_id/get.mdx # API Documentation: Get an OAuth provider Retrieves a specific OAuth provider by the user ID and the OAuth provider ID. ## GET /oauth-providers/{user_id}/{provider_id} **Summary:** Get an OAuth provider **Description:** Retrieves a specific OAuth provider by the user ID and the OAuth provider ID. **Parameters:** - `provider_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Update an OAuth provider URL: /api/client/oauth/oauth-providers/user_id/provider_id/patch Source: /vercel/path0/docs/content/api/client/oauth/oauth-providers/user_id/provider_id/patch.mdx # API Documentation: Update an OAuth provider Updates an existing OAuth provider for a user. ## PATCH /oauth-providers/{user_id}/{provider_id} **Summary:** Update an OAuth provider **Description:** Updates an existing OAuth provider for a user. **Parameters:** - `provider_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Request Body:** Request body required **Responses:** - 200: Successful response # Delete AI conversation URL: /api/client/others/internal/ai-conversations/conversationid/delete Source: /vercel/path0/docs/content/api/client/others/internal/ai-conversations/conversationid/delete.mdx # API Documentation: Delete AI conversation Delete an AI conversation and all its messages ## DELETE /internal/ai-conversations/{conversationId} **Summary:** Delete AI conversation **Description:** Delete an AI conversation and all its messages **Parameters:** - `conversationId` (path): No description **Responses:** - 200: Successful response # Get AI conversation URL: /api/client/others/internal/ai-conversations/conversationid/get Source: /vercel/path0/docs/content/api/client/others/internal/ai-conversations/conversationid/get.mdx # API Documentation: Get AI conversation Fetch a single AI conversation with all its messages ## GET /internal/ai-conversations/{conversationId} **Summary:** Get AI conversation **Description:** Fetch a single AI conversation with all its messages **Parameters:** - `conversationId` (path): No description **Responses:** - 200: Successful response # Replace conversation messages URL: /api/client/others/internal/ai-conversations/conversationid/messages Source: /vercel/path0/docs/content/api/client/others/internal/ai-conversations/conversationid/messages.mdx # API Documentation: Replace conversation messages Replace all messages in a conversation ## PUT /internal/ai-conversations/{conversationId}/messages **Summary:** Replace conversation messages **Description:** Replace all messages in a conversation **Parameters:** - `conversationId` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Update AI conversation URL: /api/client/others/internal/ai-conversations/conversationid/patch Source: /vercel/path0/docs/content/api/client/others/internal/ai-conversations/conversationid/patch.mdx # API Documentation: Update AI conversation Update the title of an AI conversation ## PATCH /internal/ai-conversations/{conversationId} **Summary:** Update AI conversation **Description:** Update the title of an AI conversation **Parameters:** - `conversationId` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Get conversation detail URL: /api/client/others/internal/conversations/conversationid/get Source: /vercel/path0/docs/content/api/client/others/internal/conversations/conversationid/get.mdx # API Documentation: Get conversation detail Get conversation detail for a managed project ## GET /internal/conversations/{conversationId} **Summary:** Get conversation detail **Description:** Get conversation detail for a managed project **Parameters:** - `projectId` (query): The unique identifier of the project - `conversationId` (path): No description **Responses:** - 200: Successful response # Update conversation URL: /api/client/others/internal/conversations/conversationid/patch Source: /vercel/path0/docs/content/api/client/others/internal/conversations/conversationid/patch.mdx # API Documentation: Update conversation Append a message or update conversation attributes on a managed project conversation ## PATCH /internal/conversations/{conversationId} **Summary:** Update conversation **Description:** Append a message or update conversation attributes on a managed project conversation **Parameters:** - `conversationId` (path): No description **Responses:** - 200: Successful response # Check sign in code URL: /api/client/otp/auth/otp/sign-in/check-code Source: /vercel/path0/docs/content/api/client/otp/auth/otp/sign-in/check-code.mdx # API Documentation: Check sign in code Check if a sign in code is valid without using it ## POST /auth/otp/sign-in/check-code **Summary:** Check sign in code **Description:** Check if a sign in code is valid without using it **Request Body:** Request body required **Responses:** - 200: Successful response # Check reset password code URL: /api/client/password/auth/password/reset/check-code Source: /vercel/path0/docs/content/api/client/password/auth/password/reset/check-code.mdx # API Documentation: Check reset password code Check if a reset password code is valid without using it ## POST /auth/password/reset/check-code **Summary:** Check reset password code **Description:** Check if a reset password code is valid without using it **Request Body:** Request body required **Responses:** - 200: Successful response # Refresh access token URL: /api/client/sessions/auth/sessions/current/refresh Source: /vercel/path0/docs/content/api/client/sessions/auth/sessions/current/refresh.mdx # API Documentation: Refresh access token Get a new access token using a refresh token ## POST /auth/sessions/current/refresh **Summary:** Refresh access token **Description:** Get a new access token using a refresh token **Parameters:** - `x-stack-refresh-token` (header): No description **Responses:** - 200: Successful response # Get a team member profile URL: /api/client/teams/team-member-profiles/team_id/user_id/get Source: /vercel/path0/docs/content/api/client/teams/team-member-profiles/team_id/user_id/get.mdx # API Documentation: Get a team member profile Get a team member profile. you can always get your own profile by setting `me` as the `user_id` in the path parameters on the client. If you want to get someone else's profile in a team, you need to have the `$read_members` permission in that team. ## GET /team-member-profiles/{team_id}/{user_id} **Summary:** Get a team member profile **Description:** Get a team member profile. you can always get your own profile by setting `me` as the `user_id` in the path parameters on the client. If you want to get someone else's profile in a team, you need to have the `$read_members` permission in that team. **Parameters:** - `team_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Update your team member profile URL: /api/client/teams/team-member-profiles/team_id/user_id/patch Source: /vercel/path0/docs/content/api/client/teams/team-member-profiles/team_id/user_id/patch.mdx # API Documentation: Update your team member profile Update your own team member profile. `user_id` must be `me` in the path parameters on the client. ## PATCH /team-member-profiles/{team_id}/{user_id} **Summary:** Update your team member profile **Description:** Update your own team member profile. `user_id` must be `me` in the path parameters on the client. **Parameters:** - `team_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Request Body:** Request body required **Responses:** - 200: Successful response # Delete a contact channel URL: /api/server/contact-channels/contact-channels/user_id/contact_channel_id/delete Source: /vercel/path0/docs/content/api/server/contact-channels/contact-channels/user_id/contact_channel_id/delete.mdx # API Documentation: Delete a contact channel Removes a contact channel for a given user. ## DELETE /contact-channels/{user_id}/{contact_channel_id} **Summary:** Delete a contact channel **Description:** Removes a contact channel for a given user. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `contact_channel_id` (query): No description - `user_id` (path): the user that the contact channel belongs to - `contact_channel_id` (path): the target contact channel **Responses:** - 200: Successful response # Get a contact channel URL: /api/server/contact-channels/contact-channels/user_id/contact_channel_id/get Source: /vercel/path0/docs/content/api/server/contact-channels/contact-channels/user_id/contact_channel_id/get.mdx # API Documentation: Get a contact channel Retrieves a specific contact channel by the user ID and the contact channel ID. ## GET /contact-channels/{user_id}/{contact_channel_id} **Summary:** Get a contact channel **Description:** Retrieves a specific contact channel by the user ID and the contact channel ID. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `contact_channel_id` (query): No description - `user_id` (path): the user that the contact channel belongs to - `contact_channel_id` (path): the target contact channel **Responses:** - 200: Successful response # Update a contact channel URL: /api/server/contact-channels/contact-channels/user_id/contact_channel_id/patch Source: /vercel/path0/docs/content/api/server/contact-channels/contact-channels/user_id/contact_channel_id/patch.mdx # API Documentation: Update a contact channel Updates an existing contact channel. Only the values provided will be updated. ## PATCH /contact-channels/{user_id}/{contact_channel_id} **Summary:** Update a contact channel **Description:** Updates an existing contact channel. Only the values provided will be updated. **Parameters:** - `user_id` (query): The ID of the user, or the special value `me` for the currently authenticated user - `contact_channel_id` (query): No description - `user_id` (path): the user that the contact channel belongs to - `contact_channel_id` (path): the target contact channel **Request Body:** Request body required **Responses:** - 200: Successful response # Send contact channel verification code URL: /api/server/contact-channels/contact-channels/user_id/contact_channel_id/send-verification-code Source: /vercel/path0/docs/content/api/server/contact-channels/contact-channels/user_id/contact_channel_id/send-verification-code.mdx # API Documentation: Send contact channel verification code Send a code to the user's contact channel for verifying the contact channel. ## POST /contact-channels/{user_id}/{contact_channel_id}/send-verification-code **Summary:** Send contact channel verification code **Description:** Send a code to the user's contact channel for verifying the contact channel. **Parameters:** - `user_id` (path): The user to send the verification code to. - `contact_channel_id` (path): The contact channel to send the verification code to. **Request Body:** Request body required **Responses:** - 200: Successful response # Update notification preference URL: /api/server/emails/emails/notification-preference/user_id/notification_category_id Source: /vercel/path0/docs/content/api/server/emails/emails/notification-preference/user_id/notification_category_id.mdx # API Documentation: Update notification preference Enable or disable a specific notification category for a user. ## PATCH /emails/notification-preference/{user_id}/{notification_category_id} **Summary:** Update notification preference **Description:** Enable or disable a specific notification category for a user. **Parameters:** - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user - `notification_category_id` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Get email outbox entry URL: /api/server/emails/emails/outbox/id/get Source: /vercel/path0/docs/content/api/server/emails/emails/outbox/id/get.mdx # API Documentation: Get email outbox entry Gets a single email from the outbox by ID. ## GET /emails/outbox/{id} **Summary:** Get email outbox entry **Description:** Gets a single email from the outbox by ID. **Parameters:** - `status` (query): No description - `simple_status` (query): No description - `id` (path): No description **Responses:** - 200: Successful response # Update email outbox entry URL: /api/server/emails/emails/outbox/id/patch Source: /vercel/path0/docs/content/api/server/emails/emails/outbox/id/patch.mdx # API Documentation: Update email outbox entry Updates an email in the outbox. Can be used to edit email content, pause/resume, or cancel emails. Only emails in editable states (`paused`, `preparing`, `rendering`, `render-error`, `scheduled`, `queued`, `server-error`) can be modified. ## PATCH /emails/outbox/{id} **Summary:** Update email outbox entry **Description:** Updates an email in the outbox. Can be used to edit email content, pause/resume, or cancel emails. Only emails in editable states (`paused`, `preparing`, `rendering`, `render-error`, `scheduled`, `queued`, `server-error`) can be modified. **Parameters:** - `status` (query): No description - `simple_status` (query): No description - `id` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # OAuth authorize endpoint URL: /api/server/oauth/auth/oauth/authorize/provider_id Source: /vercel/path0/docs/content/api/server/oauth/auth/oauth/authorize/provider_id.mdx # API Documentation: OAuth authorize endpoint This endpoint is used to initiate the OAuth authorization flow. there are two purposes for this endpoint: 1. Authenticate a user with an OAuth provider. 2. Link an existing user with an OAuth provider. ## GET /auth/oauth/authorize/{provider_id} **Summary:** OAuth authorize endpoint **Description:** This endpoint is used to initiate the OAuth authorization flow. there are two purposes for this endpoint: 1. Authenticate a user with an OAuth provider. 2. Link an existing user with an OAuth provider. **Parameters:** - `type` (query): No description - `token` (query): No description - `provider_scope` (query): No description - `error_redirect_uri` (query): No description - `after_callback_redirect_url` (query): No description - `stack_response_mode` (query): Response mode for the OAuth authorize endpoint. Defaults to 'redirect' if not provided. - `hexclave_response_mode` (query): Response mode for the OAuth authorize endpoint. Defaults to 'redirect' if not provided. - `bot_challenge_token` (query): No description - `bot_challenge_phase` (query): No description - `bot_challenge_unavailable` (query): No description - `client_id` (query): No description - `client_secret` (query): No description - `redirect_uri` (query): No description - `scope` (query): No description - `state` (query): No description - `grant_type` (query): No description - `code_challenge` (query): No description - `code_challenge_method` (query): No description - `response_type` (query): No description - `provider_id` (path): No description **Responses:** - 200: Successful response - 307: Successful response # Create cross-domain auth handoff redirect URL: /api/server/oauth/auth/oauth/cross-domain/authorize Source: /vercel/path0/docs/content/api/server/oauth/auth/oauth/cross-domain/authorize.mdx # API Documentation: Create cross-domain auth handoff redirect Creates a one-time OAuth authorization code redirect for cross-domain sign-in handoff using PKCE. ## POST /auth/oauth/cross-domain/authorize **Summary:** Create cross-domain auth handoff redirect **Description:** Creates a one-time OAuth authorization code redirect for cross-domain sign-in handoff using PKCE. **Parameters:** - `x-stack-publishable-client-key` (header): No description - `x-stack-refresh-token` (header): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Delete an OAuth provider URL: /api/server/oauth/oauth-providers/user_id/provider_id/delete Source: /vercel/path0/docs/content/api/server/oauth/oauth-providers/user_id/provider_id/delete.mdx # API Documentation: Delete an OAuth provider Removes an OAuth provider for a given user. ## DELETE /oauth-providers/{user_id}/{provider_id} **Summary:** Delete an OAuth provider **Description:** Removes an OAuth provider for a given user. **Parameters:** - `provider_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Get an OAuth provider URL: /api/server/oauth/oauth-providers/user_id/provider_id/get Source: /vercel/path0/docs/content/api/server/oauth/oauth-providers/user_id/provider_id/get.mdx # API Documentation: Get an OAuth provider Retrieves a specific OAuth provider by the user ID and the OAuth provider ID. ## GET /oauth-providers/{user_id}/{provider_id} **Summary:** Get an OAuth provider **Description:** Retrieves a specific OAuth provider by the user ID and the OAuth provider ID. **Parameters:** - `provider_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Update an OAuth provider URL: /api/server/oauth/oauth-providers/user_id/provider_id/patch Source: /vercel/path0/docs/content/api/server/oauth/oauth-providers/user_id/provider_id/patch.mdx # API Documentation: Update an OAuth provider Updates an existing OAuth provider. Only the values provided will be updated. ## PATCH /oauth-providers/{user_id}/{provider_id} **Summary:** Update an OAuth provider **Description:** Updates an existing OAuth provider. Only the values provided will be updated. **Parameters:** - `provider_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Request Body:** Request body required **Responses:** - 200: Successful response # Delete AI conversation URL: /api/server/others/internal/ai-conversations/conversationid/delete Source: /vercel/path0/docs/content/api/server/others/internal/ai-conversations/conversationid/delete.mdx # API Documentation: Delete AI conversation Delete an AI conversation and all its messages ## DELETE /internal/ai-conversations/{conversationId} **Summary:** Delete AI conversation **Description:** Delete an AI conversation and all its messages **Parameters:** - `conversationId` (path): No description **Responses:** - 200: Successful response # Get AI conversation URL: /api/server/others/internal/ai-conversations/conversationid/get Source: /vercel/path0/docs/content/api/server/others/internal/ai-conversations/conversationid/get.mdx # API Documentation: Get AI conversation Fetch a single AI conversation with all its messages ## GET /internal/ai-conversations/{conversationId} **Summary:** Get AI conversation **Description:** Fetch a single AI conversation with all its messages **Parameters:** - `conversationId` (path): No description **Responses:** - 200: Successful response # Replace conversation messages URL: /api/server/others/internal/ai-conversations/conversationid/messages Source: /vercel/path0/docs/content/api/server/others/internal/ai-conversations/conversationid/messages.mdx # API Documentation: Replace conversation messages Replace all messages in a conversation ## PUT /internal/ai-conversations/{conversationId}/messages **Summary:** Replace conversation messages **Description:** Replace all messages in a conversation **Parameters:** - `conversationId` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Update AI conversation URL: /api/server/others/internal/ai-conversations/conversationid/patch Source: /vercel/path0/docs/content/api/server/others/internal/ai-conversations/conversationid/patch.mdx # API Documentation: Update AI conversation Update the title of an AI conversation ## PATCH /internal/ai-conversations/{conversationId} **Summary:** Update AI conversation **Description:** Update the title of an AI conversation **Parameters:** - `conversationId` (path): No description **Request Body:** Request body required **Responses:** - 200: Successful response # Get conversation detail URL: /api/server/others/internal/conversations/conversationid/get Source: /vercel/path0/docs/content/api/server/others/internal/conversations/conversationid/get.mdx # API Documentation: Get conversation detail Get conversation detail for a managed project ## GET /internal/conversations/{conversationId} **Summary:** Get conversation detail **Description:** Get conversation detail for a managed project **Parameters:** - `projectId` (query): The unique identifier of the project - `conversationId` (path): No description **Responses:** - 200: Successful response # Update conversation URL: /api/server/others/internal/conversations/conversationid/patch Source: /vercel/path0/docs/content/api/server/others/internal/conversations/conversationid/patch.mdx # API Documentation: Update conversation Append a message or update conversation attributes on a managed project conversation ## PATCH /internal/conversations/{conversationId} **Summary:** Update conversation **Description:** Append a message or update conversation attributes on a managed project conversation **Parameters:** - `conversationId` (path): No description **Responses:** - 200: Successful response # Check sign in code URL: /api/server/otp/auth/otp/sign-in/check-code Source: /vercel/path0/docs/content/api/server/otp/auth/otp/sign-in/check-code.mdx # API Documentation: Check sign in code Check if a sign in code is valid without using it ## POST /auth/otp/sign-in/check-code **Summary:** Check sign in code **Description:** Check if a sign in code is valid without using it **Request Body:** Request body required **Responses:** - 200: Successful response # Check reset password code URL: /api/server/password/auth/password/reset/check-code Source: /vercel/path0/docs/content/api/server/password/auth/password/reset/check-code.mdx # API Documentation: Check reset password code Check if a reset password code is valid without using it ## POST /auth/password/reset/check-code **Summary:** Check reset password code **Description:** Check if a reset password code is valid without using it **Request Body:** Request body required **Responses:** - 200: Successful response # Revoke a global permission from a user URL: /api/server/permissions/project-permissions/user_id/permission_id/delete Source: /vercel/path0/docs/content/api/server/permissions/project-permissions/user_id/permission_id/delete.mdx # API Documentation: Revoke a global permission from a user Revoke a global permission from a user ## DELETE /project-permissions/{user_id}/{permission_id} **Summary:** Revoke a global permission from a user **Description:** Revoke a global permission from a user **Parameters:** - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user - `permission_id` (path): The permission ID used to uniquely identify a permission. Can either be a custom permission with lowercase letters, numbers, `:`, and `_` characters, or one of the system permissions: `$update_team`, `$delete_team`, `$read_members`, `$remove_members`, `$invite_members`, `$manage_api_keys` **Responses:** - 200: Successful response # Grant a global permission to a user URL: /api/server/permissions/project-permissions/user_id/permission_id/post Source: /vercel/path0/docs/content/api/server/permissions/project-permissions/user_id/permission_id/post.mdx # API Documentation: Grant a global permission to a user Grant a global permission to a user (the permission must be created first on the Stack dashboard) ## POST /project-permissions/{user_id}/{permission_id} **Summary:** Grant a global permission to a user **Description:** Grant a global permission to a user (the permission must be created first on the Stack dashboard) **Parameters:** - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user - `permission_id` (path): The permission ID used to uniquely identify a permission. Can either be a custom permission with lowercase letters, numbers, `:`, and `_` characters, or one of the system permissions: `$update_team`, `$delete_team`, `$read_members`, `$remove_members`, `$invite_members`, `$manage_api_keys` **Request Body:** Request body required **Responses:** - 201: Successful response # Refresh access token URL: /api/server/sessions/auth/sessions/current/refresh Source: /vercel/path0/docs/content/api/server/sessions/auth/sessions/current/refresh.mdx # API Documentation: Refresh access token Get a new access token using a refresh token ## POST /auth/sessions/current/refresh **Summary:** Refresh access token **Description:** Get a new access token using a refresh token **Parameters:** - `x-stack-refresh-token` (header): No description **Responses:** - 200: Successful response # Remove a user from a team URL: /api/server/teams/team-memberships/team_id/user_id/delete Source: /vercel/path0/docs/content/api/server/teams/team-memberships/team_id/user_id/delete.mdx # API Documentation: Remove a user from a team ## DELETE /team-memberships/{team_id}/{user_id} **Summary:** Remove a user from a team **Parameters:** - `team_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Add a user to a team URL: /api/server/teams/team-memberships/team_id/user_id/post Source: /vercel/path0/docs/content/api/server/teams/team-memberships/team_id/user_id/post.mdx # API Documentation: Add a user to a team ## POST /team-memberships/{team_id}/{user_id} **Summary:** Add a user to a team **Parameters:** - `team_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Request Body:** Request body required **Responses:** - 201: Successful response # Get a team member profile URL: /api/server/teams/team-member-profiles/team_id/user_id/get Source: /vercel/path0/docs/content/api/server/teams/team-member-profiles/team_id/user_id/get.mdx # API Documentation: Get a team member profile Get a team member profile by user ID ## GET /team-member-profiles/{team_id}/{user_id} **Summary:** Get a team member profile **Description:** Get a team member profile by user ID **Parameters:** - `team_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Responses:** - 200: Successful response # Update a team member profile URL: /api/server/teams/team-member-profiles/team_id/user_id/patch Source: /vercel/path0/docs/content/api/server/teams/team-member-profiles/team_id/user_id/patch.mdx # API Documentation: Update a team member profile Update a team member profile by user ID ## PATCH /team-member-profiles/{team_id}/{user_id} **Summary:** Update a team member profile **Description:** Update a team member profile by user ID **Parameters:** - `team_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user **Request Body:** Request body required **Responses:** - 200: Successful response # Get Item URL: /api/admin/payments/payments/items/customer_type/customer_id/item_id Source: /vercel/path0/docs/content/api/admin/payments/payments/items/customer_type/customer_id/item_id.mdx # API Documentation: Get Item Retrieves information about a specific item (credits, quotas, etc.) for a customer. ## GET /payments/items/{customer_type}/{customer_id}/{item_id} **Summary:** Get Item **Description:** Retrieves information about a specific item (credits, quotas, etc.) for a customer. **Parameters:** - `customer_type` (path): The type of customer - `customer_id` (path): The ID of the customer - `item_id` (path): The ID of the item to retrieve **Responses:** - 200: Successful response # Revoke a team permission from a user URL: /api/admin/permissions/team-permissions/team_id/user_id/permission_id/delete Source: /vercel/path0/docs/content/api/admin/permissions/team-permissions/team_id/user_id/permission_id/delete.mdx # API Documentation: Revoke a team permission from a user Revoke a team permission from a user ## DELETE /team-permissions/{team_id}/{user_id}/{permission_id} **Summary:** Revoke a team permission from a user **Description:** Revoke a team permission from a user **Parameters:** - `team_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user - `permission_id` (path): The permission ID used to uniquely identify a permission. Can either be a custom permission with lowercase letters, numbers, `:`, and `_` characters, or one of the system permissions: `$update_team`, `$delete_team`, `$read_members`, `$remove_members`, `$invite_members`, `$manage_api_keys` **Responses:** - 200: Successful response # Grant a team permission to a user URL: /api/admin/permissions/team-permissions/team_id/user_id/permission_id/post Source: /vercel/path0/docs/content/api/admin/permissions/team-permissions/team_id/user_id/permission_id/post.mdx # API Documentation: Grant a team permission to a user Grant a team permission to a user (the team permission must be created first on the Stack dashboard) ## POST /team-permissions/{team_id}/{user_id}/{permission_id} **Summary:** Grant a team permission to a user **Description:** Grant a team permission to a user (the team permission must be created first on the Stack dashboard) **Parameters:** - `team_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user - `permission_id` (path): The permission ID used to uniquely identify a permission. Can either be a custom permission with lowercase letters, numbers, `:`, and `_` characters, or one of the system permissions: `$update_team`, `$delete_team`, `$read_members`, `$remove_members`, `$invite_members`, `$manage_api_keys` **Request Body:** Request body required **Responses:** - 201: Successful response # Get Item URL: /api/client/payments/payments/items/customer_type/customer_id/item_id Source: /vercel/path0/docs/content/api/client/payments/payments/items/customer_type/customer_id/item_id.mdx # API Documentation: Get Item Retrieves information about a specific item (credits, quotas, etc.) for a customer. ## GET /payments/items/{customer_type}/{customer_id}/{item_id} **Summary:** Get Item **Description:** Retrieves information about a specific item (credits, quotas, etc.) for a customer. **Parameters:** - `customer_type` (path): The type of customer - `customer_id` (path): The ID of the customer - `item_id` (path): The ID of the item to retrieve **Responses:** - 200: Successful response # Get Item URL: /api/server/payments/payments/items/customer_type/customer_id/item_id Source: /vercel/path0/docs/content/api/server/payments/payments/items/customer_type/customer_id/item_id.mdx # API Documentation: Get Item Retrieves information about a specific item (credits, quotas, etc.) for a customer. ## GET /payments/items/{customer_type}/{customer_id}/{item_id} **Summary:** Get Item **Description:** Retrieves information about a specific item (credits, quotas, etc.) for a customer. **Parameters:** - `customer_type` (path): The type of customer - `customer_id` (path): The ID of the customer - `item_id` (path): The ID of the item to retrieve **Responses:** - 200: Successful response # Revoke a team permission from a user URL: /api/server/permissions/team-permissions/team_id/user_id/permission_id/delete Source: /vercel/path0/docs/content/api/server/permissions/team-permissions/team_id/user_id/permission_id/delete.mdx # API Documentation: Revoke a team permission from a user Revoke a team permission from a user ## DELETE /team-permissions/{team_id}/{user_id}/{permission_id} **Summary:** Revoke a team permission from a user **Description:** Revoke a team permission from a user **Parameters:** - `team_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user - `permission_id` (path): The permission ID used to uniquely identify a permission. Can either be a custom permission with lowercase letters, numbers, `:`, and `_` characters, or one of the system permissions: `$update_team`, `$delete_team`, `$read_members`, `$remove_members`, `$invite_members`, `$manage_api_keys` **Responses:** - 200: Successful response # Grant a team permission to a user URL: /api/server/permissions/team-permissions/team_id/user_id/permission_id/post Source: /vercel/path0/docs/content/api/server/permissions/team-permissions/team_id/user_id/permission_id/post.mdx # API Documentation: Grant a team permission to a user Grant a team permission to a user (the team permission must be created first on the Stack dashboard) ## POST /team-permissions/{team_id}/{user_id}/{permission_id} **Summary:** Grant a team permission to a user **Description:** Grant a team permission to a user (the team permission must be created first on the Stack dashboard) **Parameters:** - `team_id` (path): No description - `user_id` (path): The ID of the user, or the special value `me` for the currently authenticated user - `permission_id` (path): The permission ID used to uniquely identify a permission. Can either be a custom permission with lowercase letters, numbers, `:`, and `_` characters, or one of the system permissions: `$update_team`, `$delete_team`, `$read_members`, `$remove_members`, `$invite_members`, `$manage_api_keys` **Request Body:** Request body required **Responses:** - 201: Successful response # Update Item Quantity URL: /api/admin/payments/payments/items/customer_type/customer_id/item_id/update-quantity Source: /vercel/path0/docs/content/api/admin/payments/payments/items/customer_type/customer_id/item_id/update-quantity.mdx # API Documentation: Update Item Quantity Updates the quantity of an item for a customer. Can increase or decrease quantities, with optional expiration and negative balance control. ## POST /payments/items/{customer_type}/{customer_id}/{item_id}/update-quantity **Summary:** Update Item Quantity **Description:** Updates the quantity of an item for a customer. Can increase or decrease quantities, with optional expiration and negative balance control. **Parameters:** - `allow_negative` (query): Whether to allow the quantity to go negative - `customer_type` (path): The type of customer - `customer_id` (path): The ID of the customer - `item_id` (path): The ID of the item to update **Request Body:** Request body required **Responses:** - 200: Successful response # Update Item Quantity URL: /api/server/payments/payments/items/customer_type/customer_id/item_id/update-quantity Source: /vercel/path0/docs/content/api/server/payments/payments/items/customer_type/customer_id/item_id/update-quantity.mdx # API Documentation: Update Item Quantity Updates the quantity of an item for a customer. Can increase or decrease quantities, with optional expiration and negative balance control. ## POST /payments/items/{customer_type}/{customer_id}/{item_id}/update-quantity **Summary:** Update Item Quantity **Description:** Updates the quantity of an item for a customer. Can increase or decrease quantities, with optional expiration and negative balance control. **Parameters:** - `allow_negative` (query): Whether to allow the quantity to go negative - `customer_type` (path): The type of customer - `customer_id` (path): The ID of the customer - `item_id` (path): The ID of the item to update **Request Body:** Request body required **Responses:** - 200: Successful response

Sign In

Sign Up

Sign In

Sign In

Sign In

Team Switcher

Sign In

Sign Up

User Button

Your API Keys

Your API Keys

Your API Keys

Welcome!

Your Credits

Available Credits

Available Credits

Your Products

Your Products

Your Products

All Teams

My Custom Sign In page

My Custom Sign In page

You can only see this if you are logged in

You can only see this if you are logged in

Stack Auth JS Examples

User Information

Password Sign In

Sign In

Password Sign Up

Sign Up

OTP Sign In

Sign In with Email Code

OAuth Authentication

Sign In with OAuth

Supabase data

Welcome!

Available Credits

Welcome!

Team Storage Usage

Your API Keys ({apiKeys.length})

Available Credits: {credits.quantity}

Your API Keys ({apiKeys.length})

My Custom Sign In page