Skip to main content

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​

Schema
    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

  • ]

Authorization: http

name: authentiktype: httpscheme: bearer
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());
Request Collapse all
Base URL
/api/v3
Auth
Parameters
— pathrequired