forked from github-starred/komodo
90 lines
1.9 KiB
Plaintext
90 lines
1.9 KiB
Plaintext
import Divider from '@site/src/components/Divider';
|
|
|
|
# permissions
|
|
|
|
these routes relate to updating user permissions
|
|
|
|
:::note
|
|
these routes can only be called by **admin** users
|
|
:::
|
|
|
|
| name | route |
|
|
| ---- | ------ |
|
|
| [update user permissions on target](/api/permissions#update-user-permissions-on-target) | `POST /api/permissions/update` |
|
|
| [modify user enabled](/api/permissions#modify-user-enabled) | `POST /api/permissions/modify_enabled` |
|
|
| [modify user create server permissions](/api/permissions#modify-user-create-server-permissions) | `POST /api/permissions/modify_create_server` |
|
|
| [modify user create build permissions](/api/permissions#modify-user-create-build-permissions) | `POST /api/permissions/modify_create_build` |
|
|
|
|
```mdx-code-block
|
|
<Divider />
|
|
```
|
|
|
|
## update user permissions on target
|
|
`POST /api/permissions/update`
|
|
|
|
### request body
|
|
```json
|
|
{
|
|
user_id: string, // the target users id
|
|
permission: "none" | "read" | "execute" | "update",
|
|
target_type: "server" | "deployment" | "build" | "procedure" | "group",
|
|
target_id: string, // the target resources id
|
|
}
|
|
```
|
|
|
|
### response body
|
|
[Update](/api/types#update)
|
|
|
|
```mdx-code-block
|
|
<Divider />
|
|
```
|
|
|
|
## modify user enabled
|
|
`POST /api/permissions/modify_enabled`
|
|
|
|
### request body
|
|
```json
|
|
{
|
|
user_id: string, // the target users id
|
|
enabled: boolean,
|
|
}
|
|
```
|
|
|
|
### response body
|
|
[Update](/api/types#update)
|
|
|
|
```mdx-code-block
|
|
<Divider />
|
|
```
|
|
|
|
## modify user create server permissions
|
|
`POST /api/permissions/modify_create_server`
|
|
|
|
### request body
|
|
```json
|
|
{
|
|
user_id: string, // the target users id
|
|
create_server_permissions: boolean,
|
|
}
|
|
```
|
|
|
|
### response body
|
|
[Update](/api/types#update)
|
|
|
|
```mdx-code-block
|
|
<Divider />
|
|
```
|
|
|
|
## modify user create build permissions
|
|
`POST /api/permissions/modify_create_build`
|
|
|
|
### request body
|
|
```json
|
|
{
|
|
user_id: string, // the target users id
|
|
create_build_permissions: boolean,
|
|
}
|
|
```
|
|
|
|
### response body
|
|
[Update](/api/types#update) |