/api/v1 (API Explorer) | Stack Auth Documentation

Client API
- GET/api/v1
Client APIAnonymous
- POSTSign up anonymously
Client APICLI Authentication
- POSTInitiate CLI authentication
- POSTPoll CLI authentication status
- POSTComplete CLI authentication
Client APIContact Channels
- GETList contact channels
- POSTCreate a contact channel
- POSTVerify an email
- POSTCheck email verification code
- GETGet a contact channel
- DELDelete a contact channel
- PATCHUpdate a contact channel
- POSTSend contact channel verification code
Client APIOAuth
- POSTOAuth token endpoints
- GETOAuth authorize endpoint
Client APIOthers
- GETList API keys
- GETGet API key details
- PATCHUpdate API key
Client APIOTP
- POSTSign in with a code
- POSTSend sign-in code
- POSTMFA sign in
- POSTCheck sign in code
Client APIPassword
- POSTUpdate password
- POSTSign up with email and password
- POSTSign in with email and password
- POSTSet password
- POSTSend reset password code
- POSTReset password with a code
- POSTCheck reset password code
Client APIPermissions
- GETList team permissions
- GETList project permissions
Client APIProjects
- GETGet the current project
Client APISessions
- GETList sessions
- DELSign out of the current session
- DELDelete session
- POSTRefresh access token
Client APITeams
- GETList teams
- POSTCreate a team
- GETList team members profiles
- GETList team invitations
- GETGet a team
- DELDelete a team
- PATCHUpdate a team
- POSTSend an email to invite a user to a team
- POSTAccept the team invitation
- DELDelete a team invitation
- DELRemove a user from a team
- GETGet a team member profile
- PATCHUpdate your team member profile
- POSTGet team invitation details
- POSTCheck if a team invitation code is valid
Client APIUsers
- GETGet current user
- DELDelete current user
- PATCHUpdate current user
Server API
- GET/api/v1
Server APIAnonymous
- POSTSign up anonymously
Server APICLI Authentication
- POSTInitiate CLI authentication
- POSTPoll CLI authentication status
- POSTComplete CLI authentication
Server APIContact Channels
- GETList contact channels
- POSTCreate a contact channel
- POSTVerify an email
- POSTCheck email verification code
- GETGet a contact channel
- DELDelete a contact channel
- PATCHUpdate a contact channel
- POSTSend contact channel verification code
Server APIOAuth
- POSTOAuth token endpoints
- GETOAuth authorize endpoint
Server APIOthers
- GETList API keys
- POSTPOST /(api-keys)/user-api-keys/check
- GETGet API key details
- PATCHUpdate API key
- POSTPOST /(api-keys)/team-api-keys/check
Server APIOTP
- POSTSign in with a code
- POSTSend sign-in code
- POSTMFA sign in
- POSTCheck sign in code
Server APIPassword
- POSTUpdate password
- POSTSign up with email and password
- POSTSign in with email and password
- POSTSet password
- POSTSend reset password code
- POSTReset password with a code
- POSTCheck reset password code
Server APIPermissions
- GETList team permissions of a user
- GETList project permissions
- POSTGrant a global permission to a user
- DELRevoke a global permission from a user
- POSTGrant a team permission to a user
- DELRevoke a team permission from a user
Server APIProjects
- GETGet the current project
Server APISessions
- GETList sessions
- POSTCreate session
- DELSign out of the current session
- DELDelete session
- POSTRefresh access token
Server APITeams
- GETList teams
- POSTCreate a team
- GETList team members profiles
- GETList team invitations
- GETGet a team
- DELDelete a team
- PATCHUpdate a team
- POSTSend an email to invite a user to a team
- POSTAccept the team invitation
- DELDelete a team invitation
- POSTAdd a user to a team
- DELRemove a user from a team
- GETGet a team member profile
- PATCHUpdate a team member profile
- POSTGet team invitation details
- POSTCheck if a team invitation code is valid
Server APIUsers
- GETList users
- POSTCreate user
- GETGet current user
- DELDelete current user
- PATCHUpdate current user
- GETGet user
- DELDelete user
- PATCHUpdate user

GEThttps://api.stack-auth.com/api/v1

Headers

X-Stack-Project-Idstring
X-Stack-Access-Typestring
X-Stack-Access-Tokenstring
X-Stack-Refresh-Tokenstring
X-Stack-Publishable-Client-Keystring
X-Stack-Secret-Server-Keystring
X-Stack-Super-Secret-Admin-Keystring

Request

$ curl https://api.stack-auth.com/api/v1 \
>      -H "X-Stack-Project-Id: string" \
>      -H "X-Stack-Access-Type: string" \
>      -H "X-Stack-Access-Token: string" \
>      -H "X-Stack-Refresh-Token: string" \
>      -H "X-Stack-Publishable-Client-Key: string" \
>      -H "X-Stack-Secret-Server-Key: string" \
>      -H "X-Stack-Super-Secret-Admin-Key: string"

Response

$	curl https://api.stack-auth.com/api/v1 \
>	-H "X-Stack-Project-Id: string" \
>	-H "X-Stack-Access-Type: string" \
>	-H "X-Stack-Access-Token: string" \
>	-H "X-Stack-Refresh-Token: string" \
>	-H "X-Stack-Publishable-Client-Key: string" \
>	-H "X-Stack-Secret-Server-Key: string" \
>	-H "X-Stack-Super-Secret-Admin-Key: string"