Unicat API Reference

Up - API Reference - Home

/api/p/<project gid>/members/deactivate

Requires JWT.

Deactivate a member.

A deactivated user can no longer access the project.

Only works on active members.

Only the owner of the project can deactivate members.

Request

POST /api/p/<project gid>/members/deactivate
Authorization: Bearer <JWT>

{
    "user": "<user gid>",
}

user a member's gid.

Success response

Authorization: <JWT>

{
    "success": true,
    "result": {
        "user": "b76f701d-3d34-4f39-8eeb-fafe294ab01e",
    },
    "data": {
        "cc.users": {
            "b76f701d-3d34-4f39-8eeb-fafe294ab01e": {
                "gid": "b76f701d-3d34-4f39-8eeb-fafe294ab01e",
                "name": "Unicat",
                "avatar": "96ec02b2-fb8d-4fb4-b952-fad0c4b88a74.jpg",
                "username": "unicat"
            },
        },
        "cc.projects_members": [
            {
                "project_gid": "<project gid>",
                "user_gid": "b76f701d-3d34-4f39-8eeb-fafe294ab01e",
                "status": "inactive",
                "roles": [
                    "member"
                ],
                "options": {
                    "language": "en",
                    "timezone": "Europe/Amsterdam"
                }
            }
        ]
    }
}

result

user is the member user's gid.

data

cc.users is a dictionary with an entry for the user.
cc.projects_members is a list with metadata for the member.

Error responses

401 Unauthorized - missing or expired JWT
403 Forbidden - not the owner of this project
422 Unprocessable entity - deactivation failed