Authentication

Code Ocean uses Access Tokens to authenticate requests. You can view and manage your access tokens from within your Dashboard under Access Tokens.

To create an Access Token

1. Sign in to Code Ocean.

2. Click Account.

3. Click Access Tokens.

4. Click Generate New Token.

5. Provide the Token Name.

6. Select Scopes allows you to select permissions for each resource.

7. Click Add Token.

8. Click Copy to copy the Token, or click Copy Token & Create Secret to copy the token and store it as a secret in your Code Ocean account.

9. Click Save Changes.

The access token only shows when it is created, so be sure to copy it or click Copy Token & Create Secret to copy the token and store it as a secret in your Code Ocean account.

You will not be able to access it again.

By adding the access token as a secret in your Code Ocean account, it will be easily accessible in a Capsule. See the Accessing a Secret in a Capsule page for more information.

To view an Access Token

1. Navigate to Account.

2. Click Access Tokens and a list of Access Tokens will be shown.

To delete an Access Token

1. Next to the Token, click the garbage can .

   
2. Click Delete.

Using an access token in API requests

cURL

The API uses HTTP Basic Authentication. Pass your access token as the username with an empty password.

curl https://{domain}/api/v1/capsules/4bc97533-6eb4-48ac-966f-648548a756d2 \
  -u "cop_xxxxxxxxxx:"

The resulting Authorization header:

Authorization: Basic {encoded-token}

Python SDK

Use your access token when creating a CodeOcean client. The Python library will then automatically send this key in each request.

$ pip install codeocean

from codeocean import CodeOcean

client = CodeOcean(domain="https://{domain}", token="cop_xxxxxxxxxx")