Token-based Authentication

The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.

A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to obtain permissions for calling the API.

When calling the API to obtain a user token, you must set auth.scope in the request body to project. In the following code block, username indicates the username; domainname indicates the account name; ******** indicates the user login password; and xxxxxxxx indicates the project name. When xxxxxxxx is set, the token of a specified project will be obtained. For example, if xxxxxxxx is set to cn-north-4, the token of cn-north-4 will be obtained. For details about how to obtain the username, domain name, and project name, see Obtaining the Username, User ID, Project Name, and Project ID.

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

After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:

POST https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/id-card 
Content-Type: application/json 
X-Auth-Token: ABCDEFJ....

AK/SK-based Authentication

AK/SK-based authentication supports API requests with a body less than or equal to 12 MB. For API requests with a larger body, perform token-based authentication.

In AK/SK-based authentication, AK/SK is used to sign requests and the signature is then added to the requests for authentication.

• AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.
• SK: secret access key used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.

In AK/SK-based authentication, you can use an AK/SK to sign a request based on the signature algorithm or use a dedicated signature SDK to sign a request. For details about how to sign requests and use the signing SDK, see API Request Signing Guide.

If no AK/SK has been generated, access the My Credentials page, and choose Access Keys > Create Access Key to obtain the access keys.

The signing SDK is only used for signing requests and is different from the SDKs provided by services.

For details about how to obtain the AK/SK, see Obtaining the AK/SK.