Schema Reference
The application schema is used to configure the objects returned from a connector.
Note
-
The Account Schema tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as Entitlement or Multi-Valued. Refer to Managing Source Account Schemas for more information.
-
The schema attributes that are not present by default must be defined as strings if not specified.
The Databricks connector uses the following default correlation and object configurations.
Default Correlation Configuration
Before you aggregate accounts from this source, you can map account attributes with their corresponding identity attributes based on your requirements.
You can customize the correlation configuration. Refer to Assigning Source Accounts to Identities for more information.
When you first create the Databricks source, the default correlation mapping is:
| Account Attribute | Operation | Identity Attribute |
|---|---|---|
| workEmail | Equals | Work Email |
| displayName | Equals | Display Name |
Default Account Schema
Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location.
The set of account attributes each source stores and how they're organized is known as the account's schema. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to Managing Source Account Schemas for more information.
Default Account ID
SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as account IDs.
Caution
Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts.
To resolve issues caused by changing account IDs, reconfigure them to their default values.
The following table lists the default account IDs for this connector:
| Account ID | Schema Object Type |
|---|---|
| id | Account |
Default Account Attributes
The Databricks connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified.
| Attributes | Description |
|---|---|
| id | Unique identifier for the user or service principal |
| userName | User's unique login name (email address) |
| displayName | Display name of the user or service principal |
| givenName | User's first name |
| familyName | User's family name |
| workEmail | User's work email address |
| active | Status of the User or Service Principal |
| externalId | External identifier for the user or service principal (from identity provider) |
| applicationId | Application ID of the Service Principal |
| type | Identity type: USER or SERVICE_PRINCIPAL |
| identityScope | Identity scope: account or federated |
| federatedWorkspaces | Comma-separated list of workspaces the identity is federated to |
| totalGroupMembershipCount | Total count of group memberships |
| isAccountAdmin | Whether the identity is an account admin |
| directWorkspacePermissions | Direct workspace permissions in format Workspace@Role |
| groups | Direct groups the user belongs to |
| accountLevelRoles | Account level roles assigned to the group |
| workspaceEntitlements | Workspace entitlements in format entitlement@workspace |
Default Entitlement Attributes
Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to Managing Entitlements for more information.
Caution
Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations.
Default Group Attributes
The Databricks connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups.
Group Schema
| Attributes | Description |
|---|---|
| id | Unique identifier for the group |
| displayName | Group display name |
| type | Type of the group |
| identityScope | Identity scope (account/federated/legacy) |
| externalId | External identifier for the group |
| federatedWorkspaces | List of workspaces into which group is federated |
| totalGroupMembershipCount | Total count of group membership |
| isAccountAdmin | Whether the group is an account admin |
| directWorkspacePermissions | Direct workspace permissions in format workspace@permission |
| parentGroups | Represents the parent groups that this group is a member of |
| accountLevelRoles | Account level roles assigned to the group |
| workspaceEntitlements | Workspace entitlements linked to this group (format: entitlement@workspace) |
Account Role Schema
| Attributes | Description |
|---|---|
| name | Account-level role name |
Workspace
| Attributes | Description |
|---|---|
| workspacePermission | The unique identifier for the workspace with associated privilege |
| workspacePermissionIdentifier | The unique identifier for the workspace id associated privilege |
| workspaceId | The unique numerical ID for the workspace |
| workspaceName | Name of the workspace |
| workspaceStatus | Lifecycle state of the workspace |
| workspaceStatusMessage | Detailed status or error message for the workspace |
Machine Identity Schema
Machine Identity attributes define the multiple types of machine identities that can be assigned to the managed system's user accounts.
| Attributes | Description |
|---|---|
| creationTimestamp | Date when the agent was created |
| creator | Email or identifier of the user who created the agent |
| creatorDisplayName | Display name of the creator |
| creatorKind | Kind of creator (for example, User) |
| description | Description of the agent |
| id | Unique identifier of the serving endpoint (agent) |
| lastUpdatedTimestamp | Date when the agent was last updated |
| name | Name of the agent (serving endpoint) |
| routeOptimized | Boolean representing if route optimization has been enabled for the endpoint |
| task | Task type (for example, agent/v1/responses) |
| workspaceId | ID of the Databricks workspace containing this agent |
| workspaceName | Name of the Databricks workspace containing this agent |
Documentation Feedback
Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.