com.databricks.sdk.service.iamv2

Class AccountIamV2API

java.lang.Object

com.databricks.sdk.service.iamv2.AccountIamV2API

@Generated
public class AccountIamV2API
extends Object

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

Constructor Summary

Constructors

Constructor and Description
AccountIamV2API(AccountIamV2Service mock) Constructor for mocks
AccountIamV2API(ApiClient apiClient) Regular-use constructor

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AccountIamV2API

public AccountIamV2API(ApiClient apiClient)

Regular-use constructor

AccountIamV2API

public AccountIamV2API(AccountIamV2Service mock)

Constructor for mocks

Method Detail

createWorkspaceAssignmentDetail

public WorkspaceAssignmentDetail createWorkspaceAssignmentDetail(CreateWorkspaceAssignmentDetailRequest request)

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

public void deleteWorkspaceAssignmentDetail(long workspaceId,
                                            long principalId)

deleteWorkspaceAssignmentDetail

public void deleteWorkspaceAssignmentDetail(DeleteWorkspaceAssignmentDetailRequest request)

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

public WorkspaceAccessDetail getWorkspaceAccessDetail(long workspaceId,
                                                      long principalId)

getWorkspaceAccessDetail

public WorkspaceAccessDetail getWorkspaceAccessDetail(GetWorkspaceAccessDetailRequest request)

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

public WorkspaceAssignmentDetail getWorkspaceAssignmentDetail(long workspaceId,
                                                              long principalId)

getWorkspaceAssignmentDetail

public WorkspaceAssignmentDetail getWorkspaceAssignmentDetail(GetWorkspaceAssignmentDetailRequest request)

Returns the assignment details for a principal in a workspace.

listWorkspaceAssignmentDetails

public ListWorkspaceAssignmentDetailsResponse listWorkspaceAssignmentDetails(long workspaceId)

listWorkspaceAssignmentDetails

public ListWorkspaceAssignmentDetailsResponse listWorkspaceAssignmentDetails(ListWorkspaceAssignmentDetailsRequest request)

Lists workspace assignment details for a workspace.

resolveGroup

public ResolveGroupResponse resolveGroup(ResolveGroupRequest request)

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

public ResolveServicePrincipalResponse resolveServicePrincipal(ResolveServicePrincipalRequest request)

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

public ResolveUserResponse resolveUser(ResolveUserRequest request)

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

public WorkspaceAssignmentDetail updateWorkspaceAssignmentDetail(UpdateWorkspaceAssignmentDetailRequest request)

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.

impl

public AccountIamV2Service impl()