This document describes several authorization methods of Serverless Framework and demonstrates actual operations by configuring sub-account permissions.

Prerequisites

Serverless Framework helps you quickly deploy your project to SAC. Before deploying, please make sure that you have registered a Tencent Cloud account and completed identity verification.

Authorization Method

Configuring with permanent key

You can run the sls credentials command to quickly set the persistent storage of the global key information. This command must be configured under the created SLS project. Please make sure that you have created a project with serverless.yml through sls init or manually.

• Below are all the commands:

  serverless credentials   Manage global user authorization information
   set                     Store user authorization information
       --secretId / -i          (Required) Tencent Cloud CAM account's `secretId`
       --secretKey / -k         (Required) Tencent Cloud CAM account's `secretKey`
       --profile / -n {name}    Authorization name, which is `default` by default
       --overwrite / -o         Overwrite the key with an existing authorization name
   remove                  Remove user authorization information
       --profile / -n {name}    (Required) authorization name
   list                    View user authorization information
  

• Configure global authorization information:

  # Configure authorization information through the default profile name
  $ serverless credentials set --secretId xxx --secretKey xxx
  # Configure authorization information through the specified profile name
  $ serverless credentials set --secretId xxx --secretKey xxx --profile profileName1
  # Update the authorization information in the specified profile name
  $ serverless credentials set --secretId xxx --secretKey xxx --profile profileName1 --overwrite
  

• Delete global authorization information:

  $ serverless credentials remove --profile profileName1
  

• View all current authorization information:

  $ serverless credentials list
  

• Deploy through global authorization information:

  # Deploy through the default profile
  $ sls deploy
  # Deploy through the specified profile
  $ sls deploy --profile newP
  # Ignore global variables and scan the QR code for deployment
  $ sls deploy --login
  

Authorizing by scanning code

When deploying by running sls deploy, you can scan the QR code for quick authorization and deployment. After you authorize by scanning the code, temporary key information will be generated (which will expire in 60 minutes) and written into the .env file in the current directory.

TENCENT_APP_ID=xxxxxx     # `AppId` of authorizing account
TENCENT_SECRET_ID=xxxxxx  # `SecretId` of authorizing account
TENCENT_SECRET_KEY=xxxxxx # `SecretKey` of authorizing account
TENCENT_TOKEN=xxxxx       # Temporary token

For more information on the permissions obtained during quick authorization, please see SLS_QcsRole role permission list.

Note：

If your account is a Tencent Cloud sub-account, policy authorization needs to be configured by the root account first. For more information on the configuration, please see Sub-account Permission Configuration.

Authorizing with local key

To eliminate the need for repeated authorization due to information expiration in case of authorization by scanning the code, you can authorize with a key. Create an .env file in the root directory of the project to be deployed and configure the Tencent Cloud SecretId and SecretKey information:

# .env
TENCENT_SECRET_ID=xxxxxxxxxx # `SecretId` of your account
TENCENT_SECRET_KEY=xxxxxxxx # `SecretKey` of your account

You can get SecretId and SecretKey in API Key Management.

Note：

To ensure the account security, we recommend you use a sub-account key for authorization. The sub-account can deploy the project only after being granted the relevant permission. For more information on the configuration, please see Sub-account Permission Configuration.

Sub-account Permission Configuration

Configuration steps

If you use a Tencent Cloud sub-account, it does not have the operation permissions by default; therefore, it needs to be authorized by the root account (or a sub-account with the authorization permission) in the following steps:

1. On the CAM User List page, select the target sub-account and click Authorize.
   

2. Search for and select QcloudSLSFullAccess in the pop-up window and click OK to grant the sub-account the permission to manipulate all Serverless Framework resources.
   

3. On the CAM User List page, select the target sub-account and click the username to enter the user details page.
   

4. Click Associate Policy. On the policy adding page, click Select policies from the policy list > Create Custom Policy.
   Policy association page:
   
   Policy creation page:
   

5. Click Create by Policy Syntax > Blank Template and enter the following content. Be sure to replace the role parameter with the UIN of your root account:

     {
   "version": "2.0",
   "statement": [
       {
           "action": [
               "cam:PassRole"
           ],
           "resource": [
               "qcs::cam::uin/${enter the account's uin}:roleName/SLS_QcsRole"
           ],
           "effect": "allow"
       },
       {
           "resource": [
               "*"
           ],
           "action": [
               "name/sts:AssumeRole"
           ],
           "effect": "allow"
       }
   ]
   }
   

6. After completing the custom policy configuration, go back to the authorization page in step 4, search for the custom policy just created, and click Next > OK to grant the sub-account the operation permissions of SLS_QcsRole. At this point, your sub-account should have a custom policy and a preset policy QcloudSLSFullAccess and can use Serverless Framework normally.
   

   Note：

   In addition to the permission to call the default SLS_QcsRole role, you can also grant the sub-account the permission to call a custom role and control the sub-account permissions with refined permission policies in the custom role. For more information, please see Configuring Role for Specified Operation.

SLS_QcsRole role permission list