metabase.api.permissions
/api/permissions endpoints.
/api/permissions endpoints.
add-member-countsclj
(add-member-counts groups)Efficiently add :member_count to PermissionGroups.
Efficiently add `:member_count` to PermissionGroups.
DELETE_group_:group-idclj
DELETE /api/permissions/group/:group-id
Delete a specific PermissionsGroup.
You must be a superuser to do this.
PARAMS:
group-id
## `DELETE /api/permissions/group/:group-id` Delete a specific `PermissionsGroup`. You must be a superuser to do this. ##### PARAMS: * **`group-id`**
DELETE_membership_:idclj
DELETE /api/permissions/membership/:id
Remove a User from a PermissionsGroup (delete their membership).
You must be a superuser to do this.
PARAMS:
id
## `DELETE /api/permissions/membership/:id` Remove a User from a PermissionsGroup (delete their membership). You must be a superuser to do this. ##### PARAMS: * **`id`**
GET_graphclj
## `GET /api/permissions/graph` Fetch a graph of all Permissions. You must be a superuser to do this.
GET_groupclj
GET /api/permissions/group
Fetch all PermissionsGroups, including a count of the number of :members in that group.
You must be a superuser to do this.
## `GET /api/permissions/group` Fetch all `PermissionsGroups`, including a count of the number of `:members` in that group. You must be a superuser to do this.
GET_group_:idclj
GET /api/permissions/group/:id
Fetch the details for a certain permissions group.
You must be a superuser to do this.
PARAMS:
id
## `GET /api/permissions/group/:id` Fetch the details for a certain permissions group. You must be a superuser to do this. ##### PARAMS: * **`id`**
GET_membershipclj
GET /api/permissions/membership
Fetch a map describing the group memberships of various users. This map's format is:
{<user-id> [{:membership_id <id>
:group_id <id>}]}
You must be a superuser to do this.
## `GET /api/permissions/membership`
Fetch a map describing the group memberships of various users.
This map's format is:
{<user-id> [{:membership_id <id>
:group_id <id>}]}
You must be a superuser to do this.POST_groupclj
POST /api/permissions/group
Create a new PermissionsGroup.
You must be a superuser to do this.
PARAMS:
namevalue must be a non-blank string.
## `POST /api/permissions/group` Create a new `PermissionsGroup`. You must be a superuser to do this. ##### PARAMS: * **`name`** value must be a non-blank string.
POST_membershipclj
POST /api/permissions/membership
Add a User to a PermissionsGroup. Returns updated list of members belonging to the group.
You must be a superuser to do this.
PARAMS:
-
group_idvalue must be an integer greater than zero. -
user_idvalue must be an integer greater than zero.
## `POST /api/permissions/membership` Add a `User` to a `PermissionsGroup`. Returns updated list of members belonging to the group. You must be a superuser to do this. ##### PARAMS: * **`group_id`** value must be an integer greater than zero. * **`user_id`** value must be an integer greater than zero.
PUT_graphclj
PUT /api/permissions/graph
Do a batch update of Permissions by passing in a modified graph. This should return the same graph, in the same
format, that you got from GET /api/permissions/graph, with any changes made in the wherever necessary. This
modified graph must correspond to the PermissionsGraph schema. If successful, this endpoint returns the updated
permissions graph; use this as a base for any further modifications.
Revisions to the permissions graph are tracked. If you fetch the permissions graph and some other third-party modifies it before you can submit you revisions, the endpoint will instead make no changes and return a 409 (Conflict) response. In this case, you should fetch the updated graph and make desired changes to that.
You must be a superuser to do this.
PARAMS:
bodyvalue must be a map.
## `PUT /api/permissions/graph` Do a batch update of Permissions by passing in a modified graph. This should return the same graph, in the same format, that you got from `GET /api/permissions/graph`, with any changes made in the wherever necessary. This modified graph must correspond to the `PermissionsGraph` schema. If successful, this endpoint returns the updated permissions graph; use this as a base for any further modifications. Revisions to the permissions graph are tracked. If you fetch the permissions graph and some other third-party modifies it before you can submit you revisions, the endpoint will instead make no changes and return a 409 (Conflict) response. In this case, you should fetch the updated graph and make desired changes to that. You must be a superuser to do this. ##### PARAMS: * **`body`** value must be a map.
PUT_group_:group-idclj
PUT /api/permissions/group/:group-id
Update the name of a PermissionsGroup.
You must be a superuser to do this.
PARAMS:
-
group-id -
namevalue must be a non-blank string.
## `PUT /api/permissions/group/:group-id` Update the name of a `PermissionsGroup`. You must be a superuser to do this. ##### PARAMS: * **`group-id`** * **`name`** value must be a non-blank string.
routesclj
Ring routes for api/permissions: (GET_group_:id GET_graph PUT_graph POST_group GET_membership GET_group DELETE_membership_:id PUT_group_:group-id DELETE_group_:group-id POST_membership)
Ring routes for api/permissions: (GET_group_:id GET_graph PUT_graph POST_group GET_membership GET_group DELETE_membership_:id PUT_group_:group-id DELETE_group_:group-id POST_membership)
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close