Skip to main content

events_rules_list

GET 
/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​

Schema

    pagination

    object

    required

    next numberrequired
    previous numberrequired
    count numberrequired
    current numberrequired
    total_pages numberrequired
    start_index numberrequired
    end_index numberrequired

    results

    object[]

    required

  • Array [

    • 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)

    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

    Group Serializer

    pk uuidrequired
    num_pk integerrequired
    name stringrequired
    is_superuser boolean

    Users added to this group will be superusers.

    parent uuidnullable
    parent_name stringnullablerequired
    users integer[]

    users_obj

    object[]

    nullable

    required

  • Array [

    • pk ID (integer)required
    username stringrequired

    Possible values: <= 150 characters, Value must match regular expression ^[\w.@+-]+$

    Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

    name stringrequired

    User's display name.

    is_active Active (boolean)

    Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

    last_login date-timenullable
    email email

    Possible values: <= 254 characters

    attributes object
    uid stringrequired

  • ]

    • attributes object
    roles uuid[]

    roles_obj

    object[]

    required

  • Array [

    • pk uuidrequired
    name stringrequired

    Possible values: <= 150 characters

  • ]

  • ]

Loading...