All Products
Search

This Product

    ALIYUN::ApiGateway::Authorization

    Document Center
    Download PDF

    ALIYUN::ApiGateway::Authorization

    Last Updated: Jun 13, 2018

    ALIYUN::ApiGateway::Authorization can be used to authorize an API by providing the access permission to an app.

    Syntax

    1. {
    2.     "Type" : "ALIYUN::ApiGateway::Authorization",
    3.     "Properties" : {
    4.          "ApiIds" : List,
    5.          "AppIds" : List,
    6.          "GroupId" : String,
    7.          "StageName" : String,
    8.          "Description" : String
    9.     }
    10. }

    Attributes

    Attribute name Type Required Update allowed Description
    ApiIds list Yes Yes Specify the API IDs to be operated. You can enter up to 100 API IDs
    AppIds list Yes Yes App ID list, unique and generated by the system. Multiple IDs are supported
    GroupId string Yes Yes API group ID, unique and generated by the system
    StageName string Yes Yes Stage name. Values：TEST, PRE, and RELEASE
    Description string No Yes Authority description

    Example

    1. {
    2.   "ROSTemplateFormatVersion": "2015-09-01",
    3.   "Parameters": {
    4.     "GroupId": {
    5.       "Type": "String",
    6.       "Default": "xxxx10b1b4dc7a2e6ba8ca3xxxx",
    7.       "Description": "API group ID"
    8.     },
    9.     "AppId": {
    10.       "Type": "Number",
    11.       "Default": 5778174,
    12.       "Description": "APP ID"
    13.     },
    14.     "ApiId": {
    15.       "Type": "String",
    16.       "Default": "xxxxx2a8b6d4ce2ad1f95cbxxxxx",
    17.       "Description": "API ID"
    18.     }
    19.   },
    20.   "Resources": {
    21.     "Authorization": {
    22.       "Type": "ALIYUN::ApiGateway::Authorization",
    23.       "Properties": {
    24.         "GroupId": {
    25.           "Ref": "GroupId"
    26.         },
    27.         "StageName": "TEST",
    28.         "AppIds": [
    29.           {
    30.             "Ref": "AppId"
    31.           }
    32.         ],
    33.         "ApiIds": [
    34.           {
    35.             "Ref": "ApiId"
    36.           }
    37.         ],
    38.         "Description": "demo"
    39.       }
    40.     }
    41.   }
    42. }
    Free Trial Free Trial