How do I configure access credentials for OSS SDK for Python? - Object Storage Service

To use Object Storage Service (OSS) SDK for Python to initiate a request, you must configure access credentials, which are used to verify your identity and access permissions. You can select different types of access credentials based on your authentication and authorization requirements. This topic describes how to configure temporary access credentials, long-term access credentials, and OpenID Connect (OIDC) access credentials.

Prerequisites

OSS SDK for Python is installed. For more information, see Installation.

Access credentials

You can choose from the following types of access credentials:

Temporary access credentials: We recommend that you use temporary access credentials in scenarios that require enhanced security. For example, you can use temporary access credentials to grant applications temporary access to OSS. Temporary access credentials are valid within the specified period of time, which helps prevent credential leaks. Temporary access credentials support fine-grained access control to prevent security risks caused by excessive permissions. For more information, see Use temporary access credentials.
Long-term access credentials: To ensure security, we recommend that you do not use long-term access credentials. For scenarios that require convenience, long-term access credentials eliminate the need for multiple refreshes within a long period of time. We recommend that you change your long-term access credentials every three months to ensure the security of your Alibaba Cloud account. If long-term access credentials are leaked or no longer used, we recommend that you delete or disable the long-term access credentials to reduce security risks. For more information, see Use long-term access credentials.
OIDC access credentials: If you need to deploy untrusted applications to a container cluster, you may want to prevent the applications from accessing the Security Token Service (STS) token of the RAM role for the instance associated with the worker by using a metadata service. In this case, you can use OIDC access credentials. OIDC is an authentication protocol based on OAuth 2.0. OIDC can be used to grant untrusted applications the minimal level of access. OIDC access credentials allow untrusted applications to access STS tokens safely without affecting the security of cloud resources. RAM roles support OIDC-based single sign-on (SSO). For more information, see OIDC access credentials.

Usage notes

This topic describes how to run shell commands to configure environment variables on macOS, Linux, and Windows. If you properly configure environment variables, programs started by command lines can recognize the required configurations. If you start the programs in an integrated development environment (IDE), you may need to refer to this topic to separately configure environment variables in the IDE.

Use temporary access credentials

If you want to use OSS SDK for Python to temporarily access OSS resources, you can use one of the following methods to configure temporary access credentials:

Configure Security Token Service (STS) temporary access credentials: If you want to grant time-limited access to your OSS resource, you need to use temporary access credentials obtained from STS. The temporary access credentials avoid exposing the AccessKey pair of your RAM user, which enhances access security.
Configure a RAM role for a RAM user: If you want to grant a RAM user of your Alibaba Cloud account or a RAM user of another Alibaba Cloud account the permissions to access your OSS resources, you can configure a RAM role for the RAM user to assume.
Configure a RAM role for an Elastic Compute Service (ECS) instance: If you want to access OSS resources from an ECS instance, you can use a RAM role of the ECS instance to access OSS resources. You can attach a RAM role to an ECS instance to access OSS resources from the instance by using temporary access credentials that are obtained from STS. STS temporary access credentials are automatically generated and updated. Applications can obtain STS temporary access credentials by using the instance metadata URL.

Configure STS temporary access credentials

Create a RAM user.
For more information, see Create a RAM user.
Attach the AliyunSTSAssumeRoleAccess policy to the RAM user.
For more information, see Grant permissions to a RAM user.
Use the RAM user to call the AssumeRole operation of STS to obtain temporary access credentials.
For more information, see AssumeRole.

Configure the temporary access credentials provided by STS.

Environment variables

Configure environment variables to store the access credentials.

macOS

Open the terminal.
Run the following command:
```
nano ~/.bash_profile
```

Add the temporary access credentials (AccessKey ID, AccessKey secret, and security token) obtained from STS to the end of the file.

export OSS_ACCESS_KEY_ID=STS.NV5ZCwphFSXqscqUHAKbH****
export OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn**** 
export OSS_SESSION_TOKEN=CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVt****

Press Ctrl+X, press Y to save the file, and then press Enter to close the file.
Run the following command to apply the changes:
```
source ~/.bash_profile
```

Run the following command to verify environment variable configurations:

echo $OSS_ACCESS_KEY_ID
echo $OSS_ACCESS_KEY_SECRET
echo $OSS_SESSION_TOKEN

Sample success response:

