openstack.identity.v3.group

The Group Class

The Group class inherits from Resource.

class openstack.identity.v3.group.Group

The base resource

Parameters:

• _synchronized (bool) – This is not intended to be used directly. See new() and existing().

• connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of self._connection in Resource code should protect itself with a check for None.

resource_key: str | None = 'group'

Singular form of key for resource.

resources_key: str | None = 'groups'

Plural form of key for resource.

base_path: str = '/groups'

The base part of the URI for this resource.

allow_create = True

Allow create operation for this resource.

allow_fetch = True

Allow get operation for this resource.

allow_commit = True

Allow update operation for this resource.

allow_delete = True

Allow delete operation for this resource.

allow_list = True

Allow list operation for this resource.

commit_method: Literal['POST', 'PATCH', 'PUT'] = 'PATCH'

Method for committing a resource. This must be PATCH if allow_patch is True.

description

The description of this group. Type: string

domain_id

References the domain ID which owns the group; if a domain ID is not specified by the client, the Identity service implementation will default it to the domain ID to which the client’s token is scoped. Type: string

name: str

Unique group name, within the owning domain. Type: string

add_user(session, user)

Add user to the group

remove_user(session, user)

Remove user from the group

check_user(session, user)

Check whether user belongs to group

last updated: UTC - commit: