获取iam用户token（使用密码）-九游平台

功能介绍

该接口可以用于通过用户名/密码的方式进行认证来获取iam用户的token。token是系统颁发给iam用户的访问令牌，承载用户的身份、权限等信息。调用iam以及其他云服务的接口时，可以使用本接口获取的iam用户token进行鉴权。但强烈推荐您使用调用api，可以避免因缓存的token失效导致的api调用失败的问题。

该接口可以使用全局区域的endpoint和其他区域的endpoint调用。iam的endpoint请参见：。

在使用本接口前，请先确认当前需要获取token的身份：

• iam用户获取token

  直接按照请求参数说明获取token。

• 华为账号获取token

  华为账号不支持直接获取账号token，排查是否为华为账号请参见：

  华为账号获取token请参见以下步骤：，授予该用户必要的权限，使用创建的iam用户名和密码，获取iam用户token。

• 华为云账号获取token

  直接按照请求参数说明获取token。

• 第三方系统用户获取token

  如果您是第三方系统用户，直接使用联邦认证的用户名和密码获取token，系统会提示密码错误。请先在华为云的登录页面，通过“忘记密码”功能，设置华为云账号密码。

约束与限制

• token的有效期为24小时。建议进行缓存，避免频繁调用。使用token前请确保token离过期有足够的时间，防止调用api的过程中token过期导致调用api失败。重新获取token，不影响已有token有效性。
• 如果在token有效期内进行如下操作，当前token最长30分钟失效。
  • 删除/停用iam用户。
  • 修改iam用户密码、访问密钥。
  • iam用户权限发生变化（如账号欠费无法访问云服务、申请公测通过、iam用户权限被修改等）。
• 使用token调用云服务api时， 返回“the token must be updated”，则token过期，需要客户端重新获取token。
• token是否可以被篡改：token生成时加入了签名防篡改的机制，token被修改后无法通过验签，防止token被伪造。

调试

您可以在中调试该接口。

uri

post /v3/auth/tokens

请求参数

请求示例

• 获取iam用户名为“iamuser”，iam用户密码为“iampassword”，所属租户名为“iamdomain”，作用范围为项目“cn-north-1”，且返回的响应体中将不显示catalog信息的token。iam用户名、所属账号名可以在界面控制台“我的凭证”中查看，具体获取方法请参见：获取账号、iam用户、项目、用户组、区域、委托的名称和id。

  post https://iam.myhuaweicloud.com/v3/auth/tokens?nocatalog=true

  {
      "auth": {
          "identity": {
              "methods": [
                  "password"
              ],
              "password": {
                  "user": {
                      "domain": {
                          "name": "iamdomain"        //iam用户所属账号名
                      },
                      "name": "iamuser",             //iam用户名
                      "password": "iampassword"      //iam用户密码
                  }
              }
          },
          "scope": {
              "project": {
                  "name": "cn-north-1"               //项目名称
              }
          }
      }
  }

• 获取iam用户名为“iamuser”，iam用户密码为“iampassword”，所属账号名为“iamdomain”，作用范围为整个账号的token。iam用户名、所属账号名可以在界面控制台“我的凭证”中查看，具体获取方法请参见：获取账号、iam用户、项目、用户组、区域、委托的名称和id。

  post https://iam.myhuaweicloud.com/v3/auth/tokens

  {
      "auth": {
          "identity": {
              "methods": [
                  "password"
              ],
              "password": {
                  "user": {
                      "domain": {
                          "name": "iamdomain"        //iam用户所属账号名
                      },
                      "name": "iamuser",             //iam用户名
                      "password": "iampassword"      //iam用户密码
                  }
              }
          },
          "scope": {
              "domain": {
                  "name": "iamdomain"        //iam用户所属账号名
              }
          }
      }
  }

响应参数

响应示例

状态码为 201 时:

创建成功。

