Grant the access request

Public API reference

v4 API

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.

Security

CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie

Bodyapplication/json

client_idstringrequired

Zephr Site Oauth2 Client ID

Example:"1234567890"

response_typestringrequired

Must be set to code

Example:"code"

redirect_uristringrequired

Client's redirection endpoint. Must be an absolute URI

Example:"https://someUrl.com/callback"

scopestringrequired

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

Example:"user.account:read user.profile:read"

statestringrequired

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

Example:"abcdefghijklmnopqrstuvwsyz"

allowbooleanrequired

Resource owner consent

Example:true

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

Responses

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.

Headers

Locationstring

Body*/*

statestring

State (string)

codestring

Authorization code (string)

Response

{
  "state": "string",
  "code": "string"
}