tcms.rpc.api.group module

tcms.rpc.api.group.filter(query)[source]
RPC Group.filter(query)

Search and return the resulting list of groups.

Parameters:

query (dict) – Field lookups for django.contrib.auth.models.Group

Returns:

Serialized list of django.contrib.auth.models.Group objects

Return type:

list(dict)

Raises:

PermissionDenied – if missing the auth.view_group permission

Added in version 15.3.

tcms.rpc.api.group.permissions(group_id)[source]
RPC Group.permissions(query)

Search and return the resulting list of permissions for a particular group.

Parameters:

group_id (int) – PK for a django.contrib.auth.models.Group object

Returns:

Serialized list of permission labels

Return type:

list(str)

Raises:

  • PermissionDenied – if missing the auth.view_group permission

  • DoesNotExist – if group doesn’t exist

Added in version 15.3.

tcms.rpc.api.group.users(group_id)[source]
RPC Group.users(group_id)

Return the list of users for a particular group.

Parameters:

group_id (int) – PK for a django.contrib.auth.models.Group object

Returns:

Serialized list of django.contrib.auth.models.User objects

Return type:

list(dict)

Raises:

  • PermissionDenied – if missing the auth.view_group permission

  • PermissionDenied – if missing the auth.view_user permission

  • DoesNotExist – if group doesn’t exist

Added in version 15.3.