Request URI

A request URI is in the following format:

{URI-scheme}://{Endpoint}/{resource-path}?{query-string}

For example, to obtain the IAM token in region CN North-Beijing1, obtain the endpoint (iam.cn-north-1.myhuaweicloud.com) of this region and the resource-path (/v3/auth/tokens) in the URI of the API, which is used for obtaining a user token. Then, assemble these fields as follows:

https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

Figure 1 Example URI

To simplify the URI display, each API is provided with only a resource-path and a request method. This is because the URI-scheme value of all APIs is HTTPS, and the endpoints in a region are the same. Therefore, the two parts are omitted.

Request Methods

HTTP-based request methods, which are also called operations or actions, specify the type of operations that you are requesting.

• GET: requests the server to return specified resources.
• PUT: requests the server to update specified resources.
• POST: requests the server to add resources or perform special operations.
• DELETE: requests the server to delete specified resources, for example, an object.
• HEAD: requests a server resource header.
• PATCH: requests the server to update partial content of a specified resource. If the target resource does not exist, PATCH may create a resource.

For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows:

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

Request Header

You can also add additional fields to a request, such as the fields required by a specified URI or an HTTP method. For example, add Content-Type that defines a request body type to request for the authentication information.

Common request headers are as follows:

• Content-Type: specifies the request body type or format. This field is mandatory and its default value is application/json.
• X-Auth-Token: specifies the user token, which is optional. This field is mandatory for token-based authentication. The user token is a response to the API used to obtain a user token. This API is the only one that does not require authentication.
  

  In addition to supporting authentication using tokens, public cloud APIs support authentication using the access key ID (AK)/secret access key (SK), which uses SDKs to sign a request. During the signing, the Authorization (signature authentication information) and X-Sdk-Date (time when a request is sent) headers are automatically added to the request. For more details, see Authentication Using AK/SK.

The API used to obtain a user token does not require authentication. Therefore, this API only requires adding the Content-Type field. The request with the added Content-Type header is as follows:

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
Content-Type: application/json

Request Body

A request body conveys information other than the request header and is generally sent in a structured format defined by the request header field Content-Type. If the request body contains Chinese characters, these characters must be coded in UTF-8.

The request body varies according to the APIs. Certain APIs do not require the request body, such as the GET and DELETE APIs.

For the API used to obtain a user token, obtain the request parameters and parameter description in the API request. The following section provides an example request with the body included. Set username (first name), account name (second name), login password (password), and project ID (id) as required. If the token is obtained using an account, the username and account name are the same. For details about parameter settings, see Obtaining a Project ID.

scope specifies where a token takes effect. Its value can be project or domain. In the preceding example, the value of scope is project, indicating that the obtained token can access only resources of the specified project. For details, see Obtaining a User Token.

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
Content-Type: application/json
{
    "auth": {
        "identity": {
            "methods": [
                "password"
            ],
            "password": {
                "user": {
                    "name": "username",
                    "password": "********",
                    "domain": {
                        "name": "domainname "
                    }
                }
            }
        },
        "scope": {
            "project": {
                "id": "xxxxxxxxxxxxxxxxxx"
            }
        }
    }
}

If all data required by a request is available, you can send the request to call an API through curl, Postman, or coding. For the API used to obtain a user token, x-subject-token in the response header is the desired user token. Then, you can use the token to authenticate the calling of other APIs.