Skip to main content

events_rules_partial_update

PATCH 
/events/rules/:pbm_uuid/

NotificationRule Viewset

Request​

Path Parameters

    pbm_uuid uuidrequired

    A UUID string identifying this Notification Rule.

Body

    name string

    Possible values: non-empty

    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.

Responses​

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

    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

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

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

    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...