STS.NV5ZCwphFSXqscqUHAKbH****
IrVTNZNy5yQelTETg0cZML3TQn**** 
CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVt****

Linux

Open the terminal.
Run the following command:
```
sudo vim /etc/profile
```

Press i to enter the edit mode. Add the temporary access credentials (AccessKey ID, AccessKey secret, and security token) to the end of the file.

export OSS_ACCESS_KEY_ID=STS.NV5ZCwphFSXqscqUHAKbH****
export OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn****
export OSS_SESSION_TOKEN=CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVt****

Press Esc to exit the edit mode. Then, enter :wq and press Enter to save and close the file.
Run the following command to apply the changes:
```
source /etc/profile
```

Run the following command to verify environment variable configurations:

echo $OSS_ACCESS_KEY_ID
echo $OSS_ACCESS_KEY_SECRET
echo $OSS_SESSION_TOKEN

Sample success response:

STS.NV5ZCwphFSXqscqUHAKbH****
IrVTNZNy5yQelTETg0cZML3TQn**** 
CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVt****

Windows

Open the CLI.

Run the following command to configure environment variables for the temporary access credentials (AccessKey ID, AccessKey secret, and security token):

set OSS_ACCESS_KEY_ID=STS.NV5ZCwphFSXqscqUHAKbH****
set OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn****
set OSS_SESSION_TOKEN=CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVt****

Run the following command to apply the changes:

setx OSS_ACCESS_KEY_ID "%OSS_ACCESS_KEY_ID%"
setx OSS_ACCESS_KEY_SECRET "%OSS_ACCESS_KEY_SECRET%"
setx OSS_SESSION_TOKEN "%OSS_SESSION_TOKEN%"

Run the following command to verify environment variable configurations:

echo %OSS_ACCESS_KEY_ID%
echo %OSS_ACCESS_KEY_SECRET%
echo %OSS_SESSION_TOKEN%

Sample success response:

STS.NV5ZCwphFSXqscqUHAKbH****
IrVTNZNy5yQelTETg0cZML3TQn**** 
CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVt****

Obtain the temporary access credentials from the environment variables.

# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider

# Use the temporary AccessKey pair and security token that are obtained from the environment variables. 
auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())

Embedded access credentials

Warning

Security issues may occur if you embed access credentials in code. Leaked access credentials can be used by attackers to access your resources, which causes data breaches. To ensure security, we recommend that you use more secure methods, such as obtaining temporary access credentials from environment variables.

# -*- coding: utf-8 -*-
import oss2

# Specify the temporary AccessKey pair obtained from STS. The AccessKey pair consists of an AccessKey ID and an AccessKey secret. 
sts_access_key_id = 'OSS_ACCESS_KEY_ID'
sts_access_key_secret = 'OSS_ACCESS_KEY_SECRET'
# Specify the security token obtained from STS. 
security_token = 'OSS_SESSION_TOKEN'
# Initialize the StsAuth instance based on the authentication information in the temporary access credentials. 
auth = oss2.StsAuth(sts_access_key_id,
                    sts_access_key_secret,
                    security_token)

Configure a RAM role for a RAM user

Run the following command to install alibabacloud_credentials:
```
pip install alibabacloud_credentials
```
Obtain the AccessKey pair of a RAM user.
For more information, see Create an AccessKey pair for a RAM user.
Important
To reduce the risk that the AccessKey pair of a RAM user is leaked, we recommend that you rotate an AccessKey pair that is used for more than three months. We recommend that you disable and delete the AccessKey pair of a RAM user that is not used for a long period of time.
Obtain RamRoleArn of the RAM role.
Note
RamRoleArn is the Alibaba Cloud Resource Name (ARN) of the RAM role. The ARN is in the format of acs:ram::$accountID:role/$roleName, where $accountID is the ID of the Alibaba Cloud account and $roleName is the name of the RAM role.
For more information, see View the information about a RAM role.

Configure the AccessKey pair of the RAM user and the ARN of the RAM role as the temporary access credentials.

Environment variables

Configure environment variables for the AccessKey pair of the RAM user and the ARN of the RAM role.

macOS

Open the terminal.
Run the following command:
```
nano ~/.bash_profile
```

Add the AccessKey pair of the RAM user and the ARN of the RAM role to the end of the file.

export OSS_ACCESS_KEY_ID=LTAI4GDty8ab9W4Y1D****
export OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn****  
export OSS_STS_ROLE_ARN=acs:ram::17464958********:role/ossststest

