Authentication

Updated on 2023-12-28 GMT+08:00

View PDF

Requests for calling an API can be authenticated using either of the following methods:

Token-based authentication: Requests are authenticated using a token.
AK/SK-based authentication: Requests are authenticated by encrypting the request body using an AK/SK pair.

Token-based Authentication

NOTE:

The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the Identity and Access Management (IAM) API for obtaining 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 get permissions for calling the API.

In Making an API Request, the process of calling the API used to obtain a user token is described.

When calling the API to obtain a user token, you must set auth.scope in the request body to project.

{ 
     "auth": { 
         "identity": { 
             "methods": [ 
                 "password" 
             ], 
             "password": { 
                 "user": { 
                     "name": "username", 
                     "password": "********", 
                     "domain": { 
                         "name": "domainname" 
                     } 
                 } 
             } 
         }, 
         "scope": {
             "project": {
                 "name": "xxxxxxxx"
             }
         }
     } 
 }

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

GET https://iam.ap-southeast-3.myhuaweicloud.com/v3/auth/projects

Content-Type: application/json 
X-Auth-Token: ABCDEFJ....

AK/SK-based Authentication

NOTE:

AK/SK authentication supports API requests with a body no larger than 12 MB. For API requests with a larger body, use token authentication.

AK/SK-based authentication uses AK/SK to sign requests, and the signature is then added to request headers for authentication.

AK: access key ID. It is a unique ID associated with an SK. AK is used together with SK to sign requests.
SK: secret access key. It is used together with an access key ID to identify a sender who initiates a request and to cryptographically sign requests, preventing the request from being modified.

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

NOTICE:

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

Parent topic: Calling APIs

Previous topic: Making an API Request

Next topic: Response

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot