AuthServiceResourceApi

All URIs are relative to /api/v57

Method HTTP request Description
autoAssignRoles PUT /cm/authService/autoAssignRoles Automatically assign roles to hosts and create the roles for the Authentication Service.
autoConfigure PUT /cm/authService/autoConfigure Automatically configures roles of the Authentication Service.
delete DELETE /cm/authService Delete the Authentication Service.
enterMaintenanceMode POST /cm/authService/commands/enterMaintenanceMode Put the Authentication Service into maintenance mode.
exitMaintenanceMode POST /cm/authService/commands/exitMaintenanceMode Take the Authentication Service out of maintenance mode.
listActiveCommands GET /cm/authService/commands List active Authentication Service commands.
listRoleTypes GET /cm/authService/roleTypes List the supported role types for the Authentication Service.
readService GET /cm/authService Retrieve information about the Authentication Services.
readServiceConfig GET /cm/authService/config
restartCommand POST /cm/authService/commands/restart Restart the Authentication Service.
setup PUT /cm/authService Setup the Authentication Service.
startCommand POST /cm/authService/commands/start Start the Authentication Service.
stopCommand POST /cm/authService/commands/stop Stop the Authentication Service.
updateServiceConfig PUT /cm/authService/config

autoAssignRoles

autoAssignRoles()

Automatically assign roles to hosts and create the roles for the Authentication Service.

Automatically assign roles to hosts and create the roles for the Authentication Service.

Assignments are done based on number of hosts in the deployment and hardware specifications. If no hosts are part of the deployment, an exception will be thrown preventing any role assignments. Existing roles will be taken into account and their assignments will be not be modified. The deployment should not have any clusters when calling this endpoint. If it does, an exception will be thrown preventing any role assignments.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.AuthServiceResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