Press Ctrl+X, press Y to save the file, and then press Enter to close the file.
Run the following command to apply the changes:
```
source /etc/profile
```

Run the following command to verify environment variable configurations:

echo $OSS_ACCESS_KEY_ID
echo $OSS_ACCESS_KEY_SECRET
echo $OSS_STS_ROLE_ARN

Sample success response:

LTAI4GDty8ab9W4Y1D****
IrVTNZNy5yQelTETg0cZML3TQn****  
acs:ram::17464958********:role/ossststest

Linux

Open the terminal.
Run the following command:
```
sudo vim /etc/profile
```

Press i to enter the edit mode. Add the AccessKey pair of the RAM user and ARN of the RAM role to the end of the file.

export OSS_ACCESS_KEY_ID=LTAI4GDty8ab9W4Y1D****
export OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn****  
export OSS_STS_ROLE_ARN=acs:ram::17464958********:role/ossststest

Press Esc to exit the edit mode. Then, enter :wq and press Enter to save and close the file.
Run the following command to apply the changes:
```
source /etc/profile
```

Run the following command to verify environment variable configurations:

echo $OSS_ACCESS_KEY_ID
echo $OSS_ACCESS_KEY_SECRET
echo $OSS_STS_ROLE_ARN

Sample success response:

LTAI4GDty8ab9W4Y1D****
IrVTNZNy5yQelTETg0cZML3TQn****  
acs:ram::17464958********:role/ossststest

Windows

Open the CLI.

Run the following command to configure environment variables for the AccessKey pair of the RAM user and the ARN of the RAM role:

set OSS_ACCESS_KEY_ID=LTAI4GDty8ab9W4Y1D****
set OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn****  
set OSS_STS_ROLE_ARN=acs:ram::17464958********:role/ossststest

Run the following command to apply the changes:

setx OSS_ACCESS_KEY_ID "%OSS_ACCESS_KEY_ID%"
setx OSS_ACCESS_KEY_SECRET "%OSS_ACCESS_KEY_SECRET%"
setx OSS_STS_ROLE_ARN "%OSS_STS_ROLE_ARN%"

Run the following command to verify environment variable configurations:

echo %OSS_ACCESS_KEY_ID%
echo %OSS_ACCESS_KEY_SECRET%
echo %OSS_STS_ROLE_ARN%

Sample success response:

LTAI4GDty8ab9W4Y1D****
IrVTNZNy5yQelTETg0cZML3TQn****  
acs:ram::17464958********:role/ossststest

Obtain the AccessKey pair of the RAM user and the ARN of the RAM role from the environment variables.

# -*- coding: utf-8 -*-
import oss2
from alibabacloud_credentials.client import Client
from alibabacloud_credentials.models import Config
from oss2 import CredentialsProvider
from oss2.credentials import Credentials
import os


class CredentialProviderWarpper(CredentialsProvider):
    def __init__(self, client):
        self.client = client

    def get_credentials(self):
        access_key_id = self.client.get_access_key_id()
        access_key_secret = self.client.get_access_key_secret()
        security_token = self.client.get_security_token()
        return Credentials(access_key_id, access_key_secret, security_token)


config = Config(
    type='ram_role_arn',
    # Obtain the AccessKey pair of the RAM user from the environment variables. The AccessKey pair consists of an AccessKey ID and an AccessKey secret. 
    access_key_id=os.getenv('OSS_ACCESS_KEY_ID'),
    access_key_secret=os.getenv('OSS_ACCESS_KEY_SECRET'),
    # Obtain ARN of the RAM role from the environment variable. 
    role_arn=os.getenv('OSS_STS_ROLE_ARN'),
    # Specify the session name of the RAM role. 
    role_session_name='roleSessionName'
)

cred = Client(config)

credentials_provider = CredentialProviderWarpper(cred)

# Configure access credentials by using the AccessKey pair of the RAM user and ARN of the RAM role obtained from environment variables. 
auth = oss2.ProviderAuth(credentials_provider)

Embedded access credentials

Warning

# -*- coding: utf-8 -*-
import oss2
from alibabacloud_credentials.client import Client
from alibabacloud_credentials.models import Config
from oss2 import CredentialsProvider
from oss2.credentials import Credentials


