Skip to main content

stages_invitation_invitations_partial_update

PATCH 
/api/v3//stages/invitation/invitations/:invite_uuid/

Invitation Viewset

Request​

Path Parameters

    invite_uuid uuidrequired

    A UUID string identifying this Invitation.

Body

    namestring

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    expiresdate-timenullable
    fixed_data object
    property name*any
    single_useboolean

    When enabled, the invitation will be deleted after usage.

    flowuuidnullable

    When set, only the configured flow can use this invitation.

Responses​

Schema
    pkuuidrequired
    namestringrequired

    Possible values: <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    expiresdate-timenullable
    fixed_data object
    property name*any
    created_by object

    Stripped down user serializer to show relevant users for groups

    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
    single_useboolean

    When enabled, the invitation will be deleted after usage.

    flowuuidnullable

    When set, only the configured flow can use this invitation.

    flow_obj object

    Flow Serializer

    pkuuidrequired
    policybindingmodel_ptr_iduuidrequired
    namestringrequired
    slugstringrequired

    Visible in the URL.

    Possible values: <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    titlestringrequired

    Shown as the Title in Flow pages.

    designationFlowDesignationEnum (string)required

    Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.

    Possible values: [authentication, authorization, invalidation, enrollment, unenrollment, recovery, stage_configuration]

    backgroundstringrequired

    Get the URL to the background image. If the name is /static or starts with http it is returned as-is

    stagesuuid[]required
    policiesuuid[]required
    cache_countintegerrequired

    Get count of cached flows

    policy_engine_modePolicyEngineMode (string)

    Possible values: [all, any]

    compatibility_modeboolean

    Enable compatibility mode, increases compatibility with password managers on mobile devices.

    export_urlstringrequired

    Get export URL for flow

    layoutFlowLayoutEnum (string)

    Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]

    denied_actionDeniedActionEnum (string)

    Configure what should happen when a flow denies access to a user.

    Possible values: [message_continue, message, continue]

    authenticationAuthenticationEnum (string)

    Required level of authentication and authorization to access a flow.

    Possible values: [none, require_authenticated, require_unauthenticated, require_superuser, require_redirect, require_outpost]

Authorization: http

name: authentiktype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "/api/v3/stages/invitation/invitations/:invite_uuid/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"expires\": \"2024-07-29T15:51:28.071Z\",\n  \"fixed_data\": {},\n  \"single_use\": true,\n  \"flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
/api/v3
Auth
Parameters
— pathrequired
Body
{
  "name": "string",
  "expires": "2024-07-29T15:51:28.071Z",
  "fixed_data": {},
  "single_use": true,
  "flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}