15e02c7f30
remove duplicate line in first example. # What this PR does ## Which issue(s) this PR fixes ## Checklist - [ ] Unit, integration, and e2e (if applicable) tests updated - [ ] Documentation added (or `pr:no public docs` PR label added if not required) - [ ] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not required)
2.2 KiB
2.2 KiB
| canonical | title | weight |
|---|---|---|
| https://grafana.com/docs/oncall/latest/oncall-api-reference/users/ | Grafana OnCall Users HTTP API | 1500 |
Get a user
This endpoint retrieves the user object.
curl "{{API_URL}}/api/v1/users/current/" \
--request GET \
--header "Authorization: meowmeowmeow" \
--header "Content-Type: application/json"
The above command returns JSON structured in the following way:
{
"id": "U4DNY931HHJS5",
"email": "public-api-demo-user-1@grafana.com",
"slack": [
{
"user_id": "UALEXSLACKDJPK",
"team_id": "TALEXSLACKDJPK"
}
],
"username": "alex",
"role": "admin"
}
HTTP request
GET {{API_URL}}/api/v1/users/<USER_ID>/
Use {{API_URL}}/api/v1/users/current to retrieve the current user.
| Parameter | Unique | Description |
|---|---|---|
id |
Yes/org | User ID |
email |
Yes/org | User e-mail |
slack |
Yes/org | List of user IDs from connected Slack. User linking key is e-mail. |
username |
Yes/org | User username |
role |
No | One of: user, observer, admin. |
List Users
curl "{{API_URL}}/api/v1/users/" \
--request GET \
--header "Authorization: meowmeowmeow" \
--header "Content-Type: application/json"
The above command returns JSON structured in the following way:
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "U4DNY931HHJS5",
"email": "public-api-demo-user-1@grafana.com",
"slack": [
{
"user_id": "UALEXSLACKDJPK",
"team_id": "TALEXSLACKDJPK"
}
],
"username": "alex",
"role": "admin"
}
],
"current_page_number": 1,
"page_size": 100,
"total_pages": 1
}
This endpoint retrieves all users.
The following available filter parameter should be provided as a GET argument:
username(Exact match)
HTTP request
GET {{API_URL}}/api/v1/users/