events_rules_retrieve
GET/api/v3//events/rules/:pbm_uuid/
NotificationRule Viewset
Request
Path Parameters
pbm_uuid uuidrequired
A UUID string identifying this Notification Rule.
Responses
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
pk uuidrequired
name stringrequired
transports uuid[]
Select which transports should be used to notify the user. If none are selected, the notification will only be shown in the authentik UI.
severity SeverityEnum (string)
Controls which severity level the created notifications will have.
Possible values: [notice, warning, alert]
group uuidnullable
Define which group of users this notification should be sent and shown to. If left empty, Notification won't ben sent.
group_obj
object
required
{
"pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"transports": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"group": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
- application/json
- Schema
- Example (from schema)
Schema
non_field_errors string[]
code string
property name* any
Validation Error
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
detail stringrequired
code string
{
"detail": "string",
"code": "string"
}
Authorization: http
name: authentiktype: httpscheme: bearer
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "/api/v3/events/rules/:pbm_uuid/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <TOKEN>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());