Admins /group/{group-id}/admins

The admin members of a group.

Reading

GET /group/{group-id}/admins HTTP/1.1
Host: localhost:3000

Permissions

  • The applied permissions to retrieve the parent group are required.

Fields

An array of User objects who are admin members of the group.

Publishing

POST /group/{group-id}/admins HTTP/1.1
Host: localhost:3000

Permissions

  • An access token (pointing to an user) with manage_groups permission is required.
  • At least one of the following criteria must be met :
    • The parent group is owned by the current person.
    • The current person is a admin member of the parent group.
    • The current person is an admin (with MANAGE permission) of the workspace at witch is attached the parent group.

Fields

Name Description Type

users

An array of User IDs at which set admin permission.
Must be some Users who are members of the group.

User[]

Response

If successful :

{
    "success": true
}

Otherwise a relevant error message will be returned.

Updating

You can't update admin members using this edge. If you want to unset admin permission to users, see the Deleting section.

Deleting

DELETE /group/{group-id}/admins HTTP/1.1
Host: localhost:3000

Permissions

  • The applied permissions to publish admin members are required.

Fields

Name Description Type

admins

An array of User IDs at which unset admin permission.
Must be some Users who are admin members of the group.

User[]

Response

If successful :

{
    "success": true
}

Otherwise a relevant error message will be returned.