Files
python-keystoneclient/keystoneclient/v3/groups.py
J. Matt Peterson 5d93e928d0 Refactor v3 API to support filtering
Fixes: bug #1175356

Future implementations of keystone API v3 will support server-side
filtering using key/value attributes. See additional details:
https://github.com/openstack/identity-api/blob/master/openstack-identity-api/src/markdown/identity-api-v3.md#list-entities-filtered-by-attribute

To support this functionality **kwargs need to be passed from the
v3 API classes to keystoneclient.base.CrudManager.list.

This is not fully implemented server-side for all attributes so it's difficult to
document exactly which attributes will work. An example of a working attribute is:
keystone.users.list(name="someone")

Change-Id: I148093fbe37700f890ed44148aa3f63f34ee5ff5
2013-05-06 15:28:39 -07:00

88 lines
2.6 KiB
Python

# Copyright 2011 OpenStack LLC.
# Copyright 2011 Nebula, Inc.
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from keystoneclient import base
class Group(base.Resource):
"""Represents an Identity user group.
Attributes:
* id: a uuid that identifies the group
* name: group name
* description: group description
"""
def update(self, name=None, description=None):
kwargs = {
'name': name if name is not None else self.name,
'description': (description
if description is not None
else self.description),
}
try:
retval = self.manager.update(self.id, **kwargs)
self = retval
except Exception:
retval = None
return retval
class GroupManager(base.CrudManager):
"""Manager class for manipulating Identity groups."""
resource_class = Group
collection_key = 'groups'
key = 'group'
def create(self, name, domain=None, description=None):
return super(GroupManager, self).create(
name=name,
domain_id=base.getid(domain),
description=description)
def list(self, user=None, **kwargs):
"""List groups.
If user is provided, then filter groups with
that attribute.
If ``**kwargs`` are provided, then filter groups with
attributes matching ``**kwargs``.
"""
if user:
base_url = '/users/%s' % base.getid(user)
else:
base_url = None
return super(GroupManager, self).list(
base_url=base_url,
**kwargs)
def get(self, group):
return super(GroupManager, self).get(
group_id=base.getid(group))
def update(self, group, name=None, description=None):
return super(GroupManager, self).update(
group_id=base.getid(group),
name=name,
description=description)
def delete(self, group):
return super(GroupManager, self).delete(
group_id=base.getid(group))