User

Get all Users

GET https://your.host.lab/my-team/users

Only for admin purposes

Query Parameters

Name	Type	Description
_offset	Integer	Default 0
_limit	Integer	Default 10
_search	String
role	String
status	String

200: OK

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1639110049,
    "count": 9,
    "data": [
        {
            "username":"test",
            "id": "75563251-d133-41fe-96c6-292d628c6ae9",
            "first_name": "T",
            "last_name": "111111",
            "role_id": "TEAM_OWNER",
            "created": 1637035187,
            "status": "ACTIVE"
        },
        {
            "username":"test",
            "id": "a958706e-4f27-4668-b419-6d53dc6371e4",
            "first_name": "T",
            "last_name": "2",
            "role_id": "TEAM_ADMIN",
            "status": "ACTIVE"
        },
        {
            "username":"test",
            "id": "0c7a22a7-8fd6-4181-a120-b25764efa553",
            "first_name": "T",
            "last_name": "3",
            "role_id": "PROJECT_ADMIN",
            "status": "ACTIVE"
        },
        {
            "username":"test",
            "id": "7c96e990-c913-4929-a785-82511a9ab084",
            "first_name": "T",
            "last_name": "5",
            "role_id": "GUEST",
            "status": "ACTIVE"
        },
        {
            "username":"test",
            "id": "88f5b642-63af-4130-a97a-95409997ccb9",
            "first_name": "T",
            "last_name": "4",
            "role_id": "LABELER",
            "status": "ACTIVE"
        },
        {
            "username":"test",
            "id": "66c1a1ae-4f21-4ffd-bf0c-842ebe8b479f",
            "first_name": "T",
            "last_name": "6",
            "role_id": "GUEST",
            "created": 1639103652,
            "status": "ACTIVE"
        },
        {
            "username":"test",
            "id": "e16ab6a4-7e1a-420e-a9f3-196733df19df",
            "first_name": "T",
            "last_name": "7",
            "role_id": "ANNOTATOR",
            "created": 1639103709,
            "status": "ACTIVE"
        },
        {
            "username":"test",
            "id": "3656cf7e-aa14-4656-95b2-fd50b8a83e62",
            "first_name": "T",
            "last_name": "7",
            "role_id": "LABELER",
            "created": 1639103738,
            "status": "ACTIVE"
        },
        {
            "username":"test",
            "id": "72ff0519-b416-4031-85c4-e2c412315c7a",
            "first_name": "T",
            "last_name": "10",
            "role_id": "WORKER",
            "created": 1639104302,
            "status": "ACTIVE"
        }
    ]
}

Create new User

POST https://your.host.lab/my-team/users

Request Body

Name	Type	Description
username*	String
first_name	String	Default is your username if input empty
last_name	String	Default is "" if input empty
password*	String
email
role	Boolean
is_temporary_password	Boolean	Default = true

201: Created

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1639104302,
    "data": "72ff0519-b416-4031-85c4-e2c412315c7a"
}

// Mockup bodys
{
    "username":"test",
    "first_name": "T",
    "last_name": "10",
    "password": "123123123123",
    "email": "",
    "role":"WORKER",
    "is_temporary_password":true
}

Get User

GET https://your.host.lab/my-team/users/{id}/info

Only for admin purposes

Query Parameters

Name	Type	Description
id*	String	Def

200: OK

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1639110596,
    "data": {
        "username":"test",
        "id": "75563251-d133-41fe-96c6-292d628c6ae9",
        "first_name": "T",
        "last_name": "111111",
        "role_id": "TEAM_OWNER",
        "created": 1637035187,
        "status": "ACTIVE"
    }
}

Edit user info

PUT https://your.host.lab/my-team/users/{id}/info

Only for admin purposes

Query Parameters

Name	Type	Description
first_name	String	Def
last_name	String
role	String
email	String
is_enabled	Boolean	Disable User or not

200: OK

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1639110596,
    "data": {
        "username":"test",
        "id": "75563251-d133-41fe-96c6-292d628c6ae9",
        "first_name": "T",
        "last_name": "111111",
        "role_id": "TEAM_OWNER",
        "created": 1637035187,
        "status": "ACTIVE"
    }
}

Edit user role

PUT https://your.host.lab/my-team/users/{id}/role

Only for admin purposes : Edit user role

Request Body

Name	Type	Description
role	String

200: OK

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1669346176,
    "data": "52601a43-9199-4f0a-b079-6dabff6c6471"
}

Permanent delete User from system

DELETE https://your.host.lab/my-team/users/{id}

Only for admin purposes

Path Parameters

Name	Type	Description
id*	String	User ID

200: OK

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1639110596,
    "data": {
        "username":"test",
        "id": "75563251-d133-41fe-96c6-292d628c6ae9",
        "first_name": "T",
        "last_name": "111111",
        "role_id": "TEAM_OWNER",
        "created": 1637035187,
        "status": "ACTIVE"
    }
}

Edit user password

PUT https://your.host.lab/my-team/users/{id}/password

Only for admin purposes

Request Body

Name	Type	Description
password*	String
is_temporary_password	Boolean	Default = true

200: OK

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1639110596,
    "data": {
        "username":"test",
        "id": "75563251-d133-41fe-96c6-292d628c6ae9",
        "first_name": "T",
        "last_name": "111111",
        "role_id": "TEAM_OWNER",
        "created": 1637035187,
        "status": "ACTIVE"
    }
}

Get User

GET https://your.host.lab/my-team/users/{id}/permissions

Only for admin purposes

Query Parameters

Name	Type	Description
id*	String	Def

200: OK

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1639110882,
    "data": [
        {
            "resource": "dataset",
            "scopes": [
                "import_annotations",
                "review_studies",
                "export_annotations",
                "upload_n_delete_study",
                "view_project_studies"
            ]
        },
        {
            "resource": "label_group",
            "scopes": [
                "create_edit_n_delete_label",
                "view_all",
                "create_edit",
                "view_owned",
                "delete",
                "edit_owner",
                "import_export_label"
            ]
        },
        {
            "resource": "project",
            "scopes": [
                "create_edit_n_archive",
                "access_basis",
                "view_all_projects",
                "add_user_to_project",
                "view_task_annotations",
                "view_owned_projects"
            ]
        },
        {
            "resource": "public",
            "scopes": [
                "access"
            ]
        },
        {
            "resource": "stats",
            "scopes": [
                "view_project_labels",
                "view_project_tasks",
                "view_project_studies",
                "view_project_labelers"
            ]
        },
        {
            "resource": "task",
            "scopes": [
                "approve_n_re_assign_tasks",
                "view_tasks_of_study",
                "assign_n_delete_tasks",
                "set_annotations",
                "view_project_tasks",
                "view_owned"
            ]
        },
        {
            "resource": "team",
            "scopes": [
                "create_n_delete_team",
                "create_n_delete_user",
                "assign_team_role"
            ]
        }
    ]
}

Edit User permissions

PUT https://your.host.lab/my-team/users/{id}/permissions

Only for admin purposes

Query Parameters

Name	Type	Description
id*	String	Def

200: OK

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1639110882,
    "data": [
        {
            "resource": "dataset",
            "scopes": [
                "a",
                "b",
                "c",
                "d",
                "e"
            ]
        }
    ]
}

// mock body
{
    "permissions":[
        "resource":"test",
        "scopes":[
            "a",
            "b",
            "c"
        ]
    ]
}