cm_client.AuthServiceRoleConfigGroupsResourceApi

All URIs are relative to /api/v58

read_config

ApiConfigList read_config(role_config_group_name, view=view)

Returns the current revision of the config for the specified role config group in the Authentication Service.

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.AuthServiceRoleConfigGroupsResourceApi(cm_client.ApiClient(configuration))
role_config_group_name = 'role_config_group_name_example' # str | The name of the role config group.
view = 'summary' # str | The view of the data to materialize, either \"summary\" or \"full\". (optional) (default to summary)

try:
    api_response = api_instance.read_config(role_config_group_name, view=view)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthServiceRoleConfigGroupsResourceApi->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(role_config_group_name)

Returns the information for a given role config group in the Authentication Service.

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.AuthServiceRoleConfigGroupsResourceApi(cm_client.ApiClient(configuration))
role_config_group_name = 'role_config_group_name_example' # str | The name of the requested group.

try:
    api_response = api_instance.read_role_config_group(role_config_group_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthServiceRoleConfigGroupsResourceApi->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()

Returns the information for all role config groups in the Authentication Service.

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.AuthServiceRoleConfigGroupsResourceApi(cm_client.ApiClient(configuration))

try:
    api_response = api_instance.read_role_config_groups()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthServiceRoleConfigGroupsResourceApi->read_role_config_groups: %s\n" % e)

Parameters

This endpoint does not need any parameter.

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(role_config_group_name)

Returns all roles in the given role config group in the Authentication Service.

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.AuthServiceRoleConfigGroupsResourceApi(cm_client.ApiClient(configuration))
role_config_group_name = 'role_config_group_name_example' # str | The name of the role config group.

try:
    api_response = api_instance.read_roles(role_config_group_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthServiceRoleConfigGroupsResourceApi->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(role_config_group_name, body=body, message=message)

Updates the config for the given role config group in the Authentication Service.

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.AuthServiceRoleConfigGroupsResourceApi(cm_client.ApiClient(configuration))
role_config_group_name = 'role_config_group_name_example' # str | The name of the role config group.
body = cm_client.ApiConfigList() # ApiConfigList | The new config information for the group. (optional)
message = 'message_example' # str | Optional message describing the changes. (optional)

try:
    api_response = api_instance.update_config(role_config_group_name, body=body, message=message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthServiceRoleConfigGroupsResourceApi->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(role_config_group_name, body=body, message=message)

Updates an existing role config group in the Authentication Service.

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.AuthServiceRoleConfigGroupsResourceApi(cm_client.ApiClient(configuration))
role_config_group_name = 'role_config_group_name_example' # str | The name of the group to update.
body = cm_client.ApiRoleConfigGroup() # ApiRoleConfigGroup | The updated role config group. (optional)
message = 'message_example' # str | The optional message describing the changes. (optional)

try:
    api_response = api_instance.update_role_config_group(role_config_group_name, body=body, message=message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthServiceRoleConfigGroupsResourceApi->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]