AuthRolesResourceApi

All URIs are relative to /api/v57

Method	HTTP request	Description
createAuthRoles	POST /authRoles	Creates a list of auth roles.
deleteAuthRole	DELETE /authRoles/{uuid}	Deletes an auth role from the system.
readAuthRole	GET /authRoles/{uuid}	Returns detailed information about an auth role.
readAuthRoles	GET /authRoles	Returns a list of the auth roles configured in the system.
readAuthRolesMetadata	GET /authRoles/metadata	Returns a list of the auth roles' metadata for the built-in roles.
updateAuthRole	PUT /authRoles/{uuid}	Updates the given auth role's information.

createAuthRoles

ApiAuthRoleList createAuthRoles(body)

Creates a list of auth roles.

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.AuthRolesResourceApi;

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

AuthRolesResourceApi apiInstance = new AuthRolesResourceApi();
ApiAuthRoleList body = new ApiAuthRoleList(); // ApiAuthRoleList | List of auth roles to create.
try {
    ApiAuthRoleList result = apiInstance.createAuthRoles(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthRolesResourceApi#createAuthRoles");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	ApiAuthRoleList	List of auth roles to create.	[optional]

Return type

ApiAuthRoleList

Authorization

basic

HTTP request headers

Content-Type: application/json
Accept: application/json

deleteAuthRole

ApiAuthRole deleteAuthRole(uuid)

Deletes an auth role from the system.

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.AuthRolesResourceApi;

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

AuthRolesResourceApi apiInstance = new AuthRolesResourceApi();
String uuid = "uuid_example"; // String | The uuid of the auth role to delete.
try {
    ApiAuthRole result = apiInstance.deleteAuthRole(uuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthRolesResourceApi#deleteAuthRole");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
uuid	String	The uuid of the auth role to delete.

Return type

ApiAuthRole

Authorization

basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

readAuthRole

ApiAuthRole readAuthRole(uuid)

Returns detailed information about an auth role.

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.AuthRolesResourceApi;

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

AuthRolesResourceApi apiInstance = new AuthRolesResourceApi();
String uuid = "uuid_example"; // String | The auth role to read.
try {
    ApiAuthRole result = apiInstance.readAuthRole(uuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthRolesResourceApi#readAuthRole");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
uuid	String	The auth role to read.

Return type

ApiAuthRole

Authorization

basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

readAuthRoles

ApiAuthRoleList readAuthRoles(view)

Returns a list of the auth roles configured in the system.

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.AuthRolesResourceApi;

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

AuthRolesResourceApi apiInstance = new AuthRolesResourceApi();
String view = "summary"; // String | 
try {
    ApiAuthRoleList result = apiInstance.readAuthRoles(view);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthRolesResourceApi#readAuthRoles");
    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

ApiAuthRoleList

Authorization

basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

readAuthRolesMetadata

ApiAuthRoleMetadataList readAuthRolesMetadata(view)

Returns a list of the auth roles' metadata for the built-in roles.

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.AuthRolesResourceApi;

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

AuthRolesResourceApi apiInstance = new AuthRolesResourceApi();
String view = "summary"; // String | 
try {
    ApiAuthRoleMetadataList result = apiInstance.readAuthRolesMetadata(view);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthRolesResourceApi#readAuthRolesMetadata");
    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

ApiAuthRoleMetadataList

Authorization

basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

updateAuthRole

ApiAuthRole updateAuthRole(uuid, body)

Updates the given auth role's information.

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.AuthRolesResourceApi;

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

AuthRolesResourceApi apiInstance = new AuthRolesResourceApi();
String uuid = "uuid_example"; // String | Uuid of the auth role being updated.
ApiAuthRole body = new ApiAuthRole(); // ApiAuthRole | The auth role information.
try {
    ApiAuthRole result = apiInstance.updateAuthRole(uuid, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthRolesResourceApi#updateAuthRole");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
uuid	String	Uuid of the auth role being updated.
body	ApiAuthRole	The auth role information.	[optional]

Return type

ApiAuthRole

Authorization

basic

HTTP request headers

Content-Type: application/json
Accept: application/json