Access Key

Last updated: 2020-03-04 16:26:05

PDF

Introduction

This document describes how to create, enable/disable, delete, and view API keys for sub-users and collaborators.

Prerequisites

Log in to the CAM Console and go to User List. Find the sub-user or collaborator that needs to be configured and click Username to enter the user details page.

Directions

Creating sub-user/collaborator API keys

You can create an API key for a sub-user/collaborator. After the API key is created, the sub-user/collaborator can use APIs, SDKs, or other developer tools to manage the resources under the root account within the scope of the configured permissions.

  1. On the user details page, click API Key to enter the API Key Management page.
  2. On the API key management page, click Create Key.
    • Each sub-user/collaborator can have at most two API keys.
    • An API key is an important credential for creating TencentCloud API requests. For the security of your assets and services, please keep the keys private, change them regularly, and delete old keys promptly after creating new ones.

Viewing sub-user/collaborator API keys

You can view and copy the SecretId and SecretKey information of a sub-user/collaborator API key. The sub-user/collaborator can use the SecretId and SecretKey to use APIs, SDKs, or other developer tools to manage resources under the root account within the scope of the configured permissions.

  1. On the user details page, click API Key to enter the API Key Management page.
  2. On the API key management page, perform the following operations to view and copy the SecretId and SecretKey information of the API key. An API key is an important credential for creating TencentCloud API requests. For the security of your assets and services, please keep the keys private, change them regularly, and delete old keys promptly after creating new ones.
    • SecretId: this can be directly viewed in the Key column. Click to copy and save it.
    • SecretKey: click Show in the Key column. You will be able to view after completing identity verification. Click to copy and save it.

Viewing current sub-user/collaborator API keys

Users who have QcloudCollApiKeyReadOnlyAccess policy permissions can view and copy the SecretId and SecretKey information of the API key of the current account. They can use the SecretId and SecretKey to use APIs, SDKs, or other developer tools to manage resources under the root account within the scope of the configured permissions.

  1. Enter the API Key Management page. You can directly view and copy the SecretId from the Key column.
  2. Click Show in the Key column. You will be able to get and copy the SecretKey after completing identity verification.

Disabling/enabling sub-user/collaborator API keys

You can disable the API keys of sub-users and collaborators. Do note that Tencent Cloud will block all requests that use the API key after it is disabled.

  1. On the user details page, click API Key to enter the API Key Management page.
  2. On the API key management page, click Disable in the Operation column.
  3. In the confirmation window that pops up, click Confirm to disable the access key.

    You can click Enable in the Operation column to enable the key. After the key is enabled, the sub-user/collaborator can use APIs, SDKs, or other developer tools to manage the resources under the root account within the scope of the configured permissions.

Deleting sub-user/collaborator API keys

  1. On the user details page, click API Key to enter the API Key Management page.
  2. On the API key management page, click Disable in the Operation column. If the API key that you want to delete has already been disabled, proceed to step 4.
  3. In the confirmation window that pops up, click Confirm.
  4. On the API key management page, click Delete in the Operation column to delete the API key.

    Please note that an API key cannot be recovered once deleted.

Relevant Documents

For more information on how to use the SecretId of an access key to query sub-account information, please see Querying Sub-User Information and Querying Collaborator Information.