events_rules_list
GET/events/rules/
NotificationRule Viewset
Request
Query Parameters
Which field to use when ordering the results.
A page number within the paginated result set.
Number of results to return per page.
A search term.
Possible values: [alert, notice, warning]
Controls which severity level the created notifications will have.
Responses
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
]
pagination
object
required
results
object[]
required
Select which transports should be used to notify the user. If none are selected, the notification will only be shown in the authentik UI.
Controls which severity level the created notifications will have.
Possible values: [notice, warning, alert]
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
Group Serializer
Users added to this group will be superusers.
users_obj
object[]
nullable
required
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
Possible values: <= 150 characters, Value must match regular expression ^[\w.@+-]+$
User's display name.
Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
Possible values: <= 254 characters
roles_obj
object[]
required
Possible values: <= 150 characters
{
"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"
],
"group": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}
- application/json
- Schema
- Example (from schema)
Schema
Validation Error
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "string",
"code": "string"
}