Permissions

The Permissions API provides operations for viewing workspace permissions, inspecting a Team Member’s permissions, updating permission policies, managing permission templates, and reviewing permission changes.

Endpoints

Method	Path	Purpose
GET	/auth/permissions	List Workspace permissions
GET	/auth/permissions/user/:userId	Get member permissions
GET	/auth/my-permissions	Get caller effective permissions
PUT	/auth/permissions/:userId	Update member permissions
POST	/auth/permissions/:userId/toggle-block	Block/unblock member access
GET	/auth/permission-templates/default	Get default Permission Templates
GET	/auth/permissions/templates	List Permission Templates
GET	/auth/permissions/templates/:id	Get Permission Template
POST	/auth/permissions/templates	Create Permission Template
PUT	/auth/permissions/templates/:id	Update Permission Template
DELETE	/auth/permissions/templates/:id	Delete Permission Template
GET	/auth/permissions/:userId/history	Get permission audit history
GET	/auth/history/:historyId	Get specific permission change

Updating Permissions

The permission map uses boolean values:

{

  “permissions”: {

    “<PERMISSION_CODE>”: true

  }

}

Permission Templates can also be created using:

{

  “policyName”: “Support Agent”,

  “policy”: {

    “<PERMISSION_CODE>”: true

  }

}

Important Distinction

Endpoint-level Permission Template operations belong here.

The conceptual explanation of Permission Templates belongs in:

[Reference → Permission Templates]

Need Help?

Email: support@ysdesk.com

Documentation: https://docs.ysplugins.com/ys-desk