permissions

Get Available User Permissions

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth

Request

query Parameters

format	string Enum: "csv" "json"
order_by	string Which field to use when ordering the results.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
search	string A search term.

Responses

200

Response Schema:
application/json

	object
	Array of objects (PermissionRead)

get/api/v3/permissions/

Response samples

{"metadata": {"pagination": {"count": 10,
"next": null,
"previous": null,
"page_size": 10,
"num_pages": 1,
"current_page": 1
}
},
"data": [{"id": 507,
"codename": "add_bill"
}
]
}

Get Available System Roles

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth

Request

query Parameters

format	string Enum: "csv" "json"
order_by	string Which field to use when ordering the results.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
permission	string
search	string A search term.
type	integer
user	integer
userprofile	integer

Responses

200

Response Schema:
application/json

	object
	Array of objects (PermissionGroup)

get/api/v3/permissions/groups/

Response samples

{"metadata": {"pagination": {"count": 10,
"next": null,
"previous": null,
"page_size": 10,
"num_pages": 1,
"current_page": 1
}
},
"data": [{"id": 5,
"name": "Approver",
"user_count": 0,
"permissions": [{"id": 900,
"codename": "view_reports"
},
{"id": 982,
"codename": "view_reports_budgets"
},
{"id": 977,
"codename": "view_reports_expenses_by_department"
},
{"id": 976,
"codename": "view_reports_orders_by_department"
},
{"id": 975,
"codename": "view_reports_orders_by_user"
},
{"id": 974,
"codename": "view_reports_orders_by_vendor"
},
{"id": 101,
"codename": "add_expensereport"
},
{"id": 887,
"codename": "approve_expensereport"
},
{"id": 71,
"codename": "add_order"
},
{"id": 886,
"codename": "approve_order"
},
{"id": 95,
"codename": "add_travel"
},
{"id": 888,
"codename": "approve_travel"
}
],
"type": 1
}
]
}

➔ Next to users

permissions

Get Available User Permissions

query Parameters

Response Schema: application/jsontext/csvapplication/json

Get Available System Roles

query Parameters

Response Schema: application/jsontext/csvapplication/json

Response Schema:
application/json

Response Schema:
application/json