Last updated: 2020-07-10 16:17:57

    OAuth 2.0 Overview

    OAuth 2.0 is an open authorization standard that enables you to allow third-party applications to access your specific private resources in a service without providing the account and password to the applications.


    OAuth 2.0 is an authorization protocol rather than an authentication protocol.

    OAuth 2.0 role description

    OAuth 2.0 has the following four roles:

    • Resource owner: owner of resource.
    • Resource server: server where resource is stored.
    • Client: third-party application client, which can be any third-party application that can consume the resource server.
    • Authorization server: intermediate layer that manages the above three roles.

    Authorization process

    (A) The client initiates a request to the resource owner for authorization.
    (B) The resource owner approves authorization.
    (C) The client applies to the authorization server for an authorization token after getting the resource owner's authorization.
    (D) The authorization server grants the authorization token after authenticating the client.
    (E) The client requests the resource server to send the user information after getting the authorization token.
    (F) The resource server sends the user information to the client after verifying that the token is correct.

    API Gateway OAuth 2.0 Operations

    Tencent Cloud API Gateway provides the OAuth 2.0 feature. To quickly try it out, you can use the simplified edition by preparing the following items:

    • Authorization server to distribute the token (currently, demos for Python 3 and Go are provided).
    • API Gateway configuration: create an authorization API and a business API under the same service. The former is used to verify whether the token carried in the request to the latter is valid and provide the link for getting the token.

    Building authorization server

    1. Generate RSA public and private keys and run produce_key.py in Python 3 to generate three files:

      • public_pem: public key in PEM format
      • priv_pem: private key in PEM format
      • pulic: public key in JSON format. The file content is used to configure the authorization API of API Gateway and is in the following format:
    2. Start the service. After installing the bottle library by running pip3 install bottle, run server.py in Python 3.
      Run produce_key.py to generate three files and run server.py to generate a token. Then, you can simply check whether the token is successfully generated.

      curl localhost:8080/token 

    Configuring Tencent Cloud API Gateway authorization API and business API

    Prerequisites: you have created an API Gateway service (for more information, please see Creating Service).

    Configuring Tencent Cloud API Gateway authorization API

    1. Create an authorization API (for more information, please see Creating General API). In the frontend configuration, select OAuth2.0 as the authentication type and authorization API as the OAuth mode.
    2. In the backend configuration, select your own server address as the authentication server, select Header as the token position, and enter the content in the public file generated by running produce_key.py as the public key. After the API is created, click Complete.

    Configuring Tencent Cloud API Gateway business API

    1. Create a business API (for more information, please see Creating General API). In the frontend configuration, select OAuth2.0 as the authentication type, business API as the OAuth mode, and the created authorization API as the associated authorization API.

    2. In the backend configuration, select mock as the backend type and enter hello world as the returned data.


    Get the token first. This sample directly and quickly gets the token from the authorization server.


    To protect the authorization server, you can send a request to the API Gateway authorization API address to get the token.

    • Request the authorization API to get the token:
      curl http://service-cmrrdq86-1251890925.gz.apigw.tencentcs.com:80/token
      Returned result:
    • Request the business API:
      curl http://service-cmrrdq86-1251890925.gz.apigw.tencentcs.com:80/work -H'Authorization:Bearer id_token="eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1OTIyNzk3MTAsImZvbyI6ImJhciIsImlhdCI6MTU5MjI3OTQxMCwianRpIjoiZlBGYlFZRkR4REx3d0lXTFl0aHBBQSIsIm5iZiI6MTU5MjI3OTQxMCwid3VwIjo5MH0.0JQquNRVCQ8n9hPV-mJi6Mku_7G3T1jFp68Sk2AYBijpzzBMQ1KOcREyo9G6QOpvdctynGOAPkL3cwqeTzkFhWgGj633pu_MdLjlectEBMGyVQIv6pL8OBMCHMQzTUTpHWJ_NoUkLpRLKGqZFFcXW8q7v4KeCbf8xHUa9OCH5VF2JxYOnFWDVgucSqao06r0Jaq64LDwKIhLw77ujheKpcBjRrf1kqoIpqk2qhb8CzxM36g_DawMadzKmX49dT-k7auNnI2xUtu5CZdXZ3lSmLeicXfGjc66rrH_acqUqipZRKeeQ5F3Ma467jPQaTeOKiCMHwS2_yp-sXNU2GzxOA"'
      Returned result:
      hello world

    Using authorization code to get token

    In the sample above, no authorization code is used to get the token. To ensure that only specified users can get the token, the authorization code needs to be obtained from the resource owner according to the authorization process. As can be seen in the server.py file, you can first request the authorization code path to get the code and then register the distributed code to verify its validity when getting the token.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback