All URIs are relative to /api/v57
Method | HTTP request | Description |
---|---|---|
readConfig | GET /cm/authService/roleConfigGroups/{roleConfigGroupName}/config | Returns the current revision of the config for the specified role config group in the Authentication Service. |
readRoleConfigGroup | GET /cm/authService/roleConfigGroups/{roleConfigGroupName} | Returns the information for a given role config group in the Authentication Service. |
readRoleConfigGroups | GET /cm/authService/roleConfigGroups | Returns the information for all role config groups in the Authentication Service. |
readRoles | GET /cm/authService/roleConfigGroups/{roleConfigGroupName}/roles | Returns all roles in the given role config group in the Authentication Service. |
updateConfig | PUT /cm/authService/roleConfigGroups/{roleConfigGroupName}/config | Updates the config for the given role config group in the Authentication Service. |
updateRoleConfigGroup | PUT /cm/authService/roleConfigGroups/{roleConfigGroupName} | Updates an existing role config group in the Authentication Service. |
ApiConfigList readConfig(roleConfigGroupName, view)
Returns the current revision of the config for the specified role config group in the Authentication Service.
Returns the current revision of the config for the specified role config group in the Authentication Service.
// 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.AuthServiceRoleConfigGroupsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
AuthServiceRoleConfigGroupsResourceApi apiInstance = new AuthServiceRoleConfigGroupsResourceApi();
String roleConfigGroupName = "roleConfigGroupName_example"; // String | The name of the role config group.
String view = "summary"; // String | The view of the data to materialize, either \"summary\" or \"full\".
try {
ApiConfigList result = apiInstance.readConfig(roleConfigGroupName, view);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AuthServiceRoleConfigGroupsResourceApi#readConfig");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
roleConfigGroupName | String | The name of the role config group. | |
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] |
ApiRoleConfigGroup readRoleConfigGroup(roleConfigGroupName)
Returns the information for a given role config group in the Authentication Service.
Returns the information for a given role config group in the Authentication Service.
// 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.AuthServiceRoleConfigGroupsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
AuthServiceRoleConfigGroupsResourceApi apiInstance = new AuthServiceRoleConfigGroupsResourceApi();
String roleConfigGroupName = "roleConfigGroupName_example"; // String | The name of the requested group.
try {
ApiRoleConfigGroup result = apiInstance.readRoleConfigGroup(roleConfigGroupName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AuthServiceRoleConfigGroupsResourceApi#readRoleConfigGroup");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
roleConfigGroupName | String | The name of the requested group. |
ApiRoleConfigGroupList readRoleConfigGroups()
Returns the information for all role config groups in the Authentication Service.
Returns the information for all role config groups in the Authentication Service.
// 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.AuthServiceRoleConfigGroupsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
AuthServiceRoleConfigGroupsResourceApi apiInstance = new AuthServiceRoleConfigGroupsResourceApi();
try {
ApiRoleConfigGroupList result = apiInstance.readRoleConfigGroups();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AuthServiceRoleConfigGroupsResourceApi#readRoleConfigGroups");
e.printStackTrace();
}
This endpoint does not need any parameter.
ApiRoleList readRoles(roleConfigGroupName)
Returns all roles in the given role config group in the Authentication Service.
Returns all roles in the given role config group in the Authentication Service.
// 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.AuthServiceRoleConfigGroupsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
AuthServiceRoleConfigGroupsResourceApi apiInstance = new AuthServiceRoleConfigGroupsResourceApi();
String roleConfigGroupName = "roleConfigGroupName_example"; // String | The name of the role config group.
try {
ApiRoleList result = apiInstance.readRoles(roleConfigGroupName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AuthServiceRoleConfigGroupsResourceApi#readRoles");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
roleConfigGroupName | String | The name of the role config group. |
ApiConfigList updateConfig(roleConfigGroupName, body, message)
Updates the config for the given role config group in the Authentication Service.
Updates the config for the given role config group in the Authentication Service.
// 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.AuthServiceRoleConfigGroupsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
AuthServiceRoleConfigGroupsResourceApi apiInstance = new AuthServiceRoleConfigGroupsResourceApi();
String roleConfigGroupName = "roleConfigGroupName_example"; // String | The name of the role config group.
ApiConfigList body = new ApiConfigList(); // ApiConfigList | The new config information for the group.
String message = "message_example"; // String | Optional message describing the changes.
try {
ApiConfigList result = apiInstance.updateConfig(roleConfigGroupName, body, message);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AuthServiceRoleConfigGroupsResourceApi#updateConfig");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
roleConfigGroupName | String | The name of the role config group. | |
body | ApiConfigList | The new config information for the group. | [optional] |
message | String | Optional message describing the changes. | [optional] |
ApiRoleConfigGroup updateRoleConfigGroup(roleConfigGroupName, body, message)
Updates an existing role config group in the Authentication Service.
Updates an existing role config group in the Authentication Service.
// 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.AuthServiceRoleConfigGroupsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
AuthServiceRoleConfigGroupsResourceApi apiInstance = new AuthServiceRoleConfigGroupsResourceApi();
String roleConfigGroupName = "roleConfigGroupName_example"; // String | The name of the group to update.
ApiRoleConfigGroup body = new ApiRoleConfigGroup(); // ApiRoleConfigGroup | The updated role config group.
String message = "message_example"; // String | The optional message describing the changes.
try {
ApiRoleConfigGroup result = apiInstance.updateRoleConfigGroup(roleConfigGroupName, body, message);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AuthServiceRoleConfigGroupsResourceApi#updateRoleConfigGroup");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
roleConfigGroupName | String | The name of the group to update. | |
body | ApiRoleConfigGroup | The updated role config group. | [optional] |
message | String | The optional message describing the changes. | [optional] |