mirror of
https://github.com/YunoHost-Apps/kanboard_ynh.git
synced 2024-09-03 19:36:17 +02:00
152 lines
2.4 KiB
Markdown
152 lines
2.4 KiB
Markdown
Group Member API Procedures
|
|
===========================
|
|
|
|
## getGroupMembers
|
|
|
|
- Purpose: **Get all members of a group**
|
|
- Parameters:
|
|
- **group_id** (integer, required)
|
|
- Result on success: **List of users**
|
|
- Result on failure: **false**
|
|
|
|
Request example:
|
|
|
|
```json
|
|
{
|
|
"jsonrpc": "2.0",
|
|
"method": "getGroupMembers",
|
|
"id": 1987176726,
|
|
"params": [
|
|
"1"
|
|
]
|
|
}
|
|
```
|
|
|
|
Response example:
|
|
|
|
```json
|
|
{
|
|
"jsonrpc": "2.0",
|
|
"id": 1987176726,
|
|
"result": [
|
|
{
|
|
"group_id": "1",
|
|
"user_id": "1",
|
|
"id": "1",
|
|
"username": "admin",
|
|
"is_ldap_user": "0",
|
|
"name": null,
|
|
"email": null,
|
|
"notifications_enabled": "0",
|
|
"timezone": null,
|
|
"language": null,
|
|
"disable_login_form": "0",
|
|
"notifications_filter": "4",
|
|
"nb_failed_login": "0",
|
|
"lock_expiration_date": "0",
|
|
"is_project_admin": "0",
|
|
"gitlab_id": null,
|
|
"role": "app-admin"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
## addGroupMember
|
|
|
|
- Purpose: **Add a user to a group**
|
|
- Parameters:
|
|
- **group_id** (integer, required)
|
|
- **user_id** (integer, required)
|
|
- Result on success: **true**
|
|
- Result on failure: **false**
|
|
|
|
Request example:
|
|
|
|
```json
|
|
{
|
|
"jsonrpc": "2.0",
|
|
"method": "addGroupMember",
|
|
"id": 1589058273,
|
|
"params": [
|
|
1,
|
|
1
|
|
]
|
|
}
|
|
```
|
|
|
|
Response example:
|
|
|
|
```json
|
|
{
|
|
"jsonrpc": "2.0",
|
|
"id": 1589058273,
|
|
"result": true
|
|
}
|
|
```
|
|
|
|
## removeGroupMember
|
|
|
|
- Purpose: **Remove a user from a group**
|
|
- Parameters:
|
|
- **group_id** (integer, required)
|
|
- **user_id** (integer, required)
|
|
- Result on success: **true**
|
|
- Result on failure: **false**
|
|
|
|
Request example:
|
|
|
|
```json
|
|
{
|
|
"jsonrpc": "2.0",
|
|
"method": "removeGroupMember",
|
|
"id": 1730416406,
|
|
"params": [
|
|
1,
|
|
1
|
|
]
|
|
}
|
|
```
|
|
|
|
Response example:
|
|
|
|
```json
|
|
{
|
|
"jsonrpc": "2.0",
|
|
"id": 1730416406,
|
|
"result": true
|
|
}
|
|
```
|
|
|
|
## isGroupMember
|
|
|
|
- Purpose: **Check if a user is member of a group**
|
|
- Parameters:
|
|
- **group_id** (integer, required)
|
|
- **user_id** (integer, required)
|
|
- Result on success: **true**
|
|
- Result on failure: **false**
|
|
|
|
Request example:
|
|
|
|
```json
|
|
{
|
|
"jsonrpc": "2.0",
|
|
"method": "isGroupMember",
|
|
"id": 1052800865,
|
|
"params": [
|
|
1,
|
|
1
|
|
]
|
|
}
|
|
```
|
|
|
|
Response example:
|
|
|
|
```json
|
|
{
|
|
"jsonrpc": "2.0",
|
|
"id": 1052800865,
|
|
"result": false
|
|
}
|
|
```
|