events_rules_list

GET 
/api/v3//events/rules/

NotificationRule Viewset

Request

Query Parameters

group__name string
name string
ordering string

Which field to use when ordering the results.

page integer

A page number within the paginated result set.

page_size integer

Number of results to return per page.

search string

A search term.

severity string

Possible values: [alert, notice, warning]

Controls which severity level the created notifications will have.

Responses

200

application/json

Schema

Schema

pagination objectrequired
nextnumberrequired
previousnumberrequired
countnumberrequired
currentnumberrequired
total_pagesnumberrequired
start_indexnumberrequired
end_indexnumberrequired
results object[]required
Array [
pkuuidrequired
namestringrequired
transportsuuid[]
Select which transports should be used to notify the user. If none are selected, the notification will only be shown in the authentik UI.
severitySeverityEnum (string)
Controls which severity level the created notifications will have.
Possible values: [notice, warning, alert]
groupuuidnullable
Define which group of users this notification should be sent and shown to. If left empty, Notification won't ben sent.
group_obj object
Group Serializer
pkuuidrequired
num_pkintegerrequired
namestringrequired
is_superuserboolean
Users added to this group will be superusers.
parentuuidnullable
parent_namestringnullablerequired
usersinteger[]
users_obj object[]nullablerequired
Array [
pkID (integer)required
usernamestringrequired
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
Possible values: <= 150 characters, Value must match regular expression ^[\w.@+-]+$
namestringrequired
User's display name.
is_activeActive (boolean)
Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_logindate-timenullable
emailemail
Possible values: <= 254 characters
attributes object
property name*any
uidstringrequired
]
attributes object
property name*any
rolesuuid[]
roles_obj object[]required
Array [
pkuuidrequired
namestringrequired
Possible values: <= 150 characters
]
]

Example (auto)

{
  "pagination": {
    "next": 0,
    "previous": 0,
    "count": 0,
    "current": 0,
    "total_pages": 0,
    "start_index": 0,
    "end_index": 0
  },
  "results": [
    {
      "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "transports": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "severity": "notice",
      "group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "group_obj": {
        "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "num_pk": 0,
        "name": "string",
        "is_superuser": true,
        "parent": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "parent_name": "string",
        "users": [
          0
        ],
        "users_obj": [
          {
            "pk": 0,
            "username": "string",
            "name": "string",
            "is_active": true,
            "last_login": "2024-07-29T15:51:28.071Z",
            "email": "user@example.com",
            "attributes": {},
            "uid": "string"
          }
        ],
        "attributes": {},
        "roles": [
          "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        ],
        "roles_obj": [
          {
            "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string"
          }
        ]
      }
    }
  ]
}

400

application/json

Schema

Schema

non_field_errorsstring[]

codestring

property name*any

Validation Error

Example (auto)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detailstringrequired
codestring

Example (auto)

{
  "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

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

group__name — query

name — query

ordering — query

page — query

page_size — query

search — query

severity — query

---alertnoticewarning