com.databricks.sdk.service.iamv2

Interface WorkspaceIamV2Service

@Generated
public interface WorkspaceIamV2Service

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	createWorkspaceAssignmentDetailProxy(CreateWorkspaceAssignmentDetailProxyRequest createWorkspaceAssignmentDetailProxyRequest) Creates a workspace assignment detail for a principal (workspace-level proxy).
void	deleteWorkspaceAssignmentDetailProxy(DeleteWorkspaceAssignmentDetailProxyRequest deleteWorkspaceAssignmentDetailProxyRequest) Deletes a workspace assignment detail for a principal (workspace-level proxy), revoking all associated entitlements.
WorkspaceAccessDetail	getWorkspaceAccessDetailLocal(GetWorkspaceAccessDetailLocalRequest getWorkspaceAccessDetailLocalRequest) Returns the access details for a principal in the current workspace.
WorkspaceAssignmentDetail	getWorkspaceAssignmentDetailProxy(GetWorkspaceAssignmentDetailProxyRequest getWorkspaceAssignmentDetailProxyRequest) Returns the assignment details for a principal in a workspace (workspace-level proxy).
ListWorkspaceAssignmentDetailsResponse	listWorkspaceAssignmentDetailsProxy(ListWorkspaceAssignmentDetailsProxyRequest listWorkspaceAssignmentDetailsProxyRequest) Lists workspace assignment details for a workspace (workspace-level proxy).
ResolveGroupResponse	resolveGroupProxy(ResolveGroupProxyRequest resolveGroupProxyRequest) Resolves a group with the given external ID from the customer's IdP.
ResolveServicePrincipalResponse	resolveServicePrincipalProxy(ResolveServicePrincipalProxyRequest resolveServicePrincipalProxyRequest) Resolves an SP with the given external ID from the customer's IdP.
ResolveUserResponse	resolveUserProxy(ResolveUserProxyRequest resolveUserProxyRequest) Resolves a user with the given external ID from the customer's IdP.
WorkspaceAssignmentDetail	updateWorkspaceAssignmentDetailProxy(UpdateWorkspaceAssignmentDetailProxyRequest updateWorkspaceAssignmentDetailProxyRequest) Updates the entitlements of a directly assigned principal in a workspace (workspace-level proxy).

Method Detail

createWorkspaceAssignmentDetailProxy

WorkspaceAssignmentDetail createWorkspaceAssignmentDetailProxy(CreateWorkspaceAssignmentDetailProxyRequest createWorkspaceAssignmentDetailProxyRequest)

Creates a workspace assignment detail for a principal (workspace-level proxy). 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.

deleteWorkspaceAssignmentDetailProxy

void deleteWorkspaceAssignmentDetailProxy(DeleteWorkspaceAssignmentDetailProxyRequest deleteWorkspaceAssignmentDetailProxyRequest)

Deletes a workspace assignment detail for a principal (workspace-level proxy), 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.

getWorkspaceAccessDetailLocal

WorkspaceAccessDetail getWorkspaceAccessDetailLocal(GetWorkspaceAccessDetailLocalRequest getWorkspaceAccessDetailLocalRequest)

Returns the access details for a principal in the current workspace. Allows for checking access details for any provisioned principal (user, service principal, or group) in the current 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).

getWorkspaceAssignmentDetailProxy

WorkspaceAssignmentDetail getWorkspaceAssignmentDetailProxy(GetWorkspaceAssignmentDetailProxyRequest getWorkspaceAssignmentDetailProxyRequest)

Returns the assignment details for a principal in a workspace (workspace-level proxy).

listWorkspaceAssignmentDetailsProxy

ListWorkspaceAssignmentDetailsResponse listWorkspaceAssignmentDetailsProxy(ListWorkspaceAssignmentDetailsProxyRequest listWorkspaceAssignmentDetailsProxyRequest)

Lists workspace assignment details for a workspace (workspace-level proxy).

resolveGroupProxy

ResolveGroupResponse resolveGroupProxy(ResolveGroupProxyRequest resolveGroupProxyRequest)

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.

resolveServicePrincipalProxy

ResolveServicePrincipalResponse resolveServicePrincipalProxy(ResolveServicePrincipalProxyRequest resolveServicePrincipalProxyRequest)

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.

resolveUserProxy

ResolveUserResponse resolveUserProxy(ResolveUserProxyRequest resolveUserProxyRequest)

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.

updateWorkspaceAssignmentDetailProxy

WorkspaceAssignmentDetail updateWorkspaceAssignmentDetailProxy(UpdateWorkspaceAssignmentDetailProxyRequest updateWorkspaceAssignmentDetailProxyRequest)

Updates the entitlements of a directly assigned principal in a workspace (workspace-level proxy). 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.