Package cm_api :: Package endpoints :: Module users :: Class ApiUser

Class ApiUser

         object --+    
                  |    
types.BaseApiObject --+
                      |
                     ApiUser

Instance Methods

[hide private]

__init__(self, resource_root, name=None, password=None, roles=None)
Initializes internal state and sets all known writable properties of the object to None.

source code

grant_admin_role(self)
Grant admin access to a user.

source code

revoke_admin_role(self)
Revoke admin access from a user.

source code

Inherited from types.BaseApiObject: __setattr__, __str__, to_json_dict

Inherited from types.BaseApiObject (private): _check_attr, _get_resource_root, _require_min_api_version, _set_attrs, _update

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __sizeof__, __subclasshook__

Class Methods

[hide private]

Inherited from types.BaseApiObject: from_json_dict

Inherited from types.BaseApiObject (private): _get_attributes

Static Methods

[hide private]

Inherited from types.BaseApiObject: init

Class Variables

[hide private]

_ATTRIBUTES = {'name': None, 'password': None, 'roles': None}

Inherited from types.BaseApiObject (private): _WHITELIST

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, resource_root, name=None, password=None, roles=None)
(Constructor)

source code

Initializes internal state and sets all known writable properties of the object to None. Then initializes the properties given in the provided attributes dictionary.

Parameters:

resource_root - API resource object.
attrs - optional dictionary of attributes to set. This should only contain r/w attributes.

Overrides: object.__init__

(inherited documentation)

grant_admin_role(self)

source code

Grant admin access to a user. If the user already has admin access, this does nothing.

Returns:: An ApiUser object

revoke_admin_role(self)

source code

Revoke admin access from a user. If the user does not have admin access, this does nothing.

Returns:: An ApiUser object

Class ApiUser

__init__(self, resource_root, name=None, password=None, roles=None) (Constructor)

grant_admin_role(self)

revoke_admin_role(self)

init(self, resource_root, name=None, password=None, roles=None)
(Constructor)