Login with Vorg ID

Authorize your users via Vorg ID.

APIs that require the user’s permission to access resources use user access tokens. Vorg uses scopes to identify the resources, or the fields within a resource, that your app needs permission to access. For example, you don’t need permission to get a user’s User resource but you do need their permission to include their email address with the resource.

Authorize URL

With OAuth 2.0, you create an authorize URL, which you can use to allow a user to authenticate via an authentication flow, similar to “Sign In” with Vorg ID. We recommend using our buttons to redirect the user to log in to Vorg ID.

https://vvvorg.com/rrr/oauth2.0/authorize?client_id=1436475&redirect_url=https://vvvorg.com&response_type=code&scopes=VorgID::user Funplace::user&state=returnMe

To authorize the user, redirect the user to the link https://vvvorg.com/rrr/oauth2.0/authorize with GET data indicated in the table.

Parameter
Required?
Type
Description

client_id

yes

string

Your app’s Client ID.

redirect_url

yes

URI

One of the redirect urls registered in the application. The user will be returned to it after authorization in Vorg ID (Successful or not).

response_type

yes

string

Must be set to code.

scopes

yes

string

A space-delimited list of scopes. The APIs that you’re calling identify the scopes you must list. You must URL encode the list. Check out the full list of scopes here.

state

no

string

The value that we will return along with the user as a GET to redirect_url.

form

no

string

Select a login form design. Available values: VorgID, Funplace. Defaults to VorgID.

After authorization on the Vorg ID side, the user will be returned to the redirect_url along with the state value and authoriztion_code in case of successful authorization or error information in case of unsuccessful authorization.

The parameters that we will pass with the user to redirect_url are indicated in the table.

Parameter
Required?
Type
Description

state

no

string

Your state value.

code

yes (if authorization was successful)

string

Authorization code.

error

yes (if authorization was unsuccessful)

string

Information about the error that occurred during user authorization.

For further interaction with the API, exchange authoriztion_code for access_token. To do this, go to the section for obtaining an Oauth2.0 token.

Last updated

Was this helpful?