# Credentials

> Credentials - Creates credentials for an external OAuth provider.

This Markdown file sits beside the HTML page at the same path (with a `.md` suffix). It summarizes the topic and lists links for tools and LLM context.

Companion generated at `2026-05-06T18:17:09.822496+00:00` (UTC).

## Primary page

- [Credentials](https://docs.datarobot.com/en/docs/api/reference/sdk/credentials.html): Full documentation for this topic (HTML).

## Sections on this page

- [classdatarobot.models.Credential](https://docs.datarobot.com/en/docs/api/reference/sdk/credentials.html#datarobot.models.Credential): In-page section heading.
- [classmethodlist()](https://docs.datarobot.com/en/docs/api/reference/sdk/credentials.html#datarobot.models.Credential.list): In-page section heading.
- [classmethodget(credential_id)](https://docs.datarobot.com/en/docs/api/reference/sdk/credentials.html#datarobot.models.Credential.get): In-page section heading.
- [delete()](https://docs.datarobot.com/en/docs/api/reference/sdk/credentials.html#datarobot.models.Credential.delete): In-page section heading.
- [classmethodcreate_basic(name, user, password, description=None)](https://docs.datarobot.com/en/docs/api/reference/sdk/credentials.html#datarobot.models.Credential.create_basic): In-page section heading.
- [classmethodcreate_oauth(name, token, refresh_token, description=None)](https://docs.datarobot.com/en/docs/api/reference/sdk/credentials.html#datarobot.models.Credential.create_oauth): In-page section heading.
- [classmethodcreate_s3(name, aws_access_key_id=None, aws_secret_access_key=None, aws_session_token=None, config_id=None, description=None)](https://docs.datarobot.com/en/docs/api/reference/sdk/credentials.html#datarobot.models.Credential.create_s3): In-page section heading.
- [classmethodcreate_azure(name, azure_connection_string, description=None)](https://docs.datarobot.com/en/docs/api/reference/sdk/credentials.html#datarobot.models.Credential.create_azure): In-page section heading.
- [classmethodcreate_snowflake_key_pair(name, user=None, private_key=None, passphrase=None, config_id=None, description=None)](https://docs.datarobot.com/en/docs/api/reference/sdk/credentials.html#datarobot.models.Credential.create_snowflake_key_pair): In-page section heading.
- [classmethodcreate_databricks_access_token(name, databricks_access_token, description=None)](https://docs.datarobot.com/en/docs/api/reference/sdk/credentials.html#datarobot.models.Credential.create_databricks_access_token): In-page section heading.
- [classmethodcreate_databricks_service_principal(name, client_id=None, client_secret=None, config_id=None, description=None)](https://docs.datarobot.com/en/docs/api/reference/sdk/credentials.html#datarobot.models.Credential.create_databricks_service_principal): In-page section heading.
- [classmethodcreate_azure_service_principal(name, client_id=None, client_secret=None, azure_tenant_id=None, config_id=None, description=None)](https://docs.datarobot.com/en/docs/api/reference/sdk/credentials.html#datarobot.models.Credential.create_azure_service_principal): In-page section heading.
- [classmethodcreate_adls_oauth(name, client_id=None, client_secret=None, oauth_scopes=None, config_id=None, description=None)](https://docs.datarobot.com/en/docs/api/reference/sdk/credentials.html#datarobot.models.Credential.create_adls_oauth): In-page section heading.
- [classmethodcreate_external_oauth_provider(name, authentication_id, description=None)](https://docs.datarobot.com/en/docs/api/reference/sdk/credentials.html#datarobot.models.Credential.create_external_oauth_provider): In-page section heading.
- [classmethodcreate_box_jwt(name, client_id, client_secret, enterprise_id, public_key_id, private_key_str, passphrase, description=None)](https://docs.datarobot.com/en/docs/api/reference/sdk/credentials.html#datarobot.models.Credential.create_box_jwt): In-page section heading.
- [classmethodcreate_gcp(name, gcp_key=None, description=None)](https://docs.datarobot.com/en/docs/api/reference/sdk/credentials.html#datarobot.models.Credential.create_gcp): In-page section heading.
- [update(name=None, description=None, **kwargs)](https://docs.datarobot.com/en/docs/api/reference/sdk/credentials.html#datarobot.models.Credential.update): In-page section heading.

## Related documentation

- [Developer documentation](https://docs.datarobot.com/en/docs/api/index.html): Linked from this page.
- [API reference](https://docs.datarobot.com/en/docs/api/reference/index.html): Linked from this page.
- [Python API client](https://docs.datarobot.com/en/docs/api/reference/sdk/index.html): Linked from this page.
- [Administration](https://docs.datarobot.com/en/docs/api/reference/sdk/tag-admin.html): Linked from this page.

## Documentation content

### class datarobot.models.Credential

#### classmethod list()

Returns list of available credentials.

- Returns: credentials – contains a list of available credentials.
- Return type: list of Credential instances

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> data_sources = dr.Credential.list()
> >>> data_sources
> [
>     Credential('5e429d6ecf8a5f36c5693e03', 'my_s3_cred', 's3'),
>     Credential('5e42cc4dcf8a5f3256865840', 'my_jdbc_cred', 'jdbc'),
> ]
> ```

#### classmethod get(credential_id)

Gets the Credential.

- Parameters: credential_id ( str ) – the identifier of the credential.
- Returns: credential – the requested credential.
- Return type: Credential

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> cred = dr.Credential.get('5a8ac9ab07a57a0001be501f')
> >>> cred
> Credential('5e429d6ecf8a5f36c5693e03', 'my_s3_cred', 's3'),
> ```

#### delete()

Deletes the Credential the store.

- Parameters: credential_id ( str ) – the identifier of the credential.
- Returns: credential – the requested credential.
- Return type: Credential

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> cred = dr.Credential.get('5a8ac9ab07a57a0001be501f')
> >>> cred.delete()
> ```

#### classmethod create_basic(name, user, password, description=None)

Creates the credentials.

- Parameters:
- Returns: credential – the created credential.
- Return type: Credential

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> cred = dr.Credential.create_basic(
> ...     name='my_basic_cred',
> ...     user='username',
> ...     password='password',
> ... )
> >>> cred
> Credential('5e429d6ecf8a5f36c5693e03', 'my_basic_cred', 'basic'),
> ```

#### classmethod create_oauth(name, token, refresh_token, description=None)

Creates the OAUTH credentials.

- Parameters:
- Returns: credential – the created credential.
- Return type: Credential

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> cred = dr.Credential.create_oauth(
> ...     name='my_oauth_cred',
> ...     token='XXX',
> ...     refresh_token='YYY',
> ... )
> >>> cred
> Credential('5e429d6ecf8a5f36c5693e03', 'my_oauth_cred', 'oauth'),
> ```

#### classmethod create_s3(name, aws_access_key_id=None, aws_secret_access_key=None, aws_session_token=None, config_id=None, description=None)

Creates the S3 credentials.

- Parameters:
- Returns: credential – the created credential.
- Return type: Credential

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> cred = dr.Credential.create_s3(
> ...     name='my_s3_cred',
> ...     aws_access_key_id='XXX',
> ...     aws_secret_access_key='YYY',
> ...     aws_session_token='ZZZ',
> ... )
> >>> cred
> Credential('5e429d6ecf8a5f36c5693e03', 'my_s3_cred', 's3'),
> ```

#### classmethod create_azure(name, azure_connection_string, description=None)

Creates the Azure storage credentials.

- Parameters:
- Returns: credential – the created credential.
- Return type: Credential

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> cred = dr.Credential.create_azure(
> ...     name='my_azure_cred',
> ...     azure_connection_string='XXX',
> ... )
> >>> cred
> Credential('5e429d6ecf8a5f36c5693e03', 'my_azure_cred', 'azure'),
> ```

#### classmethod create_snowflake_key_pair(name, user=None, private_key=None, passphrase=None, config_id=None, description=None)

Creates the Snowflake Key Pair credentials.

- Parameters:
- Returns: credential – the created credential.
- Return type: Credential

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> cred = dr.Credential.create_snowflake_key_pair(
> ...     name='key_pair_cred',
> ...     user='XXX',
> ...     private_key='YYY',
> ...     passphrase='ZZZ',
> ... )
> >>> cred
> Credential('5e429d6ecf8a5f36c5693e03', 'key_pair_cred', 'snowflake_key_pair_user_account'),
> ```

#### classmethod create_databricks_access_token(name, databricks_access_token, description=None)

Creates the Databricks access token credentials.

- Parameters:
- Returns: credential – the created credential.
- Return type: Credential

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> cred = dr.Credential.create_databricks_access_token(
> ...     name='access_token_cred',
> ...     databricks_access_token='XXX',
> ... )
> >>> cred
> Credential('5e429d6ecf8a5f36c5693e03', 'access_token_cred', 'databricks_access_token_account'),
> ```

#### classmethod create_databricks_service_principal(name, client_id=None, client_secret=None, config_id=None, description=None)

Creates the Databricks access token credentials.

- Parameters:
- Returns: credential – the created credential.
- Return type: Credential

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> cred = dr.Credential.create_databricks_service_principal(
> ...     name='svc_principal_cred',
> ...     client_id='XXX',
> ...     client_secret='XXX',
> ... )
> >>> cred
> Credential('5e429d6ecf8a5f36c5693e03', 'svc_principal_cred', 'databricks_service_principal_account'),
> ```

#### classmethod create_azure_service_principal(name, client_id=None, client_secret=None, azure_tenant_id=None, config_id=None, description=None)

Creates the Azure service principal credentials.

- Parameters:
- Returns: credential – the created credential.
- Return type: Credential

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> cred = dr.Credential.create_azure_service_principal(
> ...     name='my_azure_service_principal_cred',
> ...     client_id='XXX',
> ...     client_secret='YYY',
> ...     azure_tenant_id='ZZZ',
> ... )
> >>> cred
> Credential('66c9172d8b7a361cda126f5c', 'my_azure_service_principal_cred', 'azure_service_principal')
> ```

#### classmethod create_adls_oauth(name, client_id=None, client_secret=None, oauth_scopes=None, config_id=None, description=None)

Creates the ADLS OAuth credentials.

- Parameters:
- Returns: credential – The created credential.
- Return type: Credential

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> cred = dr.Credential.create_adls_oauth(
> ...     name='my_adls_oauth_cred',
> ...     client_id='XXX',
> ...     client_secret='YYY',
> ...     oauth_scopes=['ZZZ'],
> ... )
> >>> cred
> Credential('66c91e0f03010d4790735220', 'my_adls_oauth_cred', 'adls_gen2_oauth')
> ```

#### classmethod create_external_oauth_provider(name, authentication_id, description=None)

Creates credentials for an external OAuth provider.

- Parameters:
- Returns: credential – The created credential.
- Return type: Credential

#### classmethod create_box_jwt(name, client_id, client_secret, enterprise_id, public_key_id, private_key_str, passphrase, description=None)

Creates the Box JWT credentials.

- Parameters:
- Returns: credential – The created credential.
- Return type: Credential

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> cred = dr.Credential.create_box_jwt(
> ...     name='my_box_jwt_cred',
> ...     client_id='XXX',
> ...     client_secret='YYY',
> ...     enterprise_id='ZZZ',
> ...     public_key_id='AAA',
> ...     private_key_str='-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----',
> ...     passphrase='BBB',
> ... )
> >>> cred
> Credential('5e429d6ecf8a5f36c5693e03', 'my_box_jwt_cred', 'box_jwt')
> ```

#### classmethod create_gcp(name, gcp_key=None, description=None)

Creates the GCP credentials.

- Parameters:
- Returns: credential – the created credential.
- Return type: Credential

> [!NOTE] Examples
> ```
> >>> import datarobot as dr
> >>> cred = dr.Credential.create_gcp(
> ...     name='my_gcp_cred',
> ...     gcp_key='XXX',
> ... )
> >>> cred
> Credential('5e429d6ecf8a5f36c5693e03', 'my_gcp_cred', 'gcp'),
> ```

#### update(name=None, description=None, **kwargs)

Update the credential values of an existing credential. Updates this object in place.

Added in version v3.2.

- Parameters:
- Return type: None