cm_client.RoleConfigGroupsResourceApi

All URIs are relative to https://localhost/api/v41

create_role_config_groups

ApiRoleConfigGroupList create_role_config_groups(cluster_name, service_name, body=body)

Creates new role config groups.

Creates new role config groups. It is not allowed to create base groups (base must be set to false.)

Available since API v3.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.RoleConfigGroupsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | 
body = cm_client.ApiRoleConfigGroupList() # ApiRoleConfigGroupList | The list of groups to be created. (optional)

try:
    # Creates new role config groups.
    api_response = api_instance.create_role_config_groups(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleConfigGroupsResourceApi->create_role_config_groups: %s\n" % e)

Parameters

Return type

ApiRoleConfigGroupList

Authorization

basic

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_role_config_group

ApiRoleConfigGroup delete_role_config_group(cluster_name, role_config_group_name, service_name)

Deletes a role config group.

Deletes a role config group.

Available since API v3.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.RoleConfigGroupsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
role_config_group_name = 'role_config_group_name_example' # str | The name of the group to delete.
service_name = 'service_name_example' # str | 

try:
    # Deletes a role config group.
    api_response = api_instance.delete_role_config_group(cluster_name, role_config_group_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleConfigGroupsResourceApi->delete_role_config_group: %s\n" % e)

Parameters

Return type

ApiRoleConfigGroup

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

move_roles

ApiRoleList move_roles(cluster_name, role_config_group_name, service_name, body=body)

Moves roles to the specified role config group.

Moves roles to the specified role config group. The roles can be moved from any role config group belonging to the same service. The role type of the destination group must match the role type of the roles.

Available since API v3.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.RoleConfigGroupsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
role_config_group_name = 'role_config_group_name_example' # str | The name of the group the roles will be moved to.
service_name = 'service_name_example' # str | 
body = cm_client.ApiRoleNameList() # ApiRoleNameList | The names of the roles to move. (optional)

try:
    # Moves roles to the specified role config group.
    api_response = api_instance.move_roles(cluster_name, role_config_group_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleConfigGroupsResourceApi->move_roles: %s\n" % e)

Parameters

Return type

ApiRoleList

Authorization

basic

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

move_roles_to_base_group

ApiRoleList move_roles_to_base_group(cluster_name, service_name, body=body)

Moves roles to the base role config group.

Moves roles to the base role config group. The roles can be moved from any role config group belonging to the same service. The role type of the roles may vary. Each role will be moved to its corresponding base group depending on its role type.

Available since API v3.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.RoleConfigGroupsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | 
body = cm_client.ApiRoleNameList() # ApiRoleNameList | The names of the roles to move. (optional)

try:
    # Moves roles to the base role config group.
    api_response = api_instance.move_roles_to_base_group(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleConfigGroupsResourceApi->move_roles_to_base_group: %s\n" % e)

Parameters

Return type

ApiRoleList

Authorization

basic

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read_config

ApiConfigList read_config(cluster_name, role_config_group_name, service_name, view=view)

Returns the current revision of the config for the specified role config group.

Returns the current revision of the config for the specified role config group.

Available since API v3.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.RoleConfigGroupsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
role_config_group_name = 'role_config_group_name_example' # str | The name of the role config group.
service_name = 'service_name_example' # str | 
view = 'summary' # str | The view of the data to materialize, either \"summary\" or \"full\". (optional) (default to summary)

try:
    # Returns the current revision of the config for the specified role config group.
    api_response = api_instance.read_config(cluster_name, role_config_group_name, service_name, view=view)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleConfigGroupsResourceApi->read_config: %s\n" % e)

Parameters

Return type

ApiConfigList

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read_role_config_group

ApiRoleConfigGroup read_role_config_group(cluster_name, role_config_group_name, service_name)

Returns the information for a role config group.

Returns the information for a role config group.

Available since API v3.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.RoleConfigGroupsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
role_config_group_name = 'role_config_group_name_example' # str | The name of the requested group.
service_name = 'service_name_example' # str | 

try:
    # Returns the information for a role config group.
    api_response = api_instance.read_role_config_group(cluster_name, role_config_group_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleConfigGroupsResourceApi->read_role_config_group: %s\n" % e)

Parameters

Return type

ApiRoleConfigGroup

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read_role_config_groups

ApiRoleConfigGroupList read_role_config_groups(cluster_name, service_name)

Returns the information for all role config groups for a given cluster and service.

Returns the information for all role config groups for a given cluster and service.

Available since API v3.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.RoleConfigGroupsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | 

try:
    # Returns the information for all role config groups for a given cluster and service.
    api_response = api_instance.read_role_config_groups(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleConfigGroupsResourceApi->read_role_config_groups: %s\n" % e)

Parameters

Return type

ApiRoleConfigGroupList

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read_roles

ApiRoleList read_roles(cluster_name, role_config_group_name, service_name)

Returns all roles in the given role config group.

Returns all roles in the given role config group.

Available since API v3.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.RoleConfigGroupsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
role_config_group_name = 'role_config_group_name_example' # str | The name of the role config group.
service_name = 'service_name_example' # str | 

try:
    # Returns all roles in the given role config group.
    api_response = api_instance.read_roles(cluster_name, role_config_group_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleConfigGroupsResourceApi->read_roles: %s\n" % e)

Parameters

Return type

ApiRoleList

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_config

ApiConfigList update_config(cluster_name, role_config_group_name, service_name, message=message, body=body)

Updates the config for the given role config group.

Updates the config for the given role config group.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.RoleConfigGroupsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
role_config_group_name = 'role_config_group_name_example' # str | The name of the role config group.
service_name = 'service_name_example' # str | 
message = 'message_example' # str | Optional message describing the changes. (optional)
body = cm_client.ApiConfigList() # ApiConfigList | The new config information for the group. (optional)

try:
    # Updates the config for the given role config group.
    api_response = api_instance.update_config(cluster_name, role_config_group_name, service_name, message=message, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleConfigGroupsResourceApi->update_config: %s\n" % e)

Parameters

Return type

ApiConfigList

Authorization

basic

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_role_config_group

ApiRoleConfigGroup update_role_config_group(cluster_name, role_config_group_name, service_name, message=message, body=body)

Updates an existing role config group.

Updates an existing role config group

Available since API v3.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.RoleConfigGroupsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
role_config_group_name = 'role_config_group_name_example' # str | The name of the group to update.
service_name = 'service_name_example' # str | 
message = 'message_example' # str | The optional message describing the changes. (optional)
body = cm_client.ApiRoleConfigGroup() # ApiRoleConfigGroup | The updated role config group. (optional)

try:
    # Updates an existing role config group.
    api_response = api_instance.update_role_config_group(cluster_name, role_config_group_name, service_name, message=message, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleConfigGroupsResourceApi->update_role_config_group: %s\n" % e)

Parameters

Return type

ApiRoleConfigGroup

Authorization

basic

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]