All Products
Search
Document Center

Resource Access Management:ListPredefinedScopes

Last Updated:May 08, 2024

Queries predefined application permissions.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
AppTypestringNo

The type of the application. Valid values:

  • WebApp
  • NativeApp
  • ServerApp

If this parameter is empty, the permissions on all types of applications are queried.

WebApp

Response parameters

ParameterTypeDescriptionExample
object
PredefinedScopesobject []

The information of application permissions.

Descriptionstring

The description of the permission scope.

Obtain the OpenID of the user. This is the default permission that you cannot remove.
Namestring

The name of the scope.

openid
RequestIdstring

The ID of the request.

955C096D-EC99-480B-AF37-3921109107D0

Examples

Sample success responses

JSONformat

{
  "PredefinedScopes": {
    "PredefinedScope": [
      {
        "Description": "Obtain the OpenID of the user. This is the default permission that you cannot remove.",
        "Name": "openid"
      }
    ]
  },
  "RequestId": "955C096D-EC99-480B-AF37-3921109107D0"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history