IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs/*: Fix misspell issues

Browse Source 
See,
$ find . -type f | xargs misspell -locale US | grep -vi -e vendor -e node_modules -e devenv -e unknwon | grep docs
This commit is contained in:
Mario Trangoni
2018-11-28 20:33:41 +01:00
parent 9c1b4793a6
commit 5d60d323e2
9 changed files with 51 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
docs/sources/http_api/org.md
View File

@@ -1,24 +1,24 @@
+++
title = "Organisation HTTP API "
description = "Grafana Organisation HTTP API"
keywords = ["grafana", "http", "documentation", "api", "organisation"]
aliases = ["/http_api/organisation/"]
title = "Organization HTTP API "
description = "Grafana Organization HTTP API"
keywords = ["grafana", "http", "documentation", "api", "organization"]
aliases = ["/http_api/organization/"]
type = "docs"
[menu.docs]
name = "Organisation"
name = "Organization"
parent = "http_api"
+++
# Organisation API
# Organization API
The Organisation HTTP API is divided in two resources, `/api/org` (current organisation)
and `/api/orgs` (admin organisations). One big difference between these are that
the admin of all organisations API only works with basic authentication, see [Admin Organisations API](#admin-organisations-api) for more information.
The Organization HTTP API is divided in two resources, `/api/org` (current organization)
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.
## Current Organisation API
## Current Organization API
### Get current Organisation
### Get current Organization
`GET /api/org/`
@@ -43,7 +43,7 @@ Content-Type: application/json
`GET /api/org/users`
**Example Request**:
**Example Request**:
```http
GET /api/org/users HTTP/1.1
@@ -99,7 +99,7 @@ Content-Type: application/json
```http
HTTP/1.1 200
Content-Type: application/json
Content-Type: application/json
```
@@ -121,7 +121,7 @@ Content-Type: application/json
```http
HTTP/1.1 200
Content-Type: application/json
Content-Type: application/json
```
@@ -147,11 +147,11 @@ Content-Type: application/json
HTTP/1.1 200
Content-Type: application/json
```
```
## Admin Organizations API
The Admin Organisations HTTP API does not currently work with an API Token. API Tokens are currently
The Admin Organizations HTTP API does not currently work with an API Token. API Tokens are currently
only linked to an organization and an organization role. They cannot be given the permission of server
admin, only users can be given that permission. So in order to use these API calls you will have to
use Basic Auth and the Grafana user must have the Grafana Admin permission (The default admin user
@@ -176,19 +176,19 @@ Content-Type: application/json
```http
HTTP/1.1 200
Content-Type: application/json
```
### Get Organisation by Name
### Get Organization by Name
`GET /api/orgs/name/:orgName`
Only works with Basic Authentication (username and password), see [introduction](#admin-organizations-api).
**Example Request**:
**Example Request**:
```http
GET /api/orgs/name/Main%20Org%2E HTTP/1.1
Accept: application/json
Accept: application/json
Content-Type: application/json
```
@@ -217,11 +217,11 @@ Content-Type: application/json
Note: The api will work in the following two ways
1) Need to set GF_USERS_ALLOW_ORG_CREATE=true
2) Set the config users.allow_org_create to true in ini file
**Example Response**:
```http
HTTP/1.1 200
HTTP/1.1 200
Content-Type: application/json
```
@@ -251,11 +251,11 @@ Content-Type: application/json
```
### Update Organization
`PUT /api/orgs/:orgId`
Update Organization, fields *Address 1*, *Address 2*, *City* are not implemented yet.
Only works with Basic Authentication (username and password), see [introduction](#admin-organisations-api).
Only works with Basic Authentication (username and password), see [introduction](#admin-organizations-api).
**Example Request**:
@@ -284,11 +284,11 @@ Content-Type: application/json
```http
DELETE /api/orgs/1 HTTP/1.1
Accept: application/json
Accept: application/json
```
**Example Response**:
```http
HTTP/1.1 200
Content-Type: application/json
@@ -314,12 +314,12 @@ Content-Type: application/json
**Example Response**:
```http
```http
HTTP/1.1 200
Content-Type: application/json
[
```
```
### Add User in Organization
`POST /api/orgs/:orgId/users`
@@ -342,11 +342,11 @@ Content-Type: application/json
Content-Type: application/json
```
### Update Users in Organization
`PATCH /api/orgs/:orgId/users/:userId`
Only works with Basic Authentication (username and password), see [introduction](#admin-organizations-api).
**Example Request**:
@@ -364,11 +364,11 @@ Content-Type: application/json
HTTP/1.1 200
Content-Type: application/json
```
```
### Delete User in Organization
`DELETE /api/orgs/:orgId/users/:userId`
`DELETE /api/orgs/:orgId/users/:userId`
Only works with Basic Authentication (username and password), see [introduction](#admin-organizations-api).
@@ -397,11 +397,11 @@ Content-Type: application/json
]
```
### Add User in Organisation
### Add User in Organization
`POST /api/orgs/:orgId/users`
Only works with Basic Authentication (username and password), see [introduction](#admin-organisations-api).
Only works with Basic Authentication (username and password), see [introduction](#admin-organizations-api).
**Example Request**:
@@ -425,11 +425,11 @@ Content-Type: application/json
{"message":"User added to organization"}
```
### Update Users in Organisation
### Update Users in Organization
`PATCH /api/orgs/:orgId/users/:userId`
Only works with Basic Authentication (username and password), see [introduction](#admin-organisations-api).
Only works with Basic Authentication (username and password), see [introduction](#admin-organizations-api).
**Example Request**:
@@ -452,11 +452,11 @@ Content-Type: application/json
{"message":"Organization user updated"}
```
### Delete User in Organisation
### Delete User in Organization
`DELETE /api/orgs/:orgId/users/:userId`
Only works with Basic Authentication (username and password), see [introduction](#admin-organisations-api).
Only works with Basic Authentication (username and password), see [introduction](#admin-organizations-api).
**Example Request**: