public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

PackageJson: Prettify markdown/mdx on commit with lint-staged (#37616)

Browse Source 
* Format md,mdx files with prettier on lint-staged

* Manually run prettier on docs/sources
This commit is contained in:
Connor Lindsey
2021-08-06 07:52:36 -06:00
committed by GitHub
parent e9c032f10f
commit b78a67cec7
301 changed files with 3216 additions and 2980 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/http_api/org.md
+33 -29
View File
@@ -12,7 +12,7 @@ and `/api/orgs` (admin organizations). One big difference between these are that
the admin of all organizations API only works with basic authentication, see [Admin Organizations API](#admin-organizations-api) for more information.
> If you are running Grafana Enterprise and have [Fine-grained access control]({{< relref "../enterprise/access-control/_index.md" >}}) enabled, for some endpoints you would need to have relevant permissions.
Refer to specific resources to understand what permissions are required.
> Refer to specific resources to understand what permissions are required.
## Current Organization API
@@ -52,9 +52,9 @@ Accessible to users with org admin role.
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
Action | Scope
--- | --- |
org.users:read | users:*
| Action | Scope |
| -------------- | -------- |
| org.users:read | users:\* |
**Example Request**:
@@ -126,9 +126,9 @@ Content-Type: application/json
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
Action | Scope
--- | --- |
org.users.role:update | users:*
| Action | Scope |
| --------------------- | -------- |
| org.users.role:update | users:\* |
**Example Request**:
@@ -160,9 +160,9 @@ Content-Type: application/json
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
Action | Scope
--- | --- |
org.users:remove | users:*
| Action | Scope |
| ---------------- | -------- |
| org.users:remove | users:\* |
**Example Request**:
@@ -218,9 +218,9 @@ Adds a global user to the current organization.
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
Action | Scope
--- | --- |
org.users:add | users:*
| Action | Scope |
| ------------- | -------- |
| org.users:add | users:\* |
**Example Request**:
@@ -286,6 +286,7 @@ Content-Type: application/json
}
}
```
### Get Organization by Name
`GET /api/orgs/name/:orgName`
@@ -337,9 +338,11 @@ Content-Type: application/json
"name":"New Org."
}
```
Note: The api will work in the following two ways
1) Need to set GF_USERS_ALLOW_ORG_CREATE=true
2) Set the config value users.allow_org_create to true in ini file
1. Need to set GF_USERS_ALLOW_ORG_CREATE=true
2. Set the config value users.allow_org_create to true in ini file
**Example Response**:
@@ -366,6 +369,7 @@ GET /api/orgs HTTP/1.1
Accept: application/json
Content-Type: application/json
```
Note: The api will only work when you pass the admin name and password
to the request HTTP URL, like http://admin:admin@localhost:3000/api/orgs
@@ -389,7 +393,7 @@ Content-Type: application/json
`PUT /api/orgs/:orgId`
Update Organization, fields *Address 1*, *Address 2*, *City* are not implemented yet.
Update Organization, fields _Address 1_, _Address 2_, _City_ are not implemented yet.
Only works with Basic Authentication (username and password), see [introduction](#admin-organizations-api).
**Example Request**:
@@ -445,9 +449,9 @@ Only works with Basic Authentication (username and password), see [introduction]
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
Action | Scope
--- | --- |
org.users:read | users:*
| Action | Scope |
| -------------- | -------- |
| org.users:read | users:\* |
**Example Request**:
@@ -456,10 +460,10 @@ GET /api/orgs/1/users HTTP/1.1
Accept: application/json
Content-Type: application/json
```
Note: The api will only work when you pass the admin name and password
to the request HTTP URL, like http://admin:admin@localhost:3000/api/orgs/1/users
**Example Response**:
```http
@@ -486,9 +490,9 @@ Only works with Basic Authentication (username and password), see [introduction]
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
Action | Scope
--- | --- |
org.users:add | users:*
| Action | Scope |
| ------------- | -------- |
| org.users:add | users:\* |
**Example Request**:
@@ -522,9 +526,9 @@ Only works with Basic Authentication (username and password), see [introduction]
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
Action | Scope
--- | --- |
org.users.role:update | users:*
| Action | Scope |
| --------------------- | -------- |
| org.users.role:update | users:\* |
**Example Request**:
@@ -557,9 +561,9 @@ Only works with Basic Authentication (username and password), see [introduction]
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
Action | Scope
--- | --- |
org.users:remove | users:*
| Action | Scope |
| ---------------- | -------- |
| org.users:remove | users:\* |
**Example Request**: