stages_invitation_invitations_partial_update
PATCH/stages/invitation/invitations/:invite_uuid/
Invitation Viewset
Request
Path Parameters
A UUID string identifying this Invitation.
- application/json
Body
Possible values: non-empty
and <= 50 characters
, Value must match regular expression ^[-a-zA-Z0-9_]+$
fixed_data
object
When enabled, the invitation will be deleted after usage.
When set, only the configured flow can use this invitation.
Responses
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
Possible values: <= 50 characters
, Value must match regular expression ^[-a-zA-Z0-9_]+$
fixed_data
object
created_by
object
required
Stripped down user serializer to show relevant users for groups
Possible values: <= 150 characters
, Value must match regular expression ^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
User's display name.
Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
Possible values: <= 254 characters
When enabled, the invitation will be deleted after usage.
When set, only the configured flow can use this invitation.
flow_obj
object
required
Flow Serializer
Possible values: <= 50 characters
, Value must match regular expression ^[-a-zA-Z0-9_]+$
Visible in the URL.
Shown as the Title in Flow pages.
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.
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Get count of cached flows
Possible values: [all
, any
]
Enable compatibility mode, increases compatibility with password managers on mobile devices.
Get export URL for flow
Possible values: [stacked
, content_left
, content_right
, sidebar_left
, sidebar_right
]
Possible values: [message_continue
, message
, continue
]
Configure what should happen when a flow denies access to a user.
Possible values: [none
, require_authenticated
, require_unauthenticated
, require_superuser
, require_outpost
]
Required level of authentication and authorization to access a flow.
{
"pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"expires": "2024-07-29T15:51:28.071Z",
"fixed_data": {},
"created_by": {
"pk": 0,
"username": "string",
"name": "string",
"is_active": true,
"last_login": "2024-07-29T15:51:28.071Z",
"email": "user@example.com",
"attributes": {},
"uid": "string"
},
"single_use": true,
"flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"flow_obj": {
"pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"policybindingmodel_ptr_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"slug": "string",
"title": "string",
"designation": "authentication",
"background": "string",
"stages": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"policies": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"cache_count": 0,
"policy_engine_mode": "all",
"compatibility_mode": true,
"export_url": "string",
"layout": "stacked",
"denied_action": "message_continue",
"authentication": "none"
}
}
- application/json
- Schema
- Example (from schema)
Schema
Validation Error
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "string",
"code": "string"
}