Authorization API

---

Password Grant - Get Access Token

Request URL

POST /api/v1.0/invoke/open-ability/method/oauth2/token

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/x-www-form-urlencoded
Accept	String	Header	Yes	Accept, the value is application/json
grant_type	String	Body	Yes	Grant type, the value is password
client_id	String	Body	Yes	Client ID
client_secret	String	Body	Yes	Client secret
scope	String	Body	Yes	Authorization scope, the value is manager
username	String	Body	Yes	Username
password	String	Body	Yes	Password
expires_in	Integer	Body	No	Token expiration time (s)

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
access_token	String	Body	Access token
refresh_token	String	Body	Refresh token
token_type	String	Body	Token type, the value is bearer
expires_in	Integer	Body	Token expiration time (s)

Request Example

POST /api/v1.0/invoke/open-ability/method/oauth2/token

Content-Type: application/x-www-form-urlencoded

Accept: application/json

grant_type=password&

client_id=caa0b4dffd57202a157ed46664f93c192&

client_secret=s75b058bfd9e4e0659d75b67aw3334745&

username=ucaa0b4dffd57202a157bf46664f9dc19&

password=pucaa0b4dffd57202a157bf46664q93c1&

scope=manager

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "access_token": "ad5db2a3d3ab09e5890c4ffba9eaf3c52",
    "refresh_token": "r91b9ba8bc024e23617f63f908dc15951",
    "token_type": "bearer",
    "expires_in": 3600
  }
}

Failure Return Example

See Failure Return Example

---

Refresh Access Token

Request URL

POST /api/v1.0/invoke/open-ability/method/oauth2/token

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/x-www-form-urlencoded
Accept	String	Header	Yes	Accept, the value is application/json
grant_type	String	Body	Yes	Authorization type, the value is refresh_token
client_id	String	Body	Yes	Client ID
client_secret	String	Body	Yes	Client secret
refresh_token	String	Body	Yes	Refresh token
expires_in	Integer	Body	No	Token expiration time (s)

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
access_token	String	Body	Access token
refresh_token	String	Body	Refresh token
token_type	String	Body	Token type, the value is bearer
expires_in	Integer	Body	Token expiration time (s)

Request Example

POST /api/v1.0/invoke/open-ability/method/oauth2/token

Content-Type: application/x-www-form-urlencoded

Accept: application/json

grant_type=refresh_token&

client_id=caa0b4dffd57202a157bf46664f93c192&

client_secret=s75b058bfd9e4e0659d75b67a03334745&

refresh_token=r91b9ba8bc024e23617f63f908dc15950

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "access_token": "ad5db2a3d3ab09e5890c4ffba9eaf3c53",
    "refresh_token": "r91b9ba8bc024e23617f63f908dc15952",
    "token_type": "bearer",
    "expires_in": 3600
  }
}

Failure Return Example

See Failure Return Example