文档

GetAuthCode - 获取授权码

更新时间:

获取一个包含用户身份信息和权限信息的授权码,在集成场景中可使用该授权码唤起云应用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
appstreaming:GetAuthCodeWrite
  • AppStreaming
    acs:appstreaming::{#accountId}:*

请求参数

名称类型必填描述示例值
ExternalUserIdstring

外部用户ID,该ID由调用方自定义,确保在一个阿里云账号下唯一即可。不能和EndUserId同时为空。

alice
EndUserIdstring

无影便捷账号的用户名,在一个阿里云账号下唯一。不能和ExternalUserId同时为空。

alice
Policystring

权限策略,限制授权码的访问权限,为空表示不限制。

语法:

{
      "Version": "1",
      "Resource": {
            "Type": "<资源类型>",
            "Id": "<资源ID>"
      }
}

其中,<资源类型>的取值范围是:

  • AppInstanceGroup:交付组(ID可通过ListAppInstanceGroup接口获取)
  • AppInstance:应用实例(专用字段)
  • App:应用(ID可通过ListAppInstanceGroup接口获取)
{ "Version": "1", "Resource": { "Type": "AppInstanceGroup", "Id": "aig-9ciijz60n4xsv****" } }
AutoCreateUserboolean

根据ExternalUserId确认是否同步新建EndUserId。仅在EndUserId取值为空时生效。

枚举值:
  • true同步
  • false不同步[默认值]
false

返回参数

名称类型描述示例值
object

返回信息集合。

RequestIdstring

请求ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
AuthModelobject

授权码信息。

AuthCodestring

授权码。该授权码有效期为3分钟,且无论校验成功或失败,只能被使用一次。当为一个用户生成多个授权码时,只有最后一次生成的有效。

acv2ZEq2TNSqOlX+DvyetHGRT08iPhbWg/os1W4HojpBxkMQZkAnbKSfz/wNvS0E149IQZ5TogvBUE8ghCSVV+QBnv48Y+sn4z9fY5ywZA1peI5s4TplQI0TADBhPZXEIzMOdmbNsDGGlGcKOAq8ixd1Epzdu9XfvRzdLOO6o3zQwTZxXsjOgGBW8JTcgCP9W9iYiIjHIdZ2VCAnmMzuyVkyED8gymEevH10QoclyH/O3s8Yq6VF34gMXihDQeiI8PyiAZrW0JWXSWpdy3n4yGtAqMAgv46FzTA+XJ6C********
EndUserIdstring

无影便捷账号的用户名。

alice
ExpireTimestring

授权码过期时间,采用ISO 8601标准的UTC时间。

2015-01-23T12:33:18Z

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "AuthModel": {
    "AuthCode": "acv2ZEq2TNSqOlX+DvyetHGRT08iPhbWg/os1W4HojpBxkMQZkAnbKSfz/wNvS0E149IQZ5TogvBUE8ghCSVV+QBnv48Y+sn4z9fY5ywZA1peI5s4TplQI0TADBhPZXEIzMOdmbNsDGGlGcKOAq8ixd1Epzdu9XfvRzdLOO6o3zQwTZxXsjOgGBW8JTcgCP9W9iYiIjHIdZ2VCAnmMzuyVkyED8gymEevH10QoclyH/O3s8Yq6VF34gMXihDQeiI8PyiAZrW0JWXSWpdy3n4yGtAqMAgv46FzTA+XJ6C********",
    "EndUserId": "alice",
    "ExpireTime": "2015-01-23T12:33:18Z"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-06-02OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:AutoCreateUser
  • 本页导读 (0)