Update API Client

#### 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.
goauthentik · Oct 25, 2024 · 211427c · 211427c
1 parent 0ca53cd
commit 211427c
Show file tree

Hide file tree

Showing 16 changed files with 557 additions and 23 deletions.
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -37679,6 +37679,14 @@ paths:
       description: IdentificationStage Viewset
       operationId: stages_identification_list
       parameters:
+      - explode: true
+        in: query
+        name: captcha_stage
+        required: false
+        schema:
+          format: uuid
+          type: string
+        style: form
       - explode: true
         in: query
         name: case_insensitive_matching
@@ -48178,6 +48186,8 @@ components:
           type: string
         flow_designation:
           $ref: '#/components/schemas/FlowDesignationEnum'
+        captcha_stage:
+          $ref: '#/components/schemas/CaptchaChallenge'
         enroll_url:
           type: string
         recovery_url:
@@ -48212,6 +48222,9 @@ components:
         password:
           nullable: true
           type: string
+        captcha_token:
+          nullable: true
+          type: string
       required:
       - uid_field
       type: object
@@ -48261,6 +48274,7 @@ components:
         name: name
         password_stage: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         pk: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+        captcha_stage: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         recovery_flow: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         case_insensitive_matching: true
       properties:
@@ -48303,6 +48317,12 @@ components:
           format: uuid
           nullable: true
           type: string
+        captcha_stage:
+          description: "When set, adds functionality exactly like a Captcha stage,\
+            \ but baked into the Identification stage."
+          format: uuid
+          nullable: true
+          type: string
         case_insensitive_matching:
           description: "When enabled, user fields are matched regardless of their\
             \ casing."
@@ -48353,18 +48373,10 @@ components:
     IdentificationStageRequest:
       description: IdentificationStage Serializer
       example:
-        passwordless_flow: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
-        enrollment_flow: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         show_source_labels: true
-        user_fields:
-        - null
-        - null
-        show_matched_user: true
         sources:
         - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
-        name: name
-        password_stage: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         flow_set:
         - policy_engine_mode: null
           compatibility_mode: true
@@ -48382,8 +48394,17 @@ components:
           designation: ""
           title: title
           slug: slug
-        recovery_flow: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         pretend_user_exists: true
+        passwordless_flow: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+        enrollment_flow: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+        user_fields:
+        - null
+        - null
+        show_matched_user: true
+        name: name
+        password_stage: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+        captcha_stage: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+        recovery_flow: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         case_insensitive_matching: true
       properties:
         name:
@@ -48405,6 +48426,12 @@ components:
           format: uuid
           nullable: true
           type: string
+        captcha_stage:
+          description: "When set, adds functionality exactly like a Captcha stage,\
+            \ but baked into the Identification stage."
+          format: uuid
+          nullable: true
+          type: string
         case_insensitive_matching:
           description: "When enabled, user fields are matched regardless of their\
             \ casing."
@@ -54762,6 +54789,7 @@ components:
           name: name
           password_stage: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           pk: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+          captcha_stage: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           recovery_flow: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           case_insensitive_matching: true
         - show_source_labels: true
@@ -54807,6 +54835,7 @@ components:
           name: name
           password_stage: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           pk: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+          captcha_stage: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           recovery_flow: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
           case_insensitive_matching: true
       properties:
@@ -61504,18 +61533,10 @@ components:
     PatchedIdentificationStageRequest:
       description: IdentificationStage Serializer
       example:
-        passwordless_flow: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
-        enrollment_flow: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         show_source_labels: true
-        user_fields:
-        - null
-        - null
-        show_matched_user: true
         sources:
         - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
-        name: name
-        password_stage: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         flow_set:
         - policy_engine_mode: null
           compatibility_mode: true
@@ -61533,8 +61554,17 @@ components:
           designation: ""
           title: title
           slug: slug
-        recovery_flow: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         pretend_user_exists: true
+        passwordless_flow: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+        enrollment_flow: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+        user_fields:
+        - null
+        - null
+        show_matched_user: true
+        name: name
+        password_stage: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+        captcha_stage: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
+        recovery_flow: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         case_insensitive_matching: true
       properties:
         name:
