Skip to main content

stages_invitation_invitations_update

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

Invitation Viewset

Request​

Path Parameters

    invite_uuid uuidrequired

    A UUID string identifying this Invitation.

Body

required

    name stringrequired

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

    expires date-timenullable

    fixed_data

    object

    single_use boolean

    When enabled, the invitation will be deleted after usage.

    flow uuidnullable

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

Responses​

Schema

    pk uuidrequired
    name stringrequired

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

    expires date-timenullable

    fixed_data

    object

    created_by

    object

    required

    Stripped down user serializer to show relevant users for groups

    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
    single_use boolean

    When enabled, the invitation will be deleted after usage.

    flow uuidnullable

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

    flow_obj

    object

    required

    Flow Serializer

    pk uuidrequired
    policybindingmodel_ptr_id uuidrequired
    name stringrequired
    slug stringrequired

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

    Visible in the URL.

    title stringrequired

    Shown as the Title in Flow pages.

    designation FlowDesignationEnum (string)required

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

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

    background stringrequired

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

    stages uuid[]required
    policies uuid[]required
    cache_count integerrequired

    Get count of cached flows

    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    compatibility_mode boolean

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

    export_url stringrequired

    Get export URL for flow

    layout FlowLayoutEnum (string)

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

    denied_action DeniedActionEnum (string)

    Possible values: [message_continue, message, continue]

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

    authentication AuthenticationEnum (string)

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

    Required level of authentication and authorization to access a flow.

curl -L -X PUT '/api/v3/stages/invitation/invitations/:invite_uuid/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "expires": "2024-09-27T14:26:17.914Z",
  "fixed_data": {},
  "single_use": true,
  "flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
Request Collapse all
Base URL
/api/v3
Auth
Parameters
— pathrequired
Body required
{
  "name": "string",
  "expires": "2024-09-27T14:26:17.914Z",
  "fixed_data": {},
  "single_use": true,
  "flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}