external_users
Creates, updates, deletes, gets or lists an external_users resource.
Overview
| Name | external_users |
| Type | Resource |
| Id | databricks_account.iamv2.external_users |
Fields
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
name | string | The resource name of the external user. Format: accounts/{account_id}/external-users/{external_user_id} |
account_id | string | The parent account ID, from Databricks. |
external_user_id | string | The external ID of the user in the customer's IdP. |
internal_id | string | Internal userId of the user in Databricks. |
display_name | string | Display name of the user from the customer's IdP. |
full_name | object | The full name of the user, from the customer's IdP. |
account_user_status | string | The activity status of the user in the Databricks account. (ACTIVE, INACTIVE) |
username | string | Username/email of the user, from Databricks. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | name | Retrieves an external user with the given external ID from the customer's IdP. If the user does not |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
name | string | Required. The resource name of the external user. Format: accounts/{account_id}/external-users/{external_user_id} |
SELECT examples
- get
Retrieves an external user with the given external ID from the customer's IdP. If the user does not
SELECT
name,
account_id,
external_user_id,
internal_id,
display_name,
full_name,
account_user_status,
username
FROM databricks_account.iamv2.external_users
WHERE name = '{{ name }}' -- required
;