@@ -61556,6 +61586,12 @@ components:
           format: uuid
           nullable: true
           type: string
+        captcha_stage:
+          description: "When set, adds functionality exactly like a Captcha stage,\
+            \ but baked into the Identification stage."
+          format: uuid
+          nullable: true
+          type: string
         case_insensitive_matching:
           description: "When enabled, user fields are matched regardless of their\
             \ casing."

diff --git a/api_stages.go b/api_stages.go
diff --git a/docs/ChallengeTypes.md b/docs/ChallengeTypes.md
@@ -43,6 +43,7 @@ Name | Type | Description | Notes
 **AllowShowPassword** | Pointer to **bool** |  | [optional] [default to false]
 **ApplicationPre** | Pointer to **string** |  | [optional] 
 **FlowDesignation** | [**FlowDesignationEnum**](FlowDesignationEnum.md) |  | 
+**CaptchaStage** | Pointer to [**CaptchaChallenge**](CaptchaChallenge.md) |  | [optional] 
 **EnrollUrl** | Pointer to **string** |  | [optional] 
 **RecoveryUrl** | Pointer to **string** |  | [optional] 
 **PasswordlessUrl** | Pointer to **string** |  | [optional] 
@@ -927,6 +928,31 @@ and a boolean to check if the value has been set.
 SetFlowDesignation sets FlowDesignation field to given value.
 
 
+### GetCaptchaStage
+
+`func (o *ChallengeTypes) GetCaptchaStage() CaptchaChallenge`
+
+GetCaptchaStage returns the CaptchaStage field if non-nil, zero value otherwise.
+
+### GetCaptchaStageOk
+
+`func (o *ChallengeTypes) GetCaptchaStageOk() (*CaptchaChallenge, bool)`
+
+GetCaptchaStageOk returns a tuple with the CaptchaStage field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetCaptchaStage
+
+`func (o *ChallengeTypes) SetCaptchaStage(v CaptchaChallenge)`
+
+SetCaptchaStage sets CaptchaStage field to given value.
+
+### HasCaptchaStage
+
+`func (o *ChallengeTypes) HasCaptchaStage() bool`
+
+HasCaptchaStage returns a boolean if a field has been set.
+
 ### GetEnrollUrl
 
 `func (o *ChallengeTypes) GetEnrollUrl() string`

diff --git a/docs/FlowChallengeResponseRequest.md b/docs/FlowChallengeResponseRequest.md
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
 **Token** | **string** |  | 
 **UidField** | **string** |  | 
 **Password** | **string** |  | 
+**CaptchaToken** | Pointer to **NullableString** |  | [optional] 
 **RememberMe** | **bool** |  | 
 
 ## Methods
@@ -286,6 +287,41 @@ and a boolean to check if the value has been set.
 SetPassword sets Password field to given value.
 
 
+### GetCaptchaToken
+
+`func (o *FlowChallengeResponseRequest) GetCaptchaToken() string`
+
+GetCaptchaToken returns the CaptchaToken field if non-nil, zero value otherwise.
+
+### GetCaptchaTokenOk
+
+`func (o *FlowChallengeResponseRequest) GetCaptchaTokenOk() (*string, bool)`
+
+GetCaptchaTokenOk returns a tuple with the CaptchaToken field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetCaptchaToken
+
+`func (o *FlowChallengeResponseRequest) SetCaptchaToken(v string)`
+
+SetCaptchaToken sets CaptchaToken field to given value.
+
+### HasCaptchaToken
+
+`func (o *FlowChallengeResponseRequest) HasCaptchaToken() bool`
+
+HasCaptchaToken returns a boolean if a field has been set.
+
+### SetCaptchaTokenNil
+
+`func (o *FlowChallengeResponseRequest) SetCaptchaTokenNil(b bool)`
+
+ SetCaptchaTokenNil sets the value for CaptchaToken to be an explicit nil
+
+### UnsetCaptchaToken
+`func (o *FlowChallengeResponseRequest) UnsetCaptchaToken()`
+
+UnsetCaptchaToken ensures that no value is present for CaptchaToken, not even an explicit nil
 ### GetRememberMe
 
 `func (o *FlowChallengeResponseRequest) GetRememberMe() bool`

diff --git a/docs/IdentificationChallenge.md b/docs/IdentificationChallenge.md
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **AllowShowPassword** | Pointer to **bool** |  | [optional] [default to false]
 **ApplicationPre** | Pointer to **string** |  | [optional] 
 **FlowDesignation** | [**FlowDesignationEnum**](FlowDesignationEnum.md) |  | 
+**CaptchaStage** | Pointer to [**CaptchaChallenge**](CaptchaChallenge.md) |  | [optional] 
 **EnrollUrl** | Pointer to **string** |  | [optional] 
 **RecoveryUrl** | Pointer to **string** |  | [optional] 
 **PasswordlessUrl** | Pointer to **string** |  | [optional] 
@@ -233,6 +234,31 @@ and a boolean to check if the value has been set.
 SetFlowDesignation sets FlowDesignation field to given value.
 
 
+### GetCaptchaStage
+
+`func (o *IdentificationChallenge) GetCaptchaStage() CaptchaChallenge`
+
+GetCaptchaStage returns the CaptchaStage field if non-nil, zero value otherwise.
+
+### GetCaptchaStageOk
+
+`func (o *IdentificationChallenge) GetCaptchaStageOk() (*CaptchaChallenge, bool)`
+
+GetCaptchaStageOk returns a tuple with the CaptchaStage field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetCaptchaStage
+
+`func (o *IdentificationChallenge) SetCaptchaStage(v CaptchaChallenge)`
+
+SetCaptchaStage sets CaptchaStage field to given value.
+
+### HasCaptchaStage
+
+`func (o *IdentificationChallenge) HasCaptchaStage() bool`
+
+HasCaptchaStage returns a boolean if a field has been set.
+
 ### GetEnrollUrl
 
 `func (o *IdentificationChallenge) GetEnrollUrl() string`

diff --git a/docs/IdentificationChallengeResponseRequest.md b/docs/IdentificationChallengeResponseRequest.md
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **Component** | Pointer to **string** |  | [optional] [default to "ak-stage-identification"]
 **UidField** | **string** |  | 
 **Password** | Pointer to **NullableString** |  | [optional] 
+**CaptchaToken** | Pointer to **NullableString** |  | [optional] 
 
 ## Methods
 
@@ -107,6 +108,41 @@ HasPassword returns a boolean if a field has been set.
 `func (o *IdentificationChallengeResponseRequest) UnsetPassword()`
 
 UnsetPassword ensures that no value is present for Password, not even an explicit nil
+### GetCaptchaToken
+
+`func (o *IdentificationChallengeResponseRequest) GetCaptchaToken() string`
+
+GetCaptchaToken returns the CaptchaToken field if non-nil, zero value otherwise.
+
+### GetCaptchaTokenOk
+
+`func (o *IdentificationChallengeResponseRequest) GetCaptchaTokenOk() (*string, bool)`
+
+GetCaptchaTokenOk returns a tuple with the CaptchaToken field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetCaptchaToken
+
+`func (o *IdentificationChallengeResponseRequest) SetCaptchaToken(v string)`
+
+SetCaptchaToken sets CaptchaToken field to given value.
+
+### HasCaptchaToken
+
+`func (o *IdentificationChallengeResponseRequest) HasCaptchaToken() bool`
+
+HasCaptchaToken returns a boolean if a field has been set.
+
+### SetCaptchaTokenNil
+
+`func (o *IdentificationChallengeResponseRequest) SetCaptchaTokenNil(b bool)`
+
+ SetCaptchaTokenNil sets the value for CaptchaToken to be an explicit nil
+
+### UnsetCaptchaToken
+`func (o *IdentificationChallengeResponseRequest) UnsetCaptchaToken()`
+
+UnsetCaptchaToken ensures that no value is present for CaptchaToken, not even an explicit nil
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)