Unicat API Reference

Up - API Reference - Home

data cc.projects_members

A project-member combination defines what privileges a user has for a particular project, and some options regarding usage.

The returned list will have a project/user gid combination per entry.

Projects-Members data

{
    …,
    "data": {
        "cc.projects_members": [
            {
                "project_gid": "84a1b5e4-fb5d-4ad6-a497-a3cf5eaf29b1",
                "user_gid": "d05ba499-df89-4de3-9d83-c68b64c3856b",
                "status": "active",
                "roles": [
                    "owner"
                ],
                "options": {
                    "notifications": {
                        "email": "name@website.com",
                        "events": [
                            "all"
                        ],
                        "frequency": "immediate"
                    },
                    "rate_limit_per_second": null
                }
            }
        ]
    }
}

Projects-Members properties

project_gid global identifier for the project
user_gid global identifier for the user
status only active users for this project can access it
roles a list of roles for this user - for now we support owner and member
options a collection of additional values, described below

options

notifications indicates how and how often the user will receive notifications for this project - current example has placeholder data, the actual information will be defined at a later stage
rate_limit_per_second limit how often a user can access the api - to be implemented