Skip to content

Commit

Permalink
Update API Client
Browse files Browse the repository at this point in the history
#### What's Changed
---

##### `GET` /stages/identification/{stage_uuid}/

###### Return Type:

Changed response : **200 OK**

* Changed content type : `application/json`

    * Added property `captcha_stage` (string)
        > When set, adds functionality exactly like a Captcha stage, but baked into the Identification stage.

##### `PUT` /stages/identification/{stage_uuid}/

###### Request:

Changed content type : `application/json`

* Added property `captcha_stage` (string)
    > When set, adds functionality exactly like a Captcha stage, but baked into the Identification stage.

###### Return Type:

Changed response : **200 OK**

* Changed content type : `application/json`

    * Added property `captcha_stage` (string)
        > When set, adds functionality exactly like a Captcha stage, but baked into the Identification stage.

##### `PATCH` /stages/identification/{stage_uuid}/

###### Request:

Changed content type : `application/json`

* Added property `captcha_stage` (string)
    > When set, adds functionality exactly like a Captcha stage, but baked into the Identification stage.

###### Return Type:

Changed response : **200 OK**

* Changed content type : `application/json`

    * Added property `captcha_stage` (string)
        > When set, adds functionality exactly like a Captcha stage, but baked into the Identification stage.

##### `GET` /flows/executor/{flow_slug}/

###### Return Type:

Changed response : **200 OK**

* Changed content type : `application/json`

    Updated `ak-stage-identification` component:
    * Added property `captcha_stage` (object)
        > Site public key

        * Property `flow_info` (object)
            > Contextual flow information for a challenge

            * Property `title` (string)

            * Property `background` (string)

            * Property `cancel_url` (string)

            * Property `layout` (string)

                Enum values:

                * `stacked`
                * `content_left`
                * `content_right`
                * `sidebar_left`
                * `sidebar_right`
        * Property `component` (string)

        * Property `response_errors` (object)

        * Property `pending_user` (string)

        * Property `pending_user_avatar` (string)

        * Property `site_key` (string)

        * Property `js_url` (string)

##### `POST` /flows/executor/{flow_slug}/

###### Request:

Changed content type : `application/json`

Updated `ak-stage-identification` component:
* Added property `captcha_token` (string)

###### Return Type:

Changed response : **200 OK**

* Changed content type : `application/json`

    Updated `ak-stage-identification` component:
    * Added property `captcha_stage` (object)
        > Site public key

##### `POST` /stages/identification/

###### Request:

Changed content type : `application/json`

* Added property `captcha_stage` (string)
    > When set, adds functionality exactly like a Captcha stage, but baked into the Identification stage.

###### Return Type:

Changed response : **201 Created**

* Changed content type : `application/json`

    * Added property `captcha_stage` (string)
        > When set, adds functionality exactly like a Captcha stage, but baked into the Identification stage.

##### `GET` /stages/identification/

###### Parameters:

Added: `captcha_stage` in `query`

###### Return Type:

Changed response : **200 OK**

* Changed content type : `application/json`

    * Changed property `results` (array)

        Changed items (object):
            > IdentificationStage Serializer

        * Added property `captcha_stage` (string)
            > When set, adds functionality exactly like a Captcha stage, but baked into the Identification stage.
  • Loading branch information