AuthServiceResourceApi apiInstance = new AuthServiceResourceApi();
try {
    apiInstance.autoAssignRoles();
} catch (ApiException e) {
    System.err.println("Exception when calling AuthServiceResourceApi#autoAssignRoles");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

basic

HTTP request headers

autoConfigure

autoConfigure()

Automatically configures roles of the Authentication Service.

Automatically configures roles of the Authentication Service.

Overwrites some existing configurations. Only default role config groups must exist before calling this endpoint. Other role config groups must not exist. If they do, an exception will be thrown preventing any configuration. Ignores any clusters (and their services and roles) colocated with the Authentication Service.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.AuthServiceResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

AuthServiceResourceApi apiInstance = new AuthServiceResourceApi();
try {
    apiInstance.autoConfigure();
} catch (ApiException e) {
    System.err.println("Exception when calling AuthServiceResourceApi#autoConfigure");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

basic

HTTP request headers

delete

ApiService delete()

Delete the Authentication Service.

Delete the Authentication Service.

This method will fail if a CMS instance doesn't already exist.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.AuthServiceResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

AuthServiceResourceApi apiInstance = new AuthServiceResourceApi();
try {
    ApiService result = apiInstance.delete();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthServiceResourceApi#delete");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiService

Authorization

basic

HTTP request headers

enterMaintenanceMode

ApiCommand enterMaintenanceMode()

Put the Authentication Service into maintenance mode.

Put the Authentication Service into maintenance mode. This is a synchronous command. The result is known immediately upon return.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.AuthServiceResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

AuthServiceResourceApi apiInstance = new AuthServiceResourceApi();
try {
    ApiCommand result = apiInstance.enterMaintenanceMode();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthServiceResourceApi#enterMaintenanceMode");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiCommand

Authorization

basic

HTTP request headers

exitMaintenanceMode

ApiCommand exitMaintenanceMode()

Take the Authentication Service out of maintenance mode.

Take the Authentication Service out of maintenance mode. This is a synchronous command. The result is known immediately upon return.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.AuthServiceResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

AuthServiceResourceApi apiInstance = new AuthServiceResourceApi();
try {
    ApiCommand result = apiInstance.exitMaintenanceMode();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthServiceResourceApi#exitMaintenanceMode");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiCommand

Authorization

basic

HTTP request headers

listActiveCommands

ApiCommandList listActiveCommands(view)

List active Authentication Service commands.

List active Authentication Service commands.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.AuthServiceResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

AuthServiceResourceApi apiInstance = new AuthServiceResourceApi();
String view = "summary"; // String | The view of the data to materialize, either \"summary\" or \"full\".
try {
    ApiCommandList result = apiInstance.listActiveCommands(view);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthServiceResourceApi#listActiveCommands");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
view String The view of the data to materialize, either "summary" or "full". [optional] [default to summary] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, FULL_WITH_NO_HEALTH_CHECK, SUMMARY]

Return type

ApiCommandList

Authorization

basic

HTTP request headers

listRoleTypes

ApiRoleTypeList listRoleTypes()

List the supported role types for the Authentication Service.

List the supported role types for the Authentication Service.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.AuthServiceResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

AuthServiceResourceApi apiInstance = new AuthServiceResourceApi();
try {
    ApiRoleTypeList result = apiInstance.listRoleTypes();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthServiceResourceApi#listRoleTypes");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiRoleTypeList

Authorization

basic

HTTP request headers

readService

ApiService readService()

Retrieve information about the Authentication Services.

Retrieve information about the Authentication Services.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.AuthServiceResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

AuthServiceResourceApi apiInstance = new AuthServiceResourceApi();
try {
    ApiService result = apiInstance.readService();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthServiceResourceApi#readService");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiService

Authorization

basic

HTTP request headers

readServiceConfig

ApiServiceConfig readServiceConfig(view)

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.AuthServiceResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

AuthServiceResourceApi apiInstance = new AuthServiceResourceApi();
String view = "summary"; // String | 
try {
    ApiServiceConfig result = apiInstance.readServiceConfig(view);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthServiceResourceApi#readServiceConfig");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
view String [optional] [default to summary] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, FULL_WITH_NO_HEALTH_CHECK, SUMMARY]

Return type

ApiServiceConfig

Authorization

basic

HTTP request headers

restartCommand

ApiCommand restartCommand()

Restart the Authentication Service.

Restart the Authentication Service.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.AuthServiceResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

AuthServiceResourceApi apiInstance = new AuthServiceResourceApi();
try {
    ApiCommand result = apiInstance.restartCommand();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthServiceResourceApi#restartCommand");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiCommand

Authorization

basic

HTTP request headers

setup

ApiService setup(body)

Setup the Authentication Service.

Setup the Authentication Service.

Configure the Auth Service instance with the information given in the ApiService. The provided configuration data can be used to set up host mappings for each role, and required configuration such as database connection information for specific roles.

This method needs a valid CM license to be installed beforehand.

This method does not start any services or roles.

This method will fail if a Auth Service instance already exists.

Available role types:

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.AuthServiceResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

AuthServiceResourceApi apiInstance = new AuthServiceResourceApi();
ApiService body = new ApiService(); // ApiService | Role configuration overrides.
try {
    ApiService result = apiInstance.setup(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthServiceResourceApi#setup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body ApiService Role configuration overrides. [optional]

Return type

ApiService

Authorization

basic

HTTP request headers

startCommand

ApiCommand startCommand()

Start the Authentication Service.

Start the Authentication Service.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.AuthServiceResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

AuthServiceResourceApi apiInstance = new AuthServiceResourceApi();
try {
    ApiCommand result = apiInstance.startCommand();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthServiceResourceApi#startCommand");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiCommand

Authorization

basic

HTTP request headers

stopCommand

ApiCommand stopCommand()

Stop the Authentication Service.

Stop the Authentication Service.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.AuthServiceResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

AuthServiceResourceApi apiInstance = new AuthServiceResourceApi();
try {
    ApiCommand result = apiInstance.stopCommand();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthServiceResourceApi#stopCommand");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiCommand

Authorization

basic

HTTP request headers

updateServiceConfig

ApiServiceConfig updateServiceConfig(body, message)

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.AuthServiceResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

AuthServiceResourceApi apiInstance = new AuthServiceResourceApi();
ApiServiceConfig body = new ApiServiceConfig(); // ApiServiceConfig | 
String message = "message_example"; // String | 
try {
    ApiServiceConfig result = apiInstance.updateServiceConfig(body, message);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthServiceResourceApi#updateServiceConfig");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body ApiServiceConfig [optional]
message String [optional]

Return type

ApiServiceConfig

Authorization

basic

HTTP request headers