Oauth2

On this page, all usage of /api/oauth2 methods will be explained in details.

Before starting

Before you start to use the oauth2 flow, you must create an oauth2 application in your vortezz.dev dashboard.

// TODO : Explain

Creating an authorization link

To create an authorization link you will need to follow the following rules :

Create an authorization link

GET https://vortezz.dev/oauth/authorize

Example : https://vortezz.dev/oauth/authorize?response_type=code&client_id=2&scope=profile&redirect_uri=http://localhost:3002

Query Parameters

Name	Type	Description
response_type*	String	The response type of the oauth2 request
client_id*	Integer	The client id of you application
scope*	String	A list of scopes separated by a ,
redirect_uri*	String	One of the redirect uri set in your application settings (case sensitive)

200: OK Valid url query parameters

Response Types

Currently only the code response type is available.

Scopes

There is 4 scopes that you can use to get different types of account data :

Scope	Value
identify	Account id
emails	Account associated emails, and whether the email is the primary one
profile	Username, icon and user description
connections	Know all allowed oauth2 apps of the user

Token related requests

Do operations on oauth tokens

POST https://vortezz.dev/api/v1/oauth/token

Data related requests

Notes