feat: add Grafana IDs to users and teams public API endpoints (#5075 )

# What this PR does

- add Grafana IDs to users and teams public API endpoints
- update Schedules public API docs to reflect the fact that [we allow
filtering by
`team_id`](https://github.com/grafana/oncall/blob/dev/engine/apps/public_api/views/schedules.py#L42)

## Checklist

- [x] Unit, integration, and e2e (if applicable) tests updated
- [x] Documentation added (or `pr:no public docs` PR label added if not
required)
- [x] Added the relevant release notes label (see labels prefixed w/
`release:`). These labels dictate how your PR will
    show up in the autogenerated release notes.

2024-09-24 19:16:22 +00:00

3.1 KiB

Raw Blame History

canonical

title

weight

refs

https://grafana.com/docs/oncall/latest/oncall-api-reference/users/

Grafana OnCall users HTTP API

pagination

pattern	destination
/docs/oncall/	/docs/oncall/<ONCALL_VERSION>/oncall-api-reference/#pagination

pattern	destination
/docs/grafana-cloud/	/docs/grafana-cloud/alerting-and-irm/oncall/oncall-api-reference/#pagination

Grafana OnCall users HTTP API

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",
  "grafana_id": 456,
  "email": "public-api-demo-user-1@grafana.com",
  "slack": [
    {
      "user_id": "UALEXSLACKDJPK",
      "team_id": "TALEXSLACKDJPK"
    }
  ],
  "username": "alex",
  "role": "admin",
  "timezone": "UTC",
  "teams": []
}

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	OnCall user ID
`grafana_id`	Yes/org	Grafana 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`.
`timezone`	No	timezone of the user one of time zones.
`teams`	No	List of team IDs the user belongs to

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",
      "grafana_id": 456,
      "email": "public-api-demo-user-1@grafana.com",
      "slack": [
        {
          "user_id": "UALEXSLACKDJPK",
          "team_id": "TALEXSLACKDJPK"
        }
      ],
      "username": "alex",
      "role": "admin",
      "timezone": "UTC",
      "teams": ["TAAM1K1NNEHAG"]
    }
  ],
  "current_page_number": 1,
  "page_size": 100,
  "total_pages": 1
}

Note

: The response is paginated. You may need to make multiple requests to get all records.

The following available filter parameter should be provided as a GET argument:

username (Exact match)

HTTP request

GET {{API_URL}}/api/v1/users/

3.1 KiB Raw Blame History

Grafana OnCall users HTTP API

Get a user

List Users

3.1 KiB

Raw Blame History