Skip to content

Commit 6271f50

Browse files
author
kmidkiff
committed
permissions table
1 parent 2a01cc1 commit 6271f50

File tree

2 files changed

+136
-1
lines changed

2 files changed

+136
-1
lines changed

‎docs/permissions.md

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
Permissions are the ability to access an action within the app. Every permission corresponds to an API call from our REST API.
2+
Don't feel intimidated by the following table, for most users the default roles and permissions will be suitable. This information is here if you do wish to modify your roles.
3+
4+
| Permission Name | Description |
5+
| ------------- |:-------------:|
6+
| get_users | Gets all Users |
7+
| get_users_own | Gets the User object of the requester |
8+
| get_users_search | Gets all Users by search |
9+
| get_users_id | Gets all Users |
10+
| put_users_id | Updates a User |
11+
| delete_users_id | Deletes a User |
12+
| get_users_id_avatar | Gets User Avatar |
13+
| put_users_id_avatar | Adds a User Avatar |
14+
| post_users_register | Registers a new User |
15+
| post_users_id_suspend | Suspend the User |
16+
| post_users_invite | Invites a new User |
17+
| get_funds | Gets all funds |
18+
| post_funds | Create new fund |
19+
| get_funds_own | Gets users own funds |
20+
| get_funds_search | Gets all funds by search |
21+
| get_funds_id | Gets fund |
22+
| put_funds_id | Updates a fund |
23+
| get_roles | Gets all roles |
24+
| post_roles | Create new role |
25+
| get_roles_search | Gets all roles by search |
26+
| get_roles_id | Gets all roles |
27+
| put_roles_id | Updates a role |
28+
| delete_roles_id | Deletes a role |
29+
| get_roles_manage_permissions | Gets all roles with permissions |
30+
| post_roles_manage_permissions | Update role with permission |
31+
| get_service_templates | Gets all service-templates |
32+
| post_service_templates | Create new service-template |
33+
| get_service_templates_public | Gets all public service-templates |
34+
| get_service_templates_search | Gets all service-templates by search |
35+
| get_service_templates_id | Gets all service-templates |
36+
| put_service_templates_id | Updates a service_templates |
37+
| delete_service_templates_id | Deletes a service-template |
38+
| get_service_templates_id_icon | Gets Service Template Icon |
39+
| put_service_templates_id_icon | Adds a Service Template Icon |
40+
| get_service_templates_id_image | Gets Service Template Image |
41+
| put_service_templates_id_image | Adds a Service Template Image |
42+
| get_service_templates_id_request | Gets a service-template Request |
43+
| put_service_templates_id_request | Requests a service-instance |
44+
| get_service_categories | Gets all service-categories |
45+
| post_service_categories | Create new service-category |
46+
| get_service_categories_search | Gets all service-categories by search |
47+
| get_service_categories_id | Gets all service-categories |
48+
| put_service_categories_id | Updates a service-category |
49+
| delete_service_categories_id | Deletes a service-category |
50+
| get_service_template_properties | Gets all service-template-properties |
51+
| post_service_template_properties | Create new service-template-property |
52+
| get_service_template_properties_search | Gets all service-template-properties by search |
53+
| get_service_template_properties_id | Gets all service-template-properties |
54+
| put_service_template_properties_id | Updates a service-template-property |
55+
| delete_service_template_properties_id | Deletes a service-template-property |
56+
| get_service_instances | Gets all service-instances |
57+
| get_service_instances_own | Gets all service-instances owned by user |
58+
| get_service_instances_search | Gets all service-instances by search |
59+
| get_service_instances_id | Get a service-instance by id |
60+
| put_service_instances_id | Updates a service-instance |
61+
| delete_service_instances_id | Deletes a service-instance |
62+
| post_service_instances_id_approve | Approves a service-instance |
63+
| post_service_instances_id_change_price | Approves a service-instance |
64+
| post_service_instances_id_cancel | Cancel a service-instance |
65+
| post_service_instances_id_request_cancellation | Request Cancellation of a service-instance |
66+
| post_service_instances_id_add_charge | Add a charge to a service-instance |
67+
| get_service_instances_id_awaiting_charges | Get service-instance awaiting charges |
68+
| post_service_instances_id_approve_charges | Approve a service-instance charges |
69+
| post_service_instances_id_files | Add a service-instance Files |
70+
| get_service_instances_id_files | Get service-instance files |
71+
| delete_service_instances_id_files_fid | Add a service-instance Files |
72+
| get_service_instances_id_files_fid | Get service-instance files |
73+
| get_service_instance_properties | Gets all service-instance-properties |
74+
| post_service_instance_properties | Create newservice-instance-properties |
75+
| get_service_instance_properties_search | Gets all service-instance-properties by search |
76+
| get_service_instance_properties_id | Gets all service-instance-properties |
77+
| put_service_instance_properties_id | Updates aservice-instance-properties |
78+
| delete_service_instance_properties_id | Deletes aservice-instance-properties |
79+
| get_service_instance_messages | Gets all service-instance-messages |
80+
| post_service_instance_messages | Create newservice-instance-messages |
81+
| get_service_instance_messages_search | Gets all service-instance-messages by search |
82+
| get_service_instance_messages_id | Gets all service-instance-messages |
83+
| put_service_instance_messages_id | Updates aservice-instance-messages |
84+
| delete_service_instance_messages_id | Deletes aservice-instance-messages |
85+
| get_service_instance_cancellations | Gets all service-instance-cancellations |
86+
| post_service_instance_cancellations | Create new service-instance-cancellations |
87+
| get_service_instance_cancellations_own | Gets all service-instance-cancellations owned by user |
88+
| get_service_instance_cancellations_search | Gets all service-instance-cancellations by search |
89+
| get_service_instance_cancellations_id | Gets all service-instance-cancellations |
90+
| put_service_instance_cancellations_id | Updates a service-instance-cancellation |
91+
| delete_service_instance_cancellations_id | Deletes a service-instance-cancellation |
92+
| post_service_instance_cancellations_id_approve | Approves a service-instance-cancellations |
93+
| post_service_instance_cancellations_id_reject | Rejects a service-instance-cancellations |
94+
| post_service_instance_cancellations_id_undo | Rejects a service-instance-cancellations for the user who created it |
95+
| get_event_logs | Gets all Event Logs |
96+
| post_event_logs | Create new Event Log |
97+
| get_event_logs_search | Gets all Event Logs by search |
98+
| get_event_logs_id | Gets all Event Logs |
99+
| put_event_logs_id | Updates a Event Log |
100+
| delete_event_logs_id | Deletes a Event Log |
101+
| get_email_templates | Gets all Email Templates |
102+
| post_email_templates | Create new Email Template |
103+
| get_email_templates_search | Gets all Email Templates by search |
104+
| get_email_templates_id | Gets all Email Templates |
105+
| put_email_templates_id | Updates a Email Template |
106+
| delete_email_templates_id | Deletes a Email Template |
107+
| get_email_templates_id_roles | Gets Email Template Roles |
108+
| put_email_templates_id_roles | Updates an Email Template Role |
109+
| get_invoices | Gets all Invoices |
110+
| get_invoices_own | Gets all Invoices owned by user |
111+
| get_invoices_search | Gets all Invoices by search |
112+
| get_invoices_id | Gets all Invoices |
113+
| get_invoices_upcoming_id | Gets upcoming Invoices |
114+
| post_invoices_id_refund | Performs refund on Invoice |
115+
| get_system_options | Gets all System Options |
116+
| put_system_options | Batch Updates System Options |
117+
| get_system_options_public | Gets all public System Options |
118+
| get_system_options_id | Gets a System Option |
119+
| put_system_options_id | Updates a System Option |
120+
| get_system_options_file_id | Gets a System File Options |
121+
| put_system_options_file_id | Updates a System Option |
122+
| post_charge_id_approve | Approves a Charge Item |
123+
| post_charge_id_cancel | Cancels a Charge Item |
124+
| post_auth_token | Gets a Authorization Token |
125+
| post_auth_session_clear | Clears session |
126+
| post_auth_reset_password | Send Reset password email |
127+
| get_auth_reset_password_uid_token | Get User password reset token |
128+
| post_auth_reset_password_uid_token | Reset user password |
129+
| get_analytics_data | Gets Analytics Data |
130+
| get_analytics_properties_id | Gets all instance properties based on template id |
131+
| get_permissions | Gets all permissions |
132+
| post_stripe_preconfigure | First call to make to change stripe keys |
133+
| post_stripe_reconfigure | Second call to make to change stripe keys |
134+
| get_stripe_keys | Gets stripe keys |

‎mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ pages:
2222
- Messaging: messaging.md
2323
- View Invoices: invoice.md
2424
- Give a Refund: refund.md
25-
- Roles and Permissions: roles.md
25+
- Understanding Permissions: permissions.md
26+
- Modifying Roles: roles.md
2627
- Navigate Admin Dashboard: admin_dashboard.md
2728
- Change operation mode: operation_mode.md
2829
- Change Branding: branding.md

0 commit comments

Comments
 (0)