Docs: update users API (#23570)

* Docs: update users api

* Apply suggestions from code review

Co-Authored-By: Marcus Efraimsson <marcus.efraimsson@gmail.com>
pull/23622/head
Sofia Papagiannaki 6 years ago committed by GitHub
parent 28543e11ba
commit 19f03e593c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 39
      docs/sources/http_api/user.md

@ -38,14 +38,22 @@ Content-Type: application/json
"name": "Admin", "name": "Admin",
"login": "admin", "login": "admin",
"email": "admin@mygraf.com", "email": "admin@mygraf.com",
"isAdmin": true "isAdmin": true,
"isDisabled": false,
"lastSeenAt": "2020-04-10T20:29:27+03:00",
"lastSeenAtAge': "2m",
"authLabels": ["OAuth"]
}, },
{ {
"id": 2, "id": 2,
"name": "User", "name": "User",
"login": "user", "login": "user",
"email": "user@mygraf.com", "email": "user@mygraf.com",
"isAdmin": false "isAdmin": false,
"isDisabled": false,
"lastSeenAt": "2020-01-24T12:38:47+02:00",
"lastSeenAtAge": "2M",
"authLabels": []
} }
] ]
``` ```
@ -80,14 +88,22 @@ Content-Type: application/json
"name": "Admin", "name": "Admin",
"login": "admin", "login": "admin",
"email": "admin@mygraf.com", "email": "admin@mygraf.com",
"isAdmin": true "isAdmin": true,
"isDisabled": false,
"lastSeenAt": "2020-04-10T20:29:27+03:00",
"lastSeenAtAge': "2m",
"authLabels": ["OAuth"]
}, },
{ {
"id": 2, "id": 2,
"name": "User", "name": "User",
"login": "user", "login": "user",
"email": "user@mygraf.com", "email": "user@mygraf.com",
"isAdmin": false "isAdmin": false,
"isDisabled": false,
"lastSeenAt": "2020-01-24T12:38:47+02:00",
"lastSeenAtAge": "2M",
"authLabels": []
} }
], ],
"page": 1, "page": 1,
@ -127,7 +143,8 @@ Content-Type: application/json
"isExternal": false, "isExternal": false,
"authLabels": [], "authLabels": [],
"updatedAt": "2019-09-09T11:31:26+01:00", "updatedAt": "2019-09-09T11:31:26+01:00",
"createdAt": "2019-09-09T11:31:26+01:00" "createdAt": "2019-09-09T11:31:26+01:00",
"avatarUrl": ""
} }
``` ```
@ -173,7 +190,8 @@ Content-Type: application/json
"isExternal": false, "isExternal": false,
"authLabels": null, "authLabels": null,
"updatedAt": "2019-09-25T14:44:37+01:00", "updatedAt": "2019-09-25T14:44:37+01:00",
"createdAt": "2019-09-25T14:44:37+01:00" "createdAt": "2019-09-25T14:44:37+01:00",
"avatarUrl":""
} }
``` ```
@ -294,12 +312,19 @@ HTTP/1.1 200
Content-Type: application/json Content-Type: application/json
{ {
"id":1,
"email":"admin@mygraf.com", "email":"admin@mygraf.com",
"name":"Admin", "name":"Admin",
"login":"admin", "login":"admin",
"theme":"light", "theme":"light",
"orgId":1, "orgId":1,
"isGrafanaAdmin":true "isGrafanaAdmin":true,
"isDisabled":false
"isExternal": false,
"authLabels": [],
"updatedAt": "2019-09-09T11:31:26+01:00",
"createdAt": "2019-09-09T11:31:26+01:00",
"avatarUrl": ""
} }
``` ```

Loading…
Cancel
Save