Returns a human-readable message with some useful information about the API.

/api/v1

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.

Send an email to invite a user to a team

Verify an email

Send a code to the user's email address for verifying the email.

Send email verification code

Check if an email verification code is valid without using it

Check email verification code

Emails

This endpoint is used to exchange an authorization code or refresh token for an access token.

OAuth token endpoints

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.

OAuth authorize endpoint

OAuth

No documentation available for this endpoint.

POST /team-invitations/accept/details

Others

Sign in with a code

Send a code to the user's email address for sign-in.

Send sign-in code

Complete multi-factor authorization to sign in, with a TOTP and an MFA attempt code

MFA sign in

Check if a sign in code is valid without using it

Check sign in code

Update the password of the current user, requires the old password

Update password

Create a new account with email and password

Sign up with email and password

Sign in to an account with email and password

Sign in with email and password

Send a code to the user's email address for resetting the password.

Send reset password code

Reset password with a code

Check if a reset password code is valid without using it

Check reset password code

Password

Filter with the team ID. If set, only the permissions of the members in a specific team will be returned.

Filter with the permission ID. If set, only the permissions with this specific ID will be returned

List team permissions

Permissions

Get the current project information including display name, oauth providers and authentication methods. Useful for display the available login options to the user.

Get the current project

Projects

Sign out of the current session and invalidate the refresh token

Sign out of the current session

Get a new access token using a refresh token

Refresh access token

Sessions

List teams

Create a new team and optionally add the current user as a member.

Create a team

List team members profiles

Get a team that the current user is a member of.

Get a team

Delete a team

Update a team

Send an email to a user to invite them to a team

Invite a user to a team

Remove a user from a team

Get a team member profile

Update your team member profile

Check if a team invitation code is valid without using it

Check if a team invitation code is valid

Teams

Get current user

Updates the currently authenticated user. Only the values provided will be updated.

Update current user

Users

PostContactChannelsSendVerificationCodeResponse

PostContactChannelsVerifyCheckCodeResponse

PostContactChannelsVerifyResponse

PostTeamInvitationsSendCodeResponse

PostTeamInvitationsAcceptDetailsResponse

PostAuthMfaSignInResponse

Long-lived refresh token that can be used to obtain a new access token

Short-lived access token that can be used to authenticate the user

PostAuthOtpSendSignInCodeResponse

PostAuthOtpSignInCheckCodeResponse

PostAuthOtpSignInResponse

PostAuthPasswordResetCheckCodeResponse

PostAuthPasswordResetResponse

PostAuthPasswordSendResetCodeResponse

PostAuthPasswordSignInResponse

PostAuthPasswordSignUpResponse

PostAuthPasswordUpdateResponse

GetTeamPermissionsResponse

GetTeamPermissionsResponseItemsItem

GetProjectsCurrentResponse

Human-readable project display name. This is not a unique identifier.

GetProjectsCurrentResponseConfig

Whether email password authentication is enabled for this project

Whether magic link authentication is enabled for this project

GetProjectsCurrentResponseConfigEnabledOauthProvidersItem

DeleteAuthSessionsCurrentResponse

PostAuthSessionsCurrentRefreshResponse

DeleteTeamMembershipsTeamIdUserIdResponse

DeleteTeamsTeamIdResponse

GetTeamMemberProfilesResponse

GetTeamMemberProfilesResponseItemsItem

URL of the profile image for team member. Can be a Base64 encoded image. Must be smaller than 100KB. Please compress and crop to a square before passing in.

GetTeamMemberProfilesTeamIdUserIdResponse

GetTeamsResponse

GetTeamsResponseItemsItem

Human-readable team display name. This is not a unique identifier.

URL of the profile image for team. Can be a Base64 encoded image. Must be smaller than 100KB. Please compress and crop to a square before passing in.

Client metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client.

Client read-only, server-writable metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client. The client can read this data, but cannot modify it. This is useful for things like subscription status.

GetTeamsTeamIdResponse

PatchTeamMemberProfilesTeamIdUserIdResponse

PatchTeamsTeamIdResponse

PostTeamInvitationsAcceptCheckCodeResponse

PostTeamInvitationsAcceptResponse

PostTeamsResponse

GetUsersMeResponse

Whether the primary email has been verified to belong to this user

Human-readable user display name. This is not a unique identifier.

URL of the profile image for user. Can be a Base64 encoded image. Must be smaller than 100KB. Please compress and crop to a square before passing in.

1	curl -X POST https://api.stack-auth.com/api/v1/team-invitations/send-code \
2	-H "Content-Type: application/json" \
3	-d '{
4	"team_id": "ad962777-8244-496a-b6a2-e0c6a449c79e",
5	"email": "[email protected]",
6	"callback_url": "https://example.com/handler/email-verification"
7	}'

Request

Response