com.databricks.sdk.service.iamv2

Interface AccountIamV2Service

@Generated
public interface AccountIamV2Service

These APIs are used to manage identities and the workspace access of these identities in .

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
WorkspaceAssignmentDetail	createWorkspaceAssignmentDetail(CreateWorkspaceAssignmentDetailRequest createWorkspaceAssignmentDetailRequest) Creates a workspace assignment detail for a principal.
void	deleteWorkspaceAssignmentDetail(DeleteWorkspaceAssignmentDetailRequest deleteWorkspaceAssignmentDetailRequest) Deletes a workspace assignment detail for a principal, revoking all associated entitlements.
WorkspaceAccessDetail	getWorkspaceAccessDetail(GetWorkspaceAccessDetailRequest getWorkspaceAccessDetailRequest) Returns the access details for a principal in a workspace.
WorkspaceAssignmentDetail	getWorkspaceAssignmentDetail(GetWorkspaceAssignmentDetailRequest getWorkspaceAssignmentDetailRequest) Returns the assignment details for a principal in a workspace.
ListWorkspaceAssignmentDetailsResponse	listWorkspaceAssignmentDetails(ListWorkspaceAssignmentDetailsRequest listWorkspaceAssignmentDetailsRequest) Lists workspace assignment details for a workspace.
ResolveGroupResponse	resolveGroup(ResolveGroupRequest resolveGroupRequest) Resolves a group with the given external ID from the customer's IdP.
ResolveServicePrincipalResponse	resolveServicePrincipal(ResolveServicePrincipalRequest resolveServicePrincipalRequest) Resolves an SP with the given external ID from the customer's IdP.
ResolveUserResponse	resolveUser(ResolveUserRequest resolveUserRequest) Resolves a user with the given external ID from the customer's IdP.
WorkspaceAssignmentDetail	updateWorkspaceAssignmentDetail(UpdateWorkspaceAssignmentDetailRequest updateWorkspaceAssignmentDetailRequest) Updates the entitlements of a directly assigned principal in a workspace.

Method Detail

createWorkspaceAssignmentDetail

WorkspaceAssignmentDetail createWorkspaceAssignmentDetail(CreateWorkspaceAssignmentDetailRequest createWorkspaceAssignmentDetailRequest)

Creates a workspace assignment detail for a principal. Entitlement grants are applied individually and non-atomically — if a failure occurs partway through, the principal will be assigned to the workspace but with only a subset of the requested entitlements. Use GetWorkspaceAssignmentDetail to confirm which entitlements were successfully granted.

deleteWorkspaceAssignmentDetail

void deleteWorkspaceAssignmentDetail(DeleteWorkspaceAssignmentDetailRequest deleteWorkspaceAssignmentDetailRequest)

Deletes a workspace assignment detail for a principal, revoking all associated entitlements. Entitlement revocations are applied individually and non-atomically — if a failure occurs partway through, the principal remains assigned with a subset of its original entitlements, and the operation is safe to retry.

getWorkspaceAccessDetail

WorkspaceAccessDetail getWorkspaceAccessDetail(GetWorkspaceAccessDetailRequest getWorkspaceAccessDetailRequest)

Returns the access details for a principal in a workspace. Allows for checking access details for any provisioned principal (user, service principal, or group) in a workspace. * Provisioned principal here refers to one that has been synced into Databricks from the customer's IdP or added explicitly to Databricks via SCIM/UI. Allows for passing in a "view" parameter to control what fields are returned (BASIC by default or FULL).

getWorkspaceAssignmentDetail

WorkspaceAssignmentDetail getWorkspaceAssignmentDetail(GetWorkspaceAssignmentDetailRequest getWorkspaceAssignmentDetailRequest)

Returns the assignment details for a principal in a workspace.

listWorkspaceAssignmentDetails

ListWorkspaceAssignmentDetailsResponse listWorkspaceAssignmentDetails(ListWorkspaceAssignmentDetailsRequest listWorkspaceAssignmentDetailsRequest)

Lists workspace assignment details for a workspace.

resolveGroup

ResolveGroupResponse resolveGroup(ResolveGroupRequest resolveGroupRequest)

Resolves a group with the given external ID from the customer's IdP. If the group does not exist, it will be created in the account. If the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error.

resolveServicePrincipal

ResolveServicePrincipalResponse resolveServicePrincipal(ResolveServicePrincipalRequest resolveServicePrincipalRequest)

Resolves an SP with the given external ID from the customer's IdP. If the SP does not exist, it will be created. If the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error.

resolveUser

ResolveUserResponse resolveUser(ResolveUserRequest resolveUserRequest)

Resolves a user with the given external ID from the customer's IdP. If the user does not exist, it will be created. If the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error.

updateWorkspaceAssignmentDetail

WorkspaceAssignmentDetail updateWorkspaceAssignmentDetail(UpdateWorkspaceAssignmentDetailRequest updateWorkspaceAssignmentDetailRequest)

Updates the entitlements of a directly assigned principal in a workspace. Entitlement changes are applied individually and non-atomically — if a failure occurs partway through, only a subset of the requested changes may have been applied. Use GetWorkspaceAssignmentDetail to confirm the final state.