connect.groups
connect.groups
Group resources.
Classes
| Name | Description |
|---|---|
| Group | |
| Groups | Groups resource. |
Group
connect.groups.Group(self, /, params, **kwargs)
Methods
| Name | Description |
|---|---|
| delete | Delete the group. |
delete
connect.groups.Group.delete()
Delete the group.
Groups
connect.groups.Groups(self, params)
Groups resource.
Methods
| Name | Description |
|---|---|
| count | Count the number of groups. |
| create | Create a group. |
| find | Find groups. |
| find_one | Find one group. |
| get | Get group. |
count
connect.groups.Groups.count()
Count the number of groups.
Returns
| Type | Description |
|---|---|
| int |
create
connect.groups.Groups.create(**kwargs)
Create a group.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
name |
required | ||
unique_id |
required |
Returns
| Type | Description |
|---|---|
| Group |
find
connect.groups.Groups.find(**kwargs)
Find groups.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
prefix |
Filter by group name prefix. Casing is ignored. | required |
Returns
| Type | Description |
|---|---|
| List[Group] |
find_one
connect.groups.Groups.find_one(**kwargs)
Find one group.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
prefix |
Filter by group name prefix. Casing is ignored. | required |
Returns
| Type | Description |
|---|---|
| Group | None |
get
connect.groups.Groups.get(guid)
Get group.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
guid |
str | required |
Returns
| Type | Description |
|---|---|
| Group |