class CredentialProviderWarpper(CredentialsProvider):
    def __init__(self, client):
        self.client = client

    def get_credentials(self):
        access_key_id = self.client.get_access_key_id()
        access_key_secret = self.client.get_access_key_secret()
        security_token = self.client.get_security_token()
        return Credentials(access_key_id, access_key_secret, security_token)


config = Config(
    type='ram_role_arn',
    # Specify the AccessKey pair of the RAM user. The AccessKey pair consists of an AccessKey ID and an AccessKey secret. 
    access_key_id='OSS_ACCESS_KEY_ID',
    access_key_secret='OSS_ACCESS_KEY_SECRET',
    # Specify the ARN of the RAM role. 
    role_arn='OSS_STS_ROLE_ARN',
    # Specify the session name of the RAM role. 
    role_session_name='roleSessionName'
)

cred = Client(config)

credentials_provider = CredentialProviderWarpper(cred)

# Configure access credentials by using the AccessKey pair of the RAM user and ARN of the RAM role obtained from environment variables. 
auth = oss2.ProviderAuth(credentials_provider)

Configure a RAM role for an ECS instance

Run the following command to install alibabacloud_credentials:
```
pip install alibabacloud_credentials
```
Attach a RAM role to an ECS instance.
For more information, see Attach an instance RAM role to an ECS instance.

Configure temporary access credentials by using the RAM role for the ECS instance.

# -*- coding: utf-8 -*-
import oss2
from alibabacloud_credentials.client import Client
from alibabacloud_credentials.models import Config
from oss2 import CredentialsProvider
from oss2.credentials import Credentials
import os


class CredentialProviderWarpper(CredentialsProvider):
    def __init__(self, client):
        self.client = client

    def get_credentials(self):
        access_key_id = self.client.get_access_key_id()
        access_key_secret = self.client.get_access_key_secret()
        security_token = self.client.get_security_token()
        return Credentials(access_key_id, access_key_secret, security_token)


config = Config(
    type='ecs_ram_role',      # Specify the credential type. Set the value to ecs_ram_role. 
    role_name='ECSRAMRole'    # Specify the name of the RAM role that is attached to the ECS instance. The RAM role name is optional. If you do not configure this parameter, the system automatically searches for a RAM role. We recommended that you configure this parameter to reduce the number of requests. 
)

cred = Client(config)

credentials_provider = CredentialProviderWarpper(cred)

# Configure access credentials by using the AccessKey pair of the RAM user and ARN of the RAM role obtained from environment variables. 
auth = oss2.ProviderAuth(credentials_provider)

Use long-term access credentials

If you want to regularly use OSS SDK for Python to access OSS resources for an application or service, you can provide long-term access credentials that consist of the AccessKey ID and AccessKey secret of a RAM user.

Configure the AccessKey pair of a RAM user

Obtain the AccessKey pair of the RAM user.
For more information, see Create an AccessKey pair for a RAM user.
Important
We recommend that you rotate the AccessKey pair of a RAM user that is used for more than three months. We recommend that you disable and delete the AccessKey pair of a RAM user that is not used for a long period of time. This reduces the risk of AccessKey pair leaks.
Configure the AccessKey pair of the RAM user.
Environment variables
1. Run the following command to configure environment variables:
  macOS
  Open the terminal.
  Run the following command:
  nano ~/.bash_profile
  Add the AccessKey pair of the RAM user to the end of the file.
  export OSS_ACCESS_KEY_ID=LTAI4GDty8ab9W4Y1D**** export OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn****
  Press Ctrl+X, press Y to save the file, and then press Enter to close the file.
  Run the following command to apply the changes:
  source ~/.bash_profile
  Run the following command to verify environment variable configurations:
  echo $OSS_ACCESS_KEY_ID echo $OSS_ACCESS_KEY_SECRET
  Sample success response:
  LTAI4GDty8ab9W4Y1D**** IrVTNZNy5yQelTETg0cZML3TQn****
  Linux
  Open the terminal.
  Run the following command:
  sudo vim /etc/profile
  Press i to enter the edit mode. Add the AccessKey pair of the RAM user to the end of the file.
  export OSS_ACCESS_KEY_ID=LTAI4GDty8ab9W4Y1D**** export OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn****
  Press Esc to exit the edit mode. Then, enter :wq and press Enter to save and close the file.
  Run the following command to apply the changes:
  source /etc/profile
  Run the following command to verify environment variable configurations:
  echo $OSS_ACCESS_KEY_ID echo $OSS_ACCESS_KEY_SECRET
  Sample success response:
  LTAI4GDty8ab9W4Y1D**** IrVTNZNy5yQelTETg0cZML3TQn****
  Windows
  Open the CLI.
  Run the following command to configure the environment variables for the AccessKey pair:
  set OSS_ACCESS_KEY_ID=LTAI4GDty8ab9W4Y1D**** set OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn****
  Run the following command to apply the changes:
  setx OSS_ACCESS_KEY_ID "%OSS_ACCESS_KEY_ID%" setx OSS_ACCESS_KEY_SECRET "%OSS_ACCESS_KEY_SECRET%"
  Run the following command to verify environment variable configurations:
  echo %OSS_ACCESS_KEY_ID% echo %OSS_ACCESS_KEY_SECRET%
  Sample success response:
  LTAI4GDty8ab9W4Y1D**** IrVTNZNy5yQelTETg0cZML3TQn****
