Access Roles Data Model

Advertencia

Esta página aún no se encuentra traducida al español.

COTAccessRole

Description

An access role is a set of permissions that can be assigned to a user. Permissions grant access to read or write in the administrative panel, database, and reports. They can also allow access to some surveys.

Sample JSON

{
    "_id": "611aa34dd0f0f9fa10b52dd3",
    "active": true,
    "permissions": [
        "admin-access",
        "admin-accesscontrol-read",
        "admin-answers-read",
        "admin-groups-read"
    ],
    "name": "Tester",
    "description": "Restricted admin access",
    "company": "611aa342e9f6fe9c2c13ce72"
}

Fields

Field	Description	Type	Notes
_id	The access role's unique ID number	ObjectId<COTAccessRole>
active	Indicates if the access role is active or not	boolean
permissions	Set of permissions available in the accessrole	string[ ]	List of default permissions
name	Display name	string
description	Discription given to the access role	string
company	Company's ID number	objectID<COTCompany>	Company Model

Additional Resources

• Access Roles Settings Panel: Access Roles settings in Administrative Panel
• "Access Role" REST API documentation: basic "Access Roles" API requests
• API documentation in Swagger: complete with data models (schemas)
• COTLang: use COTLang for extracting data from models in routines
• Triggers and Contexts: more information on using data models within routines

Help

• Cotalker Platform Community: post your questions or search for previous answers given in the forum