English | 简体ä¸ć–‡
npm install @alicloud/credentialsNode.js >= 12 required.
Before you begin, you need to sign up for an Alibaba Cloud account and retrieve your Credentials.
Setup access_key credential through User Information Management, it have full authority over the account, please keep it safe. Sometimes for security reasons, you cannot hand over a primary account AccessKey with full access to the developer of a project. You may create a sub-account RAM Sub-account , grant its authorization，and use the AccessKey of RAM Sub-account.
import Credential, { Config } from '@alicloud/credentials'; const config: Config = { type: 'access_key', // credential type accessKeyId: 'accessKeyId', // AccessKeyId of your account accessKeySecret: 'accessKeySecret', // AccessKeySecret of your account } const cred = new Credential(config); const { accessKeyId, accessKeySecret, type } = await cred.getCredential();Create a temporary security credential by applying Temporary Security Credentials (TSC) through the Security Token Service (STS).
import Credential, { Config } from '@alicloud/credentials'; const config: Config = { type: 'sts', // credential type accessKeyId: 'accessKeyId', // AccessKeyId of your account accessKeySecret: 'accessKeySecret', // AccessKeySecret of your account securityToken: 'securityToken', // Temporary Security Token } const cred = new Credential(config); const { accessKeyId, accessKeySecret, securityToken, type } = await cred.getCredential();By specifying RAM Role, the credential will be able to automatically request maintenance of STS Token. If you want to limit the permissions(How to make a policy) of STS Token, you can assign value for Policy.
import Credential, { Config } from '@alicloud/credentials'; const config: Config = { type: 'ram_role_arn', // credential type accessKeyId: 'accessKeyId', // AccessKeyId of your account accessKeySecret: 'accessKeySecret', // AccessKeySecret of your account roleArn: 'roleArn', // Format: acs:ram::USER_ID:role/ROLE_NAME roleSessionName: 'roleSessionName', // Role Session Name policy: 'policy', // Not required, limit the permissions of STS Token roleSessionExpiration: 3600, // Not required, limit the Valid time of STS Token } const cred = new Credential(config); const { accessKeyId, accessKeySecret, securityToken, type } = await cred.getCredential();By specifying OIDC Role, the credential will be able to automatically request maintenance of STS Token. If you want to limit the permissions(How to make a policy) of STS Token, you can assign value for Policy.
import Credential, { Config } from '@alicloud/credentials'; const config: Config = { type: 'oidc_role_arn', // credential type roleArn: 'roleArn', // Format: acs:ram::USER_Id:role/ROLE_NAME roleArn can be replaced by setting environment variable: ALIBABA_CLOUD_ROLE_ARN oidcProviderArn: 'oidcProviderArn', // Format: acs:ram::USER_Id:oidc-provider/ROLE_NAME oidcProviderArn can be replaced by setting environment variable: ALIBABA_CLOUD_OIDC_PROVIDER_ARN oidcTokenFilePath: '/Users/xxx/xxx', // Format: path OIDCTokenFilePath can be replaced by setting environment variable: ALIBABA_CLOUD_OIDC_TOKEN_FILE roleSessionName: 'roleSessionName', // Role Session Name policy: 'policy', // Not required, limit the permissions of STS Token roleSessionExpiration: 3600, // Not required, limit the Valid time of STS Token } const cred = new Credential(config); const { accessKeyId, accessKeySecret, securityToken, type } = await cred.getCredential();By specifying the role name, the credential will be able to automatically request maintenance of STS Token.
import Credential, { Config } from '@alicloud/credentials'; const config: Config = { type: 'ecs_ram_role', // credential type roleName: 'roleName', // `roleName` is optional. It will be retrieved automatically if not set. It is highly recommended to set it up to reduce requests. disableIMDSv1: true, // `disableIMDSv1` is optional and is recommended to be turned on. It can be replaced by setting environment variable: ALIBABA_CLOUD_IMDSV1_DISABLED } const cred = new Credential(config); const { accessKeyId, accessKeySecret, securityToken, type } = await cred.getCredential();By specifying the public key ID and the private key file, the credential will be able to automatically request maintenance of the AccessKey before sending the request. Only Japan station is supported.
import Credential, { Config } from '@alicloud/credentials'; const config: Config = { type: 'rsa_key_pair', // credential type privateKeyFile: 'privateKeyFile', // The file path to store the PrivateKey publicKeyId: 'publicKeyId', // PublicKeyId of your account } const cred = new Credential(config); const { accessKeyId, accessKeySecret, securityToken, type } = await cred.getCredential();By specifying a local or remote URI to get credentials and refresh automanticly.
import Credential, { Config } from '@alicloud/credentials'; const config: Config = { type: 'credentials_uri', credentialsURI: 'http://a_local_or_remote_address/' //credentialsURI can be replaced by setting environment variable: ALIBABA_CLOUD_CREDENTIALS_URI }; const cred = new Credential(config); const { accessKeyId, accessKeySecret, securityToken, type } = await cred.getCredential();The URI must reponse meets following conditions:
- response status code is 200
- response body struct must be:
{ "Code": "Success", "AccessKeySecret": "AccessKeySecret", "AccessKeyId": "AccessKeyId", "Expiration": "2021-09-26T03:46:38Z", "SecurityToken": "SecurityToken" }If credential is required by the Cloud Call Centre (CCC), please apply for Bearer Token maintenance by yourself.
import Credential, { Config } from '@alicloud/credentials'; const config: Config = { type: 'bearer', // credential type bearerToken: 'bearerToken', // BearerToken of your account } const cred = new Credential(config); let bearerToken: string = await cred.getBearerToken(); let type: string = cred.getType();If you call new Credential() with empty, it will use provider chain to get credential for you.
The program first looks for environment credentials in the environment variable. If the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables are defined and are not empty, the program will use them to create the default credential. If not, the program loads and looks for the client in the configuration file.
If there is ~/.alibabacloud/credentials default file (Windows shows C:\Users\USER_NAME\.alibabacloud\credentials), the program will automatically create credential with the name of 'default'. The default file may not exist, but a parse error throws an exception. The specified files can also be loaded indefinitely: AlibabaCloud::load('/data/credentials', 'vfs://AlibabaCloud/credentials', ...); This configuration file can be shared between different projects and between different tools. Because it is outside the project and will not be accidentally committed to the version control. Environment variables can be used on Windows to refer to the home directory %UserProfile%. Unix-like systems can use the environment variable $HOME or ~ (tilde). The path to the default file can be modified by defining the ALIBABA_CLOUD_CREDENTIALS_FILE environment variable.
[default] # Default credential type = access_key # Certification type: access_key access_key_id = foo # access key id access_key_secret = bar # access key secretIf the environment variable ALIBABA_CLOUD_ECS_METADATA is defined and not empty, the program will take the value of the environment variable as the role name and request http://100.100.100.200/latest/meta-data/ram/security-credentials/ to get the temporary Security credential.
If the environment variable ALIBABA_CLOUD_CREDENTIALS_URI is defined and not empty, the program will take the value of the environment variable as the credentials uri.
- run test
npm run test- run code coverage
npm run covCopyright (c) 2009-present, Alibaba Cloud All rights reserved.