Collaborator API
Get collaboratorâ
Retrieve the details of an app's collaborator.
GET /api/apps/:app_id/collaborators/:user_id
Paramtersâ
info
Authentication required and the user must have global developer or app developer permissions.
Attribute | Type | Required | Description |
---|---|---|---|
app_id | Integer | true | App ID |
user_id | Integer | true | User ID |
Return bodyâ
{
"id": 6,
"username": "foo",
"email": "foo@zealot.com",
"role": "user"
}
Add collaboratorâ
Add an existing user to the app's collaborators list.
Paramtersâ
info
Authentication required and the user must have global developer or app developer permissions.
Attribute | Type | Required | Description |
---|---|---|---|
app_id | Integer | true | App ID |
user_id | Integer | true | User ID |
Return bodyâ
- Return 404 if channel not existed.
- Return 201 and response body if successful
{
"id": 6,
"username": "foo",
"email": "foo@zealot.com",
"role": "user"
}
Edit collaborator's roleâ
Edit collaborator's role.
PUT /api/apps/:app_id/collaborators/:user_id
Paramtersâ
info
Authentication required and the user must have global developer or app developer permissions.
Attribute | Type | Required | Description |
---|---|---|---|
app_id | Integer | true | App ID |
user_id | Integer | true | User ID |
role | String | true | User role, defaults to "user", options are user/developer/admin |
Return bodyâ
{
"id": 6,
"username": "foo",
"email": "foo@zealot.com",
"role": "developer"
}
Remove collaboratorâ
Remove a collaborator from app.
DELETE /api/apps/:app_id/collaborators/:user_id
Paramtersâ
info
Authentication required and the user must have global developer or app developer permissions.
Attribute | Type | Required | Description |
---|---|---|---|
app_id | Integer | true | App ID |
user_id | Integer | true | User ID |
Return bodyâ
- Return 404 if app not existed.
- Return 200 if success.