• 获取iam用户名为“iamuser”，iam用户密码为“iampassword”，所属账号名为“iamdomain”，作用范围为项目“cn-north-1”，且返回的响应体中将不显示catalog信息的token。

  响应header参数（获取到的token）：
  x-subject-token:miiatayjkozihvcnaqccoiiaptccgqecaqexdtalb...

  响应body参数：
  {
      "token": {
          "catalog": [],
          "expires_at": "2020-01-04t09:05:22.701000z",
          "issued_at": "2020-01-03t09:05:22.701000z",
          "methods": [
              "password"
          ],
          "project": {
              "domain": {
                  "id": "d78cbac186b744899480f25bd022f...",
                  "name": "iamdomain"
              },
              "id": "aa2d97d7e62c4b7da3ffdfc11551f...",
              "name": "cn-north-1"
          },
          "roles": [
              {
                  "id": "0",
                  "name": "te_admin"
              },
              {
                  "id": "0",
                  "name": "op_gated_video_campus"
              }
          ],
          "user": {
              "domain": {
                  "id": "d78cbac186b744899480f25bd022f...",
                  "name": "iamdomain"
              },
              "id": "7116d09f88fa41908676fdd4b039e...",
              "name": "iamuser",
              "password_expires_at": ""
          }
      }
  }

• 获取iam用户名为“iamuser”，iam用户密码为“iampassword”，所属账号名为“iamdomain”，作用范围为整个账号的token。

  响应header参数（获取到的token）：
  x-subject-token:miiatayjkozihvcnaqccoiiaptccgqecaqexdtalb...

  响应body参数：
  {
      "token": {
          "catalog": [
              {
                  "endpoints": [
                      {
                          "id": "33e1cbdd86d34e89a63cf8ad16a5f...",
                          "interface": "public",
                          "region": "*",
                          "region_id": "*",
                          "url": "https://iam.myhuaweicloud.com/v3.0"
                      }
                  ],
                  "id": "100a6a3477f1495286579b819d399...",
                  "name": "iam",
                  "type": "iam"
              },
              {
                  "endpoints": [
                      {
                          "id": "29319cf2052d4e94bcf438b55d143...",
                          "interface": "public",
                          "region": "*",
                          "region_id": "*",
                          "url": "https://bss.sample.domain.com/v1.0"
                      }
                  ],
                  "id": "c6db69fabbd549908adcb861c7e47...",
                  "name": "bssv1",
                  "type": "bssv1"
              }
          ],
          "domain": {
              "id": "d78cbac186b744899480f25bd022f...",
              "name": "iamdomain"
          },
          "expires_at": "2020-01-04t09:08:49.965000z",
          "issued_at": "2020-01-03t09:08:49.965000z",
          "methods": [
              "password"
          ],
          "roles": [
              {
                  "id": "0",
                  "name": "te_admin"
              },
              {
                  "id": "0",
                  "name": "secu_admin"
              },
              {
                  "id": "0",
                  "name": "te_agency"
              }
          ],
          "user": {
              "domain": {
                  "id": "d78cbac186b744899480f25bd022f...",
                  "name": "iamdomain"
              },
              "id": "7116d09f88fa41908676fdd4b039e...",
              "name": "iamuser",
              "password_expires_at": ""
          }
      }
  }

状态码为 400 时:

参数无效。请排查body体是否符合json语法。

{
    "error": {
        "code": 400,
        "message": "the request body is invalid",
        "title": "bad request"
    }
}

状态码为 401 时:

认证失败。

• 如果您是第三方系统用户，直接使用联邦认证的用户名和密码获取token，系统会提示密码错误。请在华为云的登录页面，通过“忘记密码”功能，设置华为云账号密码，并在password中输入新设置的密码。
• 如果您的华为云账号已升级为华为账号，直接使用华为账号名和密码获取token，系统会提示密码错误。建议您为自己创建一个iam用户，授予该用户必要的权限，获取iam用户token。

{
    "error": {
        "code": 401,
        "message": "the username or password is wrong.",
        "title": "unauthorized"
    }
}

返回值

错误码

无

故障处理

• 提示用户名或密码错误：请排查输入的用户名和密码是否正确。用户名密码正确但是仍旧报错，请排查，华为账号不支持直接获取token，请新建一个iam用户并授权，并使用该iam用户名和密码获取token。
• 提示没有api访问权限：调用api前，请确保已开启编程访问。

相关操作

• 如果您开启了登录保护并设置登录保护为mfa验证，请参考获取iam用户token。
• 如果需要获取具有security administrator权限的token，请参见：。