Credential Configuration

View as Markdown

GetGET /api/2.0/accounts/{account_id}/credentials/{credentials_id}CreatePOST /api/2.0/accounts/{account_id}/credentialsDeleteDELETE /api/2.0/accounts/{account_id}/credentials/{credentials_id}

Get GA

GET /api/2.0/accounts/{account_id}/credentials/{credentials_id}

Gets a <Databricks> credential configuration object for an account, both specified by ID.

API scopes: unity-catalog

CloudsAWS

Parameters

credentials_idstringpath

Credential configuration ID

account_idstringpath

Response

credentials_idstring

<Databricks> credential configuration ID.

account_idstring

The <Databricks> account ID that hosts the credential.

aws_credentialsobjectRequired

Show child attributesHide child attributes

sts_roleobjectRequired

Show child attributesHide child attributes

role_arnstring

The Amazon Resource Name (ARN) of the cross account IAM role.

Example: arn:aws:iam::111110000000:role/test_role

credentials_namestring

The human-readable name of the credential configuration object.

Example: credential_1

Constraints: [ 4 .. 256 ] characters

creation_timeint64

Time in epoch milliseconds when the credential was created.

View as Markdown

Response

{
  "credentials_id": "string",
  "account_id": "string",
  "aws_credentials": {
    "sts_role": {}
  },
  "credentials_name": "credential_1",
  "creation_time": 0
}

Create GA

POST /api/2.0/accounts/{account_id}/credentials

Creates a <Databricks> credential configuration that represents cloud cross-account credentials for a specified account. <Databricks> uses this to set up network infrastructure properly to host <Databricks> clusters. For your AWS IAM role, you need to trust the External ID (the Databricks Account API account ID) in the returned credential object, and configure the required access policy.

Save the response's credentials_id field, which is the ID for your new credential configuration object.

For information about how to create a new workspace with this API, see Create a new workspace using the Account API

API scopes: unity-catalog

CloudsAWS

Parameters

account_idstringpath

Request body

credentials_namestring

The human-readable name of the credential configuration object.

Example: my_credential

Constraints: [ 4 .. 256 ] characters

aws_credentialsobjectRequired

Show child attributesHide child attributes

sts_roleobjectRequired

Show child attributesHide child attributes

role_arnstring

The Amazon Resource Name (ARN) of the cross account IAM role.

Example: arn:aws:iam::111110000000:role/test_role

Response

credentials_idstring

<Databricks> credential configuration ID.

account_idstring

The <Databricks> account ID that hosts the credential.

aws_credentialsobjectRequired

Show child attributesHide child attributes

sts_roleobjectRequired

Show child attributesHide child attributes

role_arnstring

The Amazon Resource Name (ARN) of the cross account IAM role.

Example: arn:aws:iam::111110000000:role/test_role

credentials_namestring

The human-readable name of the credential configuration object.

Example: credential_1

Constraints: [ 4 .. 256 ] characters

creation_timeint64

Time in epoch milliseconds when the credential was created.

View as Markdown

Request

{
  "credentials_name": "my_credential",
  "aws_credentials": {
    "sts_role": {}
  }
}

Response

{
  "credentials_id": "string",
  "account_id": "string",
  "aws_credentials": {
    "sts_role": {}
  },
  "credentials_name": "credential_1",
  "creation_time": 0
}

Delete GA

DELETE /api/2.0/accounts/{account_id}/credentials/{credentials_id}

Deletes a <Databricks> credential configuration object for an account, both specified by ID. You cannot delete a credential that is associated with any workspace.

API scopes: unity-catalog

CloudsAWS

Parameters

credentials_idstringpath

Databricks Account API credential configuration ID

account_idstringpath

Response

credentials_idstring

<Databricks> credential configuration ID.

account_idstring

The <Databricks> account ID that hosts the credential.

aws_credentialsobjectRequired

Show child attributesHide child attributes

sts_roleobjectRequired

Show child attributesHide child attributes

role_arnstring

The Amazon Resource Name (ARN) of the cross account IAM role.

Example: arn:aws:iam::111110000000:role/test_role

credentials_namestring

The human-readable name of the credential configuration object.

Example: credential_1

Constraints: [ 4 .. 256 ] characters

creation_timeint64

Time in epoch milliseconds when the credential was created.

View as Markdown

Response

{
  "credentials_id": "string",
  "account_id": "string",
  "aws_credentials": {
    "sts_role": {}
  },
  "credentials_name": "credential_1",
  "creation_time": 0
}