Authentication

Updated on 2025-05-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 tokens.
AK/SK-based authentication: Requests are encrypted using AK/SK pairs.

Token-based Authentication

[Example]

NOTE:

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

Ensure that the token is valid when you use it. Using a token that will soon expire may cause API calling failures.

A token specifies permissions in a computer system. During token-based authentication, the token is added to requests to get permissions for calling the API.

When calling the API for obtaining a user token, 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 obtaining the token, add the X-Auth-Token header in a request to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., add X-Auth-Token: ABCDEFJ.... to the request as follows:

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

AK/SK-based Authentication

[Example]

NOTE:

AK/SK-based authentication supports API requests with a body not larger than 12 MB. For API requests with a larger body, token-based authentication is recommended.

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 with a secret access key to sign requests cryptographically.
SK: secret access key, which is used 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 requests based on the signature algorithm or using the signing SDK to sign requests.

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