Skip to content
This repository has been archived by the owner on Apr 17, 2024. It is now read-only.

Commit

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

##### `GET` /stages/authenticator/sms/{stage_uuid}/

###### Return Type:

Changed response : **200 OK**

* Changed content type : `application/json`

    * Changed property `verify_only` (boolean)
        > When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future.

##### `PUT` /stages/authenticator/sms/{stage_uuid}/

###### Request:

Changed content type : `application/json`

* Changed property `verify_only` (boolean)
    > When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future.

###### Return Type:

Changed response : **200 OK**

* Changed content type : `application/json`

    * Changed property `verify_only` (boolean)
        > When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future.

##### `PATCH` /stages/authenticator/sms/{stage_uuid}/

###### Request:

Changed content type : `application/json`

* Changed property `verify_only` (boolean)
    > When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future.

###### Return Type:

Changed response : **200 OK**

* Changed content type : `application/json`

    * Changed property `verify_only` (boolean)
        > When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future.

##### `POST` /stages/authenticator/sms/

###### Request:

Changed content type : `application/json`

* Changed property `verify_only` (boolean)
    > When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future.

###### Return Type:

Changed response : **201 Created**

* Changed content type : `application/json`

    * Changed property `verify_only` (boolean)
        > When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future.

##### `GET` /stages/authenticator/sms/

###### Return Type:

Changed response : **200 OK**

* Changed content type : `application/json`

    * Changed property `results` (array)

        Changed items (object):
            > AuthenticatorSMSStage Serializer

        * Changed property `verify_only` (boolean)
            > When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future.
  • Loading branch information
authentik-automation[bot] committed Oct 3, 2023
1 parent 24a4356 commit e154ce7
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/AuthenticatorSMSStage.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Name | Type | Description | Notes
**friendlyName** | **kotlin.String** | | [optional]
**authPassword** | **kotlin.String** | | [optional]
**authType** | [**AuthTypeEnum**](AuthTypeEnum.md) | | [optional]
**verifyOnly** | **kotlin.Boolean** | When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not re-used in the future. | [optional]
**verifyOnly** | **kotlin.Boolean** | When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future. | [optional]
**mapping** | [**java.util.UUID**](java.util.UUID.md) | Optionally modify the payload being sent to custom providers. | [optional]


Expand Down
2 changes: 1 addition & 1 deletion docs/AuthenticatorSMSStageRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Name | Type | Description | Notes
**friendlyName** | **kotlin.String** | | [optional]
**authPassword** | **kotlin.String** | | [optional]
**authType** | [**AuthTypeEnum**](AuthTypeEnum.md) | | [optional]
**verifyOnly** | **kotlin.Boolean** | When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not re-used in the future. | [optional]
**verifyOnly** | **kotlin.Boolean** | When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future. | [optional]
**mapping** | [**java.util.UUID**](java.util.UUID.md) | Optionally modify the payload being sent to custom providers. | [optional]


Expand Down
2 changes: 1 addition & 1 deletion docs/PatchedAuthenticatorSMSStageRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Name | Type | Description | Notes
**auth** | **kotlin.String** | | [optional]
**authPassword** | **kotlin.String** | | [optional]
**authType** | [**AuthTypeEnum**](AuthTypeEnum.md) | | [optional]
**verifyOnly** | **kotlin.Boolean** | When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not re-used in the future. | [optional]
**verifyOnly** | **kotlin.Boolean** | When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future. | [optional]
**mapping** | [**java.util.UUID**](java.util.UUID.md) | Optionally modify the payload being sent to custom providers. | [optional]


Expand Down
6 changes: 3 additions & 3 deletions schema.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27436,7 +27436,7 @@ components:
type: boolean
description: When enabled, the Phone number is only used during enrollment
to verify the users authenticity. Only a hash of the phone number is saved
to ensure it is not re-used in the future.
to ensure it is not reused in the future.
mapping:
type: string
format: uuid
Expand Down Expand Up @@ -27493,7 +27493,7 @@ components:
type: boolean
description: When enabled, the Phone number is only used during enrollment
to verify the users authenticity. Only a hash of the phone number is saved
to ensure it is not re-used in the future.
to ensure it is not reused in the future.
mapping:
type: string
format: uuid
Expand Down Expand Up @@ -34530,7 +34530,7 @@ components:
type: boolean
description: When enabled, the Phone number is only used during enrollment
to verify the users authenticity. Only a hash of the phone number is saved
to ensure it is not re-used in the future.
to ensure it is not reused in the future.
mapping:
type: string
format: uuid
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ import com.squareup.moshi.Json
* @param friendlyName
* @param authPassword
* @param authType
* @param verifyOnly When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not re-used in the future.
* @param verifyOnly When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future.
* @param mapping Optionally modify the payload being sent to custom providers.
*/

Expand Down Expand Up @@ -100,7 +100,7 @@ data class AuthenticatorSMSStage (
@Json(name = "auth_type")
val authType: AuthTypeEnum? = null,

/* When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not re-used in the future. */
/* When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future. */
@Json(name = "verify_only")
val verifyOnly: kotlin.Boolean? = null,

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import com.squareup.moshi.Json
* @param friendlyName
* @param authPassword
* @param authType
* @param verifyOnly When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not re-used in the future.
* @param verifyOnly When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future.
* @param mapping Optionally modify the payload being sent to custom providers.
*/

Expand Down Expand Up @@ -76,7 +76,7 @@ data class AuthenticatorSMSStageRequest (
@Json(name = "auth_type")
val authType: AuthTypeEnum? = null,

/* When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not re-used in the future. */
/* When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future. */
@Json(name = "verify_only")
val verifyOnly: kotlin.Boolean? = null,

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import com.squareup.moshi.Json
* @param auth
* @param authPassword
* @param authType
* @param verifyOnly When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not re-used in the future.
* @param verifyOnly When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future.
* @param mapping Optionally modify the payload being sent to custom providers.
*/

Expand Down Expand Up @@ -76,7 +76,7 @@ data class PatchedAuthenticatorSMSStageRequest (
@Json(name = "auth_type")
val authType: AuthTypeEnum? = null,

/* When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not re-used in the future. */
/* When enabled, the Phone number is only used during enrollment to verify the users authenticity. Only a hash of the phone number is saved to ensure it is not reused in the future. */
@Json(name = "verify_only")
val verifyOnly: kotlin.Boolean? = null,

Expand Down

0 comments on commit e154ce7

Please sign in to comment.