cm_client.AuthRolesResourceApi

All URIs are relative to /api/v57

Method	HTTP request	Description
create_auth_roles	POST /authRoles	Creates a list of auth roles.
delete_auth_role	DELETE /authRoles/{uuid}	Deletes an auth role from the system.
read_auth_role	GET /authRoles/{uuid}	Returns detailed information about an auth role.
read_auth_roles	GET /authRoles	Returns a list of the auth roles configured in the system.
read_auth_roles_metadata	GET /authRoles/metadata	Returns a list of the auth roles' metadata for the built-in roles.
update_auth_role	PUT /authRoles/{uuid}	Updates the given auth role's information.

create_auth_roles

ApiAuthRoleList create_auth_roles(body=body)

Creates a list of auth roles.

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.AuthRolesResourceApi(cm_client.ApiClient(configuration))
body = cm_client.ApiAuthRoleList() # ApiAuthRoleList | List of auth roles to create. (optional)

try:
    # Creates a list of auth roles.
    api_response = api_instance.create_auth_roles(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthRolesResourceApi->create_auth_roles: %s\n" % e)

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

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

delete_auth_role

ApiAuthRole delete_auth_role(uuid)

Deletes an auth role from the system.

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.AuthRolesResourceApi(cm_client.ApiClient(configuration))
uuid = 'uuid_example' # str | The uuid of the auth role to delete.

try:
    # Deletes an auth role from the system.
    api_response = api_instance.delete_auth_role(uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthRolesResourceApi->delete_auth_role: %s\n" % e)

Parameters

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

Return type

ApiAuthRole

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_auth_role

ApiAuthRole read_auth_role(uuid)

Returns detailed information about an auth role.

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.AuthRolesResourceApi(cm_client.ApiClient(configuration))
uuid = 'uuid_example' # str | The auth role to read.

try:
    # Returns detailed information about an auth role.
    api_response = api_instance.read_auth_role(uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthRolesResourceApi->read_auth_role: %s\n" % e)

Parameters

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

Return type

ApiAuthRole

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_auth_roles

ApiAuthRoleList read_auth_roles(view=view)

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

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.AuthRolesResourceApi(cm_client.ApiClient(configuration))
view = 'summary' # str |  (optional) (default to summary)

try:
    # Returns a list of the auth roles configured in the system.
    api_response = api_instance.read_auth_roles(view=view)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthRolesResourceApi->read_auth_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
view	str		[optional] [default to summary]

Return type

ApiAuthRoleList

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_auth_roles_metadata

ApiAuthRoleMetadataList read_auth_roles_metadata(view=view)

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

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.AuthRolesResourceApi(cm_client.ApiClient(configuration))
view = 'summary' # str |  (optional) (default to summary)

try:
    # Returns a list of the auth roles' metadata for the built-in roles.
    api_response = api_instance.read_auth_roles_metadata(view=view)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthRolesResourceApi->read_auth_roles_metadata: %s\n" % e)

Parameters

Name	Type	Description	Notes
view	str		[optional] [default to summary]

Return type

ApiAuthRoleMetadataList

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_auth_role

ApiAuthRole update_auth_role(uuid, body=body)

Updates the given auth role's information.

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.AuthRolesResourceApi(cm_client.ApiClient(configuration))
uuid = 'uuid_example' # str | Uuid of the auth role being updated.
body = cm_client.ApiAuthRole() # ApiAuthRole | The auth role information. (optional)

try:
    # Updates the given auth role's information.
    api_response = api_instance.update_auth_role(uuid, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthRolesResourceApi->update_auth_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str	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

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