Group Management APIs

From Social ID Developers
(Difference between revisions)
Jump to: navigation, search
(Created page with "== Groups == {| ! align="left" width="400px"| Resource ! align="left"| Description |- | GET groups | Search Groups in the Account. |- | POST groups | Creates a new Gr...")
 
 
(7 intermediate revisions by one user not shown)
Line 6: Line 6:
 
|-
 
|-
 
| [[GET groups]]
 
| [[GET groups]]
| Search Groups in the Account.
+
| Searches for Groups.
 
|-
 
|-
 
| [[POST groups]]
 
| [[POST groups]]
| Creates a new Group.
+
| Creates a Group.
 
|-
 
|-
 
|[[GET groups/:group_id]]
 
|[[GET groups/:group_id]]
Line 28: Line 28:
 
|-
 
|-
 
| [[GET groups/:group_id/users]]
 
| [[GET groups/:group_id/users]]
| Returns all Users from a Group.
+
| Searches for Users in a Group.
 
|-
 
|-
 
| [[POST groups/:group_id/users]]
 
| [[POST groups/:group_id/users]]
Line 35: Line 35:
 
|[[DELETE groups/:group_id/users/:user_id]]
 
|[[DELETE groups/:group_id/users/:user_id]]
 
| Removes a User from a Group.
 
| Removes a User from a Group.
 +
|}
 +
 +
== Group Parents ==
 +
 +
{|
 +
! align="left" width="400px"| Resource
 +
! align="left"| Description
 +
|-
 +
| [[GET groups/:group_id/parent_groups]]
 +
| Searches for Group Parents of a Group.
 +
|-
 +
| [[POST groups/:group_id/parent_groups]]
 +
| Adds a Group Parent to a Group.
 +
|-
 +
|[[DELETE groups/:group_id/parent_groups/:parent_group_id]]
 +
| Removes a Group Parent from a Group.
 +
|}
 +
 +
== Group Children ==
 +
 +
{|
 +
! align="left" width="400px"| Resource
 +
! align="left"| Description
 +
|-
 +
| [[GET groups/:group_id/child_groups]]
 +
| Searches for Group Children of a Group.
 +
|}
 +
 +
== Group Managers ==
 +
 +
{|
 +
! align="left" width="400px"| Resource
 +
! align="left"| Description
 +
|-
 +
| [[GET groups/:group_id/manager_groups]]
 +
| Searches for Group Managers of a Group.
 +
|-
 +
| [[POST groups/:group_id/manager_groups]]
 +
| Adds a Group Manager to a Group.
 +
|-
 +
|[[DELETE groups/:group_id/manager_groups/:manager_group_id]]
 +
| Removes a Group Manager from a Group.
 +
|}
 +
 +
== Group Managees ==
 +
 +
{|
 +
! align="left" width="400px"| Resource
 +
! align="left"| Description
 +
|-
 +
| [[GET groups/:group_id/managed_groups]]
 +
| Searches for Group Managees of a Group.
 
|}
 
|}

Latest revision as of 17:26, 8 March 2024

Contents

Groups

Resource Description
GET groups Searches for Groups.
POST groups Creates a Group.
GET groups/:group_id Returns a Group.
PUT groups/:group_id Updates a Group.
DELETE groups/:group_id Removes a Group.

Group Users

Resource Description
GET groups/:group_id/users Searches for Users in a Group.
POST groups/:group_id/users Adds a User to a Group.
DELETE groups/:group_id/users/:user_id Removes a User from a Group.

Group Parents

Resource Description
GET groups/:group_id/parent_groups Searches for Group Parents of a Group.
POST groups/:group_id/parent_groups Adds a Group Parent to a Group.
DELETE groups/:group_id/parent_groups/:parent_group_id Removes a Group Parent from a Group.

Group Children

Resource Description
GET groups/:group_id/child_groups Searches for Group Children of a Group.

Group Managers

Resource Description
GET groups/:group_id/manager_groups Searches for Group Managers of a Group.
POST groups/:group_id/manager_groups Adds a Group Manager to a Group.
DELETE groups/:group_id/manager_groups/:manager_group_id Removes a Group Manager from a Group.

Group Managees

Resource Description
GET groups/:group_id/managed_groups Searches for Group Managees of a Group.
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox