CreateApplication - 创建应用 - 访问控制

创建一个应用。

调试

您可以在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

返回参数

名称	类型	描述	示例值
	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	array	回调地址。
RedirectUri	string	回调地址。	https://www.example.com
UpdateDate	string	更新时间。	2020-10-23T08:06:57Z
DelegatedScope	object	应用权限范围信息。
PredefinedScopes	array<object>	应用权限范围信息。
PredefinedScope	object	应用权限范围信息。
Description	string	范围描述。	用于获取用户的OpenID（默认权限范围，不可移除）
Required	boolean	安装应用时，此权限范围是否默认必选。取值： true：必选。 false：非必选。其中`openid`默认为必选。	true
Name	string	范围名称。	openid
AppId	string	应用 ID。	472457090344041****
RefreshTokenValidity	integer	刷新令牌有效期。单位：秒。	7776000
IsMultiTenant	boolean	是否允许被其他账号安装。	true
AppType	string	应用类型。	WebApp

示例

正常返回示例

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": "用于获取用户的OpenID（默认权限范围，不可移除）",
            "Required": true,
            "Name": "openid"
          }
        ]
      }
    },
    "AppId": "472457090344041****",
    "RefreshTokenValidity": 7776000,
    "IsMultiTenant": true,
    "AppType": "WebApp"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-08-14	OpenAPI 描述信息更新	查看变更详情
2023-11-23	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情