すべてのプロダクト
Search

このプロダクト

    :GetAuthCode

    ドキュメントセンター

    :GetAuthCode

    最終更新日:Aug 08, 2025

    ユーザー ID と権限情報を含む認証コードを取得します。このコードを使用して、統合シナリオでクラウド アプリケーションを起動できます。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ecd:GetAuthCode

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    タイプ

    必須 / 任意

    説明

    例
    ExternalUserId

    string

    任意

    外部ユーザー ID 。呼び出し側がこの ID を定義します。 ID は、Alibaba Cloud アカウント内で一意である必要があります。このパラメーターと EndUserId の両方が空になることはできません。

    alice
    EndUserId

    string

    任意

    簡便アカウントのユーザー名。ユーザー名は、Alibaba Cloud アカウント内で一意である必要があります。このパラメーターと ExternalUserId の両方が空になることはできません。

    alice
    Policy

    string

    任意

    認証コードのアクセス権限を制限するアクセス ポリシー。このパラメーターが空の場合、制限は課されません。

    構文:

    {
      "Version": "1",
      "Resource": {
            "Type": "<リソースタイプ>", // リソースタイプ
            "Id": "<リソース ID>" // リソースID
      }
}

    <リソースタイプ> の有効な値は次のとおりです。

    • AppInstanceGroup: アプリケーション配信グループ。 ListAppInstanceGroup 操作を呼び出すことによって ID を取得します。

    • AppInstance: アプリケーション インスタンス。これは専用のフィールドです。

    • App: アプリケーション。 ListAppInstanceGroup 操作を呼び出すことによって ID を取得します。

    { "Version": "1", "Resource": { "Type": "AppInstanceGroup", "Id": "aig-9ciijz60n4xsv****" } }
    AutoCreateUser

    boolean

    任意

    ExternalUserId に基づいて新しい EndUserId を作成するかどうかを指定します。このパラメーターは、EndUserId が空の場合にのみ有効になります。

    false

    レスポンスパラメーター

    パラメーター

    タイプ

    説明

    例

    object

    返される情報。

    RequestId

    string

    リクエスト ID 。

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

    object

    認証コードに関する情報。

    AuthCode

    string

    認証コード。 3 分間有効で、検証結果に関係なく 1 回だけ使用できます。ユーザーに対して複数のコードが生成された場合、最新のコードのみが有効です。

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

    string

    簡便アカウントのユーザー名。

    alice
    ExpireTime

    string

    認証コードの有効期限。時間は協定世界時 (UTC) で、ISO 8601 標準に準拠しています。

    2015-01-23T12:33:18Z

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。