Sign in

v1

latestOpenAPI 3.0.02026-08-0610682246.0 KB
Third-Party Authentication

Grant the access request

The resource owner will consent or deny the third party application access request, and Zephr will return an authorization code upon user's consent.

post/zephr/oauth2/grant

Request body

client_idstring required

Zephr Site Oauth2 Client ID

response_typestring required

Must be set to code

redirect_uristring required

Client's redirection endpoint. Must be an absolute URI

scopestring required

The scope of the access request. Supported scopes: user.account:read, user.profile:read and user.profile:update

statestring required

An opaque value used by the client to maintain state between the request and callback

allowboolean required

Resource owner consent

Example request

{
  "client_id": "1234567890",
  "response_type": "code",
  "redirect_uri": "https://someUrl.com/callback",
  "scope": "user.account:read user.profile:read",
  "state": "abcdefghijklmnopqrstuvwsyz",
  "allow": true
}

Response

OK. The template variable "BASICAUTH" is set as the authorization header of "$CLIENTID" and "$CLIENTSECRET". The template variable "AUTHCODE" is set to the response body "code" field.