All Products
Search

This Product

    Resource Access Management:ListPredefinedScopes

    Document Center

    Resource Access Management:ListPredefinedScopes

    Last Updated:Mar 30, 2026

    Queries predefined application permissions.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    AppType

    string

    No

    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 elements

    Element

    Type

    Description

    Example

    object

    PredefinedScopes

    object

    PredefinedScope

    array<object>

    The information about application permissions.

    object

    Description

    string

    The description of the permission scope.

    Used to obtain user OpenID (default scope, not removable)

    Name

    string

    The name of the permission scope.

    openid

    RequestId

    string

    The request ID.

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

    Examples

    Success response

    JSON format

    {
  "PredefinedScopes": {
    "PredefinedScope": [
      {
        "Description": "Used to obtain user OpenID (default scope, not removable)",
        "Name": "openid"
      }
    ]
  },
  "RequestId": "955C096D-EC99-480B-AF37-3921109107D0"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.