vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/gaussdb_nosql/api-ref/nosql_05_0009.html
zhangyue 2cbc3d7335 GaussDB_nosql API DOC 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2023-10-13 12:54:25 +00:00

2.5 KiB
Raw Permalink Blame History

Authentication

GaussDB NoSQL supports token-based authentication.

The validity period of a token is 24 hours. If a token is required, the system caches the token to avoid frequent calling.

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

If you want to use a token for authentication, you need to obtain the user's token and add X-Auth-Token to the request header of the service API to make an API call.

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

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

 
POST https://{{Endpoint}}/v3/auth/projects
Content-Type: application/json 
X-Auth-Token: ABCDEFJ....
Parent topic: Calling APIs