Member Roles

Tags: members, permissions, roles

Member role and permission management

In the product: Roles

Resources

Request and response models used by the endpoints on this page.

CreateMemberRoleRequest

Field	Type	Required	Description
calendarAccess	Array<dict[str, int]>
dataTypeAccess	Array<dict[str, int]>
fileAccess	Array<dict[str, int]>
folderAccess	Array<dict[str, int]>
grantedScopes	Array
inboxAccess	Array<dict[str, int]>
name	String	✓
siteAccess	Array<dict[str, int]>
workflowAccess	Array<dict[str, int]>

Example:

{
  "name": "string"  // String,
  "grantedScopes": "string"  // Array<String>, optional,
  "siteAccess": {}  // Array<dict[str, int]>, optional,
  "dataTypeAccess": {}  // Array<dict[str, int]>, optional,
  "workflowAccess": {}  // Array<dict[str, int]>, optional,
  "inboxAccess": {}  // Array<dict[str, int]>, optional,
  "fileAccess": {}  // Array<dict[str, int]>, optional,
  "folderAccess": {}  // Array<dict[str, int]>, optional,
  "calendarAccess": {}  // Array<dict[str, int]>, optional
}

MemberRoleCalendarAccessResponse

Field	Type	Required	Description
accessMode	Integer	✓
calendarId	Integer	✓

Example:

{
  "calendarId": 0  // Integer,
  "accessMode": 0  // Integer
}

MemberRoleDataTypeAccessResponse

Field	Type	Required	Description
accessMode	Integer	✓
dataTypeId	Integer	✓

Example:

{
  "dataTypeId": 0  // Integer,
  "accessMode": 0  // Integer
}

MemberRoleFileAccessResponse

Field	Type	Required	Description
accessMode	Integer	✓
fileId	Integer	✓

Example:

{
  "fileId": 0  // Integer,
  "accessMode": 0  // Integer
}

MemberRoleFolderAccessResponse

Field	Type	Required	Description
accessMode	Integer	✓
folderId	Integer	✓

Example:

{
  "folderId": 0  // Integer,
  "accessMode": 0  // Integer
}

MemberRoleInboxAccessResponse

Field	Type	Required	Description
accessMode	Integer	✓
inboxId	Integer	✓

Example:

{
  "inboxId": 0  // Integer,
  "accessMode": 0  // Integer
}

MemberRoleResponse

Field	Type	Required	Description
calendarAccess	Array		Default: []
createdAt	DateTime	✓
dataTypeAccess	Array		Default: []
fileAccess	Array		Default: []
folderAccess	Array		Default: []
grantedScopes	Array		Default: []
id	Integer	✓
inboxAccess	Array		Default: []
isDefaultForNewMembers	Boolean		Default: False
memberCount	Integer		Default: 0
name	String	✓
siteAccess	Array		Default: []
updatedAt	DateTime	✓
uuid	String	✓
workflowAccess	Array		Default: []

Example:

{
  "id": 0  // Integer,
  "uuid": "string"  // String,
  "name": "string"  // String,
  "grantedScopes": "string"  // Array<String>, optional, default: [],
  "siteAccess": []  // Array<MemberRoleSiteAccessResponse>, optional, default: [],
  "dataTypeAccess": []  // Array<MemberRoleDataTypeAccessResponse>, optional, default: [],
  "workflowAccess": []  // Array<MemberRoleWorkflowAccessResponse>, optional, default: [],
  "inboxAccess": []  // Array<MemberRoleInboxAccessResponse>, optional, default: [],
  "fileAccess": []  // Array<MemberRoleFileAccessResponse>, optional, default: [],
  "folderAccess": []  // Array<MemberRoleFolderAccessResponse>, optional, default: [],
  "calendarAccess": []  // Array<MemberRoleCalendarAccessResponse>, optional, default: [],
  "memberCount": 0  // Integer, optional, default: 0,
  "isDefaultForNewMembers": false  // Boolean, optional, default: False,
  "createdAt": "2024-01-01T00:00:00Z"  // DateTime,
  "updatedAt": "2024-01-01T00:00:00Z"  // DateTime
}

MemberRoleSiteAccessResponse

Field	Type	Required	Description
accessMode	Integer	✓
siteId	Integer	✓

Example:

{
  "siteId": 0  // Integer,
  "accessMode": 0  // Integer
}

MemberRoleWorkflowAccessResponse

Field	Type	Required	Description
accessMode	Integer	✓
workflowId	Integer	✓

Example:

{
  "workflowId": 0  // Integer,
  "accessMode": 0  // Integer
}

UpdateMemberRoleRequest

Field	Type	Required	Description
calendarAccess	Array<dict[str, int]>
dataTypeAccess	Array<dict[str, int]>
fileAccess	Array<dict[str, int]>
folderAccess	Array<dict[str, int]>
grantedScopes	Array
inboxAccess	Array<dict[str, int]>
name	String
siteAccess	Array<dict[str, int]>
workflowAccess	Array<dict[str, int]>

Example:

{
  "name": "string"  // String, optional,
  "grantedScopes": "string"  // Array<String>, optional,
  "siteAccess": {}  // Array<dict[str, int]>, optional,
  "dataTypeAccess": {}  // Array<dict[str, int]>, optional,
  "workflowAccess": {}  // Array<dict[str, int]>, optional,
  "inboxAccess": {}  // Array<dict[str, int]>, optional,
  "fileAccess": {}  // Array<dict[str, int]>, optional,
  "folderAccess": {}  // Array<dict[str, int]>, optional,
  "calendarAccess": {}  // Array<dict[str, int]>, optional
}

Endpoints

• GET /api/v2/w/{workspace_uuid}/member-roles - List
• POST /api/v2/w/{workspace_uuid}/member-roles - Create
• GET /api/v2/w/{workspace_uuid}/member-roles/{role_id_or_uuid} - Get Role Id Or Uuid
• DELETE /api/v2/w/{workspace_uuid}/member-roles/{role_id} - Delete Role Id
• PUT /api/v2/w/{workspace_uuid}/member-roles/{role_id} - Update Role Id

List

GET /api/v2/w/{workspace_uuid}/member-roles

Description:

List all member roles.

Authorization: Requires member-roles:read scope

Response: List of MemberRoleResponse

---

Create

POST /api/v2/w/{workspace_uuid}/member-roles

Description:

Create a new member role.

Authorization: Requires member-roles:admin scope

Parameters:

• request - See CreateMemberRoleRequest

Response: See MemberRoleResponse

---

Get Role Id Or Uuid

GET /api/v2/w/{workspace_uuid}/member-roles/{role_id_or_uuid}

Description:

Get a specific member role by ID or UUID. Users can view their own role, managers can view any role.

Authorization: Requires member-roles:read scope

Parameters:

• role_id_or_uuid (String)

Response: See MemberRoleResponse

---

Delete Role Id

DELETE /api/v2/w/{workspace_uuid}/member-roles/{role_id}

Description:

Delete a member role.

Authorization: Requires member-roles:admin scope

Parameters:

• role_id (Integer)

Response: See None

---

Update Role Id

PUT /api/v2/w/{workspace_uuid}/member-roles/{role_id}

Description:

Update an existing member role.

Authorization: Requires member-roles:admin scope

Parameters:

• role_id (Integer)
• request - See UpdateMemberRoleRequest

Response: See MemberRoleResponse

---