調用CreateApplication API建立應用-存取控制-阿里雲 - Resource Access Management

建立一個應用。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ram:CreateApplication

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
DisplayName	string	是	應用的顯示名稱。最大長度為 24 個字元。	myapp
AppType	string	是	應用類型。取值： WebApp：指基於瀏覽器互動的網路應用。 NativeApp：指作業系統中啟動並執行本地應用，主要為運行在案頭作業系統或移動作業系統中的應用。 ServerApp：指直接存取阿里雲服務，而無需依賴使用者登入的應用，目前僅支援基於 SCIM 協議的使用者同步應用。	WebApp
RedirectUris	string	否	回調地址。輸入多個時，以英文分號（;）分隔。	https://www.example.com
SecretRequired	boolean	否	是否需要應用密鑰。取值： true false 說明對於 WebApp 和 ServerApp 類型的應用，該值會被強制設定為 true，不支援修改。對於 NativeApp 類型的應用，可以設定為 true 或 false，如不設定，預設為 false。由於此類應用往往運行在非可信環境，無法有效保護應用密鑰，因此建議您如無明確需要，不要設定為 true。更多資訊，請參見 Native 應用登入阿里雲。	true
AccessTokenValidity	integer	否	存取權杖有效期間。取值範圍：900~10800。單位：秒。預設值：3600。	3600
RefreshTokenValidity	integer	否	重新整理權杖有效期間。取值範圍：7200~31536000。單位：秒。預設值：對於 NativeApp 和 ServerApp 類型的應用，如果該值為空白，則預設為 2592000 秒（即 30 天）。對於 WebApp 類型的應用，如果該值為空白，則預設為 7776000 秒（即 90 天）。	2592000
PredefinedScopes	string	否	應用許可權範圍。關於應用許可權範圍的取值和描述，請參見 OAuth 範圍。您也可以調用 ListPredefinedScopes 擷取不同應用類型支援的應用許可權範圍。輸入多個應用許可權範圍時，以英文分號（;）分隔。	aliuid;profile
RequiredScopes	string	否	必選的應用許可權範圍。您可以將`RequiredScopes`中設定的一個或多個範圍設為必選，設為必選後，當使用者進行應用授權時，必選範圍預設選中且不可取消。輸入多個應用許可權範圍時，以英文分號（;）分隔。說明如果您設定的`RequiredScopes`項不在`PredefinedScopes`的範圍內，則該項必選範圍不生效。	aliuid
IsMultiTenant	boolean	否	是否允許被其他帳號安裝。取值： true：對於 NativeApp 和 ServerApp 類型的應用，如果該值為空白，則預設為 true。 false：對於 WebApp 類型的應用，如果該值為空白，則預設為 false。	false
AppName	string	否	應用程式名稱。最大長度為 64 個字元，允許輸入英文字母、數字、英文句點（.）、底線（_）或中劃線（-）。	myapp
ProtocolVersion	string	否	應用的 OAuth 協議版本。取值： `2.0`：表示為 OAuth 2.0 協議。 `2.1`：表示為 OAuth 2.1 協議。預設值：`2.0`。	2.0

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	6616F09B-2768-4C11-8866-A8EE4C4A583E
Application	object	應用資訊。
DisplayName	string	應用的顯示名稱。	myapp
AccessTokenValidity	integer	存取權杖有效期間。單位：秒。	3600
SecretRequired	boolean	是否需要應用密鑰。	true
AccountId	string	應用所屬的阿里雲帳號 ID。	177242285274****
CreateDate	string	建立時間。	2020-10-23T08:06:57Z
AppName	string	應用程式名稱。	myapp
RedirectUris	object
RedirectUri	array	回調地址。
	string	回調地址。	https://www.example.com
UpdateDate	string	更新時間。	2020-10-23T08:06:57Z
DelegatedScope	object	應用許可權範圍資訊。
PredefinedScopes	object
PredefinedScope	array<object>	應用許可權範圍資訊。
	object	應用許可權範圍資訊。
Description	string	範圍描述。	Obtain the OpenID of the user. This is the default permission that you cannot remove.
Required	boolean	安裝應用時，此許可權範圍是否預設必選。取值： true：必選。 false：非必選。其中`openid`預設為必選。	true
Name	string	範圍名稱。	openid
AppId	string	應用 ID。	472457090344041****
RefreshTokenValidity	integer	重新整理權杖有效期間。單位：秒。	7776000
IsMultiTenant	boolean	是否允許被其他帳號安裝。	true
AppType	string	應用類型。	WebApp
ProtocolVersion	string	應用的 OAuth 協議版本。取值： `2.0`：表示為 OAuth 2.0 協議。 `2.1`：表示為 OAuth 2.1 協議。	2.0

樣本

正常返回樣本

JSON格式

{
  "RequestId": "6616F09B-2768-4C11-8866-A8EE4C4A583E",
  "Application": {
    "DisplayName": "myapp",
    "AccessTokenValidity": 3600,
    "SecretRequired": true,
    "AccountId": "177242285274****",
    "CreateDate": "2020-10-23T08:06:57Z",
    "AppName": "myapp",
    "RedirectUris": {
      "RedirectUri": [
        "https://www.example.com"
      ]
    },
    "UpdateDate": "2020-10-23T08:06:57Z",
    "DelegatedScope": {
      "PredefinedScopes": {
        "PredefinedScope": [
          {
            "Description": "Obtain the OpenID of the user. This is the default permission that you cannot remove.",
            "Required": true,
            "Name": "openid"
          }
        ]
      }
    },
    "AppId": "472457090344041****",
    "RefreshTokenValidity": 7776000,
    "IsMultiTenant": true,
    "AppType": "WebApp",
    "ProtocolVersion": "2.0"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。