2. Obtain the AccessKey pair of the RAM user from the environment variables.
```
# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider

# Obtain the access credentials from the environment variables. 
auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
```
Embedded access credentials
Warning
Security issues may occur if you embed access credentials in code. Leaked access credentials can be used by attackers to access your resources, which causes data breaches. To ensure security, we recommend that you use more secure methods, such as obtaining access credentials from environment variables.
```
# -*- coding: utf-8 -*-
import oss2

# Specify the AccessKey pair of the RAM user. The AccessKey pair consists of an AccessKey ID and an AccessKey secret. 
accessKeyId = 'yourAccessKeyId'
accessKeySecret = 'yourAccessKeySecret'
# Configure access credentials by using the embedded AccessKey pair of the RAM user. 
auth = oss2.Auth(accessKeyId, accessKeySecret)
```

OIDC access credentials

For more information about OIDC role-based SSO, see Overview.

If you want to use OIDC access credentials for your application or service to access OSS, use the following steps to configure OIDC access credentials first.

Run the following command to install alibabacloud_credentials:
```
pip install alibabacloud_credentials
```

Create an OIDC IdP and a RAM role for the OIDC IdP. For more information, see Create a RAM role for a trusted IdP and Grant permissions to a RAM role.

Use the RAM role to provide access credentials. The following sample code creates an OSSClient instance that can be used to access OSS by using OIDC access credentials:

# -*- coding: utf-8 -*-
import oss2
from alibabacloud_credentials.client import Client
from alibabacloud_credentials.models import Config
from oss2 import CredentialsProvider
from oss2.credentials import Credentials
import os


class OIDCRoleArnCredentialDemo(CredentialsProvider):
    def __init__(self, client):
        self.client = client

    def get_credentials(self):
        access_key_id = self.client.get_access_key_id()
        access_key_secret = self.client.get_access_key_secret()
        security_token = self.client.get_security_token()
        return Credentials(access_key_id, access_key_secret, security_token)


config = Config(
    # Specify the credential type. Set the credential type to oidc_role_arn. 
    type='oidc_role_arn',
    # Specify the AccessKey ID. 
    access_key_id=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID'),
    # Specify the AccessKey secret. 
    access_key_secret=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
    # Specify the security token. 
    security_token=os.environ.get('ALIBABA_CLOUD_SECURITY_TOKEN'),
    # Specify the ARN of the RAM role to assume. 
    role_arn=os.environ.get('ALIBABA_CLOUD_ROLE_ARN'),
    # Specify the ARN of the OIDC IdP. 
    oidc_provider_arn=os.environ.get('ALIBABA_CLOUD_OIDC_PROVIDER_ARN'),
    # Specify the file path of the OIDC token. 
    oidc_token_file_path=os.environ.get('ALIBABA_CLOUD_OIDC_TOKEN_FILE'),
    # Specify the name of the role session.
    role_session_name='<RoleSessionName>',
    # (Optional) Specify limited permissions for the RAM role. Example: {"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"}.
    policy='<Policy>',
    # Specify the validity period of the session.
    role_session_expiration=3600
)
cred = Client(config)

credentials_provider = OIDCRoleArnCredentialDemo(cred)
auth = oss2.ProviderAuth(credentials_provider)

What to do next

After you configure the access credentials, you can initialize an OSSClient instance. For more information, see Initialization.