authentik-automation[bot] committed Oct 25, 2024
1 parent 3fb4158 commit 17513f2
Show file tree
Hide file tree
Showing 14 changed files with 78 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "authentik-client"
version = "3.2024083.9"
version = "3.2024083.10"
authors = ["[email protected]"]
description = "Making authentication simple."
license = "MIT"
Expand Down
1 change: 1 addition & 0 deletions docs/IdentificationChallenge.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Name | Type | Description | Notes
**allow_show_password** | Option<**bool**> | | [optional][default to false]
**application_pre** | Option<**String**> | | [optional]
**flow_designation** | [**models::FlowDesignationEnum**](FlowDesignationEnum.md) | |
**captcha_stage** | Option<[**models::CaptchaChallenge**](CaptchaChallenge.md)> | | [optional]
**enroll_url** | Option<**String**> | | [optional]
**recovery_url** | Option<**String**> | | [optional]
**passwordless_url** | Option<**String**> | | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/IdentificationChallengeResponseRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Name | Type | Description | Notes
**component** | Option<**String**> | | [optional][default to ak-stage-identification]
**uid_field** | **String** | |
**password** | Option<**String**> | | [optional]
**captcha_token** | Option<**String**> | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
1 change: 1 addition & 0 deletions docs/IdentificationStage.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Name | Type | Description | Notes
**flow_set** | Option<[**Vec<models::FlowSet>**](FlowSet.md)> | | [optional]
**user_fields** | Option<[**Vec<models::UserFieldsEnum>**](UserFieldsEnum.md)> | Fields of the user object to match against. (Hold shift to select multiple options) | [optional]
**password_stage** | Option<[**uuid::Uuid**](uuid::Uuid.md)> | When set, shows a password field, instead of showing the password field as separate step. | [optional]
**captcha_stage** | Option<[**uuid::Uuid**](uuid::Uuid.md)> | When set, adds functionality exactly like a Captcha stage, but baked into the Identification stage. | [optional]
**case_insensitive_matching** | Option<**bool**> | When enabled, user fields are matched regardless of their casing. | [optional]
**show_matched_user** | Option<**bool**> | When a valid username/email has been entered, and this option is enabled, the user's username and avatar will be shown. Otherwise, the text that the user entered will be shown | [optional]
**enrollment_flow** | Option<[**uuid::Uuid**](uuid::Uuid.md)> | Optional enrollment flow, which is linked at the bottom of the page. | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/IdentificationStageRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Name | Type | Description | Notes
**flow_set** | Option<[**Vec<models::FlowSetRequest>**](FlowSetRequest.md)> | | [optional]
**user_fields** | Option<[**Vec<models::UserFieldsEnum>**](UserFieldsEnum.md)> | Fields of the user object to match against. (Hold shift to select multiple options) | [optional]
**password_stage** | Option<[**uuid::Uuid**](uuid::Uuid.md)> | When set, shows a password field, instead of showing the password field as separate step. | [optional]
**captcha_stage** | Option<[**uuid::Uuid**](uuid::Uuid.md)> | When set, adds functionality exactly like a Captcha stage, but baked into the Identification stage. | [optional]
**case_insensitive_matching** | Option<**bool**> | When enabled, user fields are matched regardless of their casing. | [optional]
**show_matched_user** | Option<**bool**> | When a valid username/email has been entered, and this option is enabled, the user's username and avatar will be shown. Otherwise, the text that the user entered will be shown | [optional]
**enrollment_flow** | Option<[**uuid::Uuid**](uuid::Uuid.md)> | Optional enrollment flow, which is linked at the bottom of the page. | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/PatchedIdentificationStageRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Name | Type | Description | Notes
**flow_set** | Option<[**Vec<models::FlowSetRequest>**](FlowSetRequest.md)> | | [optional]
**user_fields** | Option<[**Vec<models::UserFieldsEnum>**](UserFieldsEnum.md)> | Fields of the user object to match against. (Hold shift to select multiple options) | [optional]
**password_stage** | Option<[**uuid::Uuid**](uuid::Uuid.md)> | When set, shows a password field, instead of showing the password field as separate step. | [optional]
**captcha_stage** | Option<[**uuid::Uuid**](uuid::Uuid.md)> | When set, adds functionality exactly like a Captcha stage, but baked into the Identification stage. | [optional]
**case_insensitive_matching** | Option<**bool**> | When enabled, user fields are matched regardless of their casing. | [optional]
**show_matched_user** | Option<**bool**> | When a valid username/email has been entered, and this option is enabled, the user's username and avatar will be shown. Otherwise, the text that the user entered will be shown | [optional]
**enrollment_flow** | Option<[**uuid::Uuid**](uuid::Uuid.md)> | Optional enrollment flow, which is linked at the bottom of the page. | [optional]
Expand Down
3 changes: 2 additions & 1 deletion docs/StagesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -3250,7 +3250,7 @@ Name | Type | Description | Required | Notes

## stages_identification_list

> models::PaginatedIdentificationStageList stages_identification_list(case_insensitive_matching, enrollment_flow, name, ordering, page, page_size, password_stage, passwordless_flow, recovery_flow, search, show_matched_user, show_source_labels)
> models::PaginatedIdentificationStageList stages_identification_list(captcha_stage, case_insensitive_matching, enrollment_flow, name, ordering, page, page_size, password_stage, passwordless_flow, recovery_flow, search, show_matched_user, show_source_labels)

IdentificationStage Viewset
Expand All @@ -3260,6 +3260,7 @@ IdentificationStage Viewset

Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**captcha_stage** | Option<**uuid::Uuid**> | | |
**case_insensitive_matching** | Option<**bool**> | | |
**enrollment_flow** | Option<**uuid::Uuid**> | | |
**name** | Option<**String**> | | |
Expand Down
28 changes: 28 additions & 0 deletions schema.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33862,6 +33862,11 @@ paths:
operationId: stages_identification_list
description: IdentificationStage Viewset
parameters:
- in: query
name: captcha_stage
schema:
type: string
format: uuid
- in: query
name: case_insensitive_matching
schema:
Expand Down Expand Up @@ -42504,6 +42509,8 @@ components:
type: string
flow_designation:
$ref: '#/components/schemas/FlowDesignationEnum'
captcha_stage:
$ref: '#/components/schemas/CaptchaChallenge'
enroll_url:
type: string
recovery_url:
Expand Down Expand Up @@ -42538,6 +42545,9 @@ components:
password:
type: string
nullable: true
captcha_token:
type: string
nullable: true
required:
- uid_field
IdentificationStage:
Expand Down Expand Up @@ -42583,6 +42593,12 @@ components:
nullable: true
description: When set, shows a password field, instead of showing the password
field as separate step.
captcha_stage:
type: string
format: uuid
nullable: true
description: When set, adds functionality exactly like a Captcha stage,
but baked into the Identification stage.
case_insensitive_matching:
type: boolean
description: When enabled, user fields are matched regardless of their casing.
Expand Down Expand Up @@ -42651,6 +42667,12 @@ components:
nullable: true
description: When set, shows a password field, instead of showing the password
field as separate step.
captcha_stage:
type: string
format: uuid
nullable: true
description: When set, adds functionality exactly like a Captcha stage,
but baked into the Identification stage.
case_insensitive_matching:
type: boolean
description: When enabled, user fields are matched regardless of their casing.
Expand Down Expand Up @@ -48241,6 +48263,12 @@ components:
nullable: true
description: When set, shows a password field, instead of showing the password
field as separate step.
captcha_stage:
type: string
format: uuid
nullable: true
description: When set, adds functionality exactly like a Captcha stage,
but baked into the Identification stage.
case_insensitive_matching:
type: boolean
description: When enabled, user fields are matched regardless of their casing.
Expand Down
4 changes: 4 additions & 0 deletions src/apis/stages_api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6218,6 +6218,7 @@ pub async fn stages_identification_destroy(
/// IdentificationStage Viewset
pub async fn stages_identification_list(
configuration: &configuration::Configuration,
captcha_stage: Option<&str>,
case_insensitive_matching: Option<bool>,
enrollment_flow: Option<&str>,
name: Option<&str>,
Expand All @@ -6238,6 +6239,9 @@ pub async fn stages_identification_list(
let local_var_uri_str = format!("{}/stages/identification/", local_var_configuration.base_path);
let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str());

if let Some(ref local_var_str) = captcha_stage {
local_var_req_builder = local_var_req_builder.query(&[("captcha_stage", &local_var_str.to_string())]);
}
if let Some(ref local_var_str) = case_insensitive_matching {
local_var_req_builder =
local_var_req_builder.query(&[("case_insensitive_matching", &local_var_str.to_string())]);
Expand Down
3 changes: 3 additions & 0 deletions src/models/identification_challenge.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ pub struct IdentificationChallenge {
pub application_pre: Option<String>,
#[serde(rename = "flow_designation")]
pub flow_designation: models::FlowDesignationEnum,
#[serde(rename = "captcha_stage", skip_serializing_if = "Option::is_none")]
pub captcha_stage: Option<models::CaptchaChallenge>,
#[serde(rename = "enroll_url", skip_serializing_if = "Option::is_none")]
pub enroll_url: Option<String>,
#[serde(rename = "recovery_url", skip_serializing_if = "Option::is_none")]
Expand Down Expand Up @@ -62,6 +64,7 @@ impl IdentificationChallenge {
allow_show_password: None,
application_pre: None,
flow_designation,
captcha_stage: None,
enroll_url: None,
recovery_url: None,
passwordless_url: None,
Expand Down
8 changes: 8 additions & 0 deletions src/models/identification_challenge_response_request.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ pub struct IdentificationChallengeResponseRequest {
skip_serializing_if = "Option::is_none"
)]
pub password: Option<Option<String>>,
#[serde(
rename = "captcha_token",
default,
with = "::serde_with::rust::double_option",
skip_serializing_if = "Option::is_none"
)]
pub captcha_token: Option<Option<String>>,
}

impl IdentificationChallengeResponseRequest {
Expand All @@ -34,6 +41,7 @@ impl IdentificationChallengeResponseRequest {
component: None,
uid_field,
password: None,
captcha_token: None,
}
}
}
9 changes: 9 additions & 0 deletions src/models/identification_stage.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,14 @@ pub struct IdentificationStage {
skip_serializing_if = "Option::is_none"
)]
pub password_stage: Option<Option<uuid::Uuid>>,
/// When set, adds functionality exactly like a Captcha stage, but baked into the Identification stage.
#[serde(
rename = "captcha_stage",
default,
with = "::serde_with::rust::double_option",
skip_serializing_if = "Option::is_none"
)]
pub captcha_stage: Option<Option<uuid::Uuid>>,
/// When enabled, user fields are matched regardless of their casing.
#[serde(rename = "case_insensitive_matching", skip_serializing_if = "Option::is_none")]
pub case_insensitive_matching: Option<bool>,
Expand Down Expand Up @@ -103,6 +111,7 @@ impl IdentificationStage {
flow_set: None,
user_fields: None,
password_stage: None,
captcha_stage: None,
case_insensitive_matching: None,
show_matched_user: None,
enrollment_flow: None,
Expand Down
9 changes: 9 additions & 0 deletions src/models/identification_stage_request.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ pub struct IdentificationStageRequest {
skip_serializing_if = "Option::is_none"
)]
pub password_stage: Option<Option<uuid::Uuid>>,
/// When set, adds functionality exactly like a Captcha stage, but baked into the Identification stage.
#[serde(
rename = "captcha_stage",
default,
with = "::serde_with::rust::double_option",
skip_serializing_if = "Option::is_none"
)]
pub captcha_stage: Option<Option<uuid::Uuid>>,
/// When enabled, user fields are matched regardless of their casing.
#[serde(rename = "case_insensitive_matching", skip_serializing_if = "Option::is_none")]
pub case_insensitive_matching: Option<bool>,
Expand Down Expand Up @@ -77,6 +85,7 @@ impl IdentificationStageRequest {
flow_set: None,
user_fields: None,
password_stage: None,
captcha_stage: None,
case_insensitive_matching: None,
show_matched_user: None,
enrollment_flow: None,
Expand Down
9 changes: 9 additions & 0 deletions src/models/patched_identification_stage_request.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ pub struct PatchedIdentificationStageRequest {
skip_serializing_if = "Option::is_none"
)]
pub password_stage: Option<Option<uuid::Uuid>>,
/// When set, adds functionality exactly like a Captcha stage, but baked into the Identification stage.
#[serde(
rename = "captcha_stage",
default,
with = "::serde_with::rust::double_option",
skip_serializing_if = "Option::is_none"
)]
pub captcha_stage: Option<Option<uuid::Uuid>>,
/// When enabled, user fields are matched regardless of their casing.
#[serde(rename = "case_insensitive_matching", skip_serializing_if = "Option::is_none")]
pub case_insensitive_matching: Option<bool>,
Expand Down Expand Up @@ -77,6 +85,7 @@ impl PatchedIdentificationStageRequest {
flow_set: None,
user_fields: None,
password_stage: None,
captcha_stage: None,
case_insensitive_matching: None,
show_matched_user: None,
enrollment_flow: None,
Expand Down

0 comments on commit 17513f2

Please sign in to comment.