Remove absolute aliases as it can cause unexpected redirects in future versions (#1793 )

If a page is removed in a future version, the presence of a "latest"
absolute alias in a previous version can redirect that removed page.

**Notes for reviewer:**
I would like to make similar changes for older, previously published
versions.
I believe you are only publishing documentation on specific tag events
and are not maintaining long lived release branches for backporting
fixes into.
If my understanding is correct, I will make the changes in the website
repository
(https://github.com/grafana/website/tree/master/content/docs/oncall).

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

2023-06-05 09:03:38 +00:00

2.2 KiB

Raw Blame History

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.

```shell
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"
    }
  ]
}

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/

2.2 KiB Raw Blame History

Get a user

List Users

2.2 KiB

Raw Blame History