Requests OAuth 2.0 authorization.
Operation description
For details, see the user guide.
Try it now
Test
RAM authorization
Request syntax
GET /v2/oauth/authorize HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| domain_id |
string |
Yes |
The domain ID. |
|
| client_id |
string |
Yes |
The client ID assigned when you create an app. |
47eUHhrzgWBvlLWj |
| redirect_uri |
string |
Yes |
The redirect URI specified when you created the app. This URI must be URL-encoded. |
https%3A%2F%2Fwww.aliyunpds.com%2Fsign%2Fcallback |
| scope |
array |
No |
The requested permissions. If omitted, the request defaults to all permissions. |
|
|
string |
No |
Currently, you can only request all permissions for the app. Set this parameter to all or omit it. |
all |
|
| response_type |
string |
Yes |
The response type. This parameter must be set to code. |
code |
| state |
string |
No |
A value to maintain state between the request and callback. This value is returned to your redirect URI. We recommend using this parameter to prevent cross-site request forgery (CSRF) attacks. |
customdata |
| login_type |
string |
Yes |
The authentication method. Valid values:
|
default |
| hide_consent |
boolean |
No |
Specifies whether to hide the consent page. Default value: false. |
true |
Response elements
|
Element |
Type |
Description |
Example |
None defined.
Examples
Success response
JSON format
{}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.