Package com.databricks.sdk.service.oauth2

Class OAuthEnrollmentAPI

java.lang.Object

com.databricks.sdk.service.oauth2.OAuthEnrollmentAPI

@Generated
public class OAuthEnrollmentAPI
extends Object

These APIs enable administrators to enroll OAuth for their accounts, which is required for adding/using any OAuth published/custom application integration.

**Note:** Your account must be on the E2 version to use these APIs, this is because OAuth is only supported on the E2 version.

Constructor Summary

Constructors

Constructor	Description
OAuthEnrollmentAPI(ApiClient apiClient)	Regular-use constructor
OAuthEnrollmentAPI(OAuthEnrollmentService mock)	Constructor for mocks

Method Summary

Modifier and Type	Method	Description
void	create(CreateOAuthEnrollment request)	Create OAuth Enrollment request.
OAuthEnrollmentStatus	get()	Get OAuth enrollment status.
OAuthEnrollmentService	impl()

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthEnrollmentAPI

public OAuthEnrollmentAPI(ApiClient apiClient)

Regular-use constructor

OAuthEnrollmentAPI

public OAuthEnrollmentAPI(OAuthEnrollmentService mock)

Constructor for mocks

Method Detail

create

public void create(CreateOAuthEnrollment request)

Create OAuth Enrollment request.

Create an OAuth Enrollment request to enroll OAuth for this account and optionally enable the OAuth integration for all the partner applications in the account.

The parter applications are: - Power BI - Tableau Desktop - Databricks CLI

The enrollment is executed asynchronously, so the API will return 204 immediately. The actual enrollment take a few minutes, you can check the status via API :method:OAuthEnrollment/get.

get

public OAuthEnrollmentStatus get()

Get OAuth enrollment status.

Gets the OAuth enrollment status for this Account.

You can only add/use the OAuth published/custom application integrations when OAuth enrollment status is enabled.

impl

public OAuthEnrollmentService impl()