com.databricks.sdk.service.oauth2.OAuthEnrollmentAPI Maven / Gradle / Ivy
// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
package com.databricks.sdk.service.oauth2;
import com.databricks.sdk.core.ApiClient;
import com.databricks.sdk.support.Generated;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* 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.
*/
@Generated
public class OAuthEnrollmentAPI {
private static final Logger LOG = LoggerFactory.getLogger(OAuthEnrollmentAPI.class);
private final OAuthEnrollmentService impl;
/** Regular-use constructor */
public OAuthEnrollmentAPI(ApiClient apiClient) {
impl = new OAuthEnrollmentImpl(apiClient);
}
/** Constructor for mocks */
public OAuthEnrollmentAPI(OAuthEnrollmentService mock) {
impl = mock;
}
/**
* 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.
*/
public void create(CreateOAuthEnrollment request) {
impl.create(request);
}
/**
* 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.
*/
public OAuthEnrollmentStatus get() {
return impl.get();
}
public OAuthEnrollmentService impl() {
return impl;
}
}