Request URI

A request URI is in the following format:

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

Although a request URI is included in the request header, most programming languages and frameworks require the request URI to be transmitted separately.

For example, to obtain an IAM token in the CN North-Beijing4 region, obtain the endpoint of IAM (iam.cn-north-4.myhuaweicloud.com) for this region and the resource-path (/v3/auth/tokens) in the URI of the API used to obtain a user token. Then, construct the URI as follows:

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

Figure 1 Example URI

To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.

Request Methods

The HTTP protocol defines the following request methods that can be used to send a request to the server:

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-4.myhuaweicloud.com/v3/auth/tokens
Content-Type: application/json 

Request Header

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

Common request header fields are as follows:

In addition to supporting token-based authentication, public cloud APIs also support authentication using access key ID/secret access key (AK/SK). During AK/SK-based authentication, an SDK is used to sign the request, and the Authorization (signature information) and X-Sdk-Date (time when the request is sent) header fields are automatically added to the request.

For more details, see AK/SK-based Authentication.

The API used to obtain a user token does not require authentication. Therefore, this API only requires adding the Content-Type field. An example of such requests is as follows:

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

Request Body

The body of a request is often sent in a structured format as specified in the Content-Type header field. The request body transfers all content except the request header.

The request body varies depending on APIs. Some APIs do not require the request body, for example, the APIs requested using the GET and DELETE methods.

In case of the API for obtaining a user token, obtain the request parameters and parameter description in the API request. The following provides an example request with a body included. Replace username, domainname, ******** (login password), and xxxxxxxx (project name) with the actual values and obtain the token specified for the project. For example, if the project name is set to cn-north-4, the obtained token applies to the services in cn-north-4. For details about how to obtain a username, domainname, and project name, see Obtaining the Username, User ID, Project Name, and Project ID.

The scope parameter specifies where a token will take effect. You can set scope to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see Obtaining a User Token.

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

{ 
    "auth": { 
        "identity": { 
            "methods": [ 
                "password" 
            ], 
            "password": { 
                "user": { 
                    "name": "username", //Replace the value with the actual username.
                    "password": "********", //Replace the value with the actual password.
                    "domain": { 
                        "name": "domainname" //Replace the value with the actual account name.
                    } 
                } 
            } 
        }, 
        "scope": { 
            "project": { 
                "name": "xxxxxxxx" //Replace xxxxxxxx with the actual project name. For example, cn-north-4.
            } 
        } 
    } 
}

If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding. In the response to the API used to obtain a user token, x-subject-token is the desired user token. You can use this token to authenticate the calling of other APIs.