All Products
Search
Document Center

Resource Access Management:ListPredefinedScopes

Last Updated:Jan 20, 2025

Queries predefined application permissions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
PredefinedScopesarray<object>

The information about application permissions.

PredefinedScopeobject
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 permission scope.

openid
RequestIdstring

The request ID.

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
2024-08-14API Description UpdateView Change Details