Update API Client

#### What's Changed --- ##### `GET` /providers/saml/{id}/ ###### Return Type: Changed response : **200 OK** * Changed content type : `application/json` * Added property `default_relay_state` (string) > Default relay_state value for IDP-initiated logins ##### `PUT` /providers/saml/{id}/ ###### Request: Changed content type : `application/json` * Added property `default_relay_state` (string) > Default relay_state value for IDP-initiated logins ###### Return Type: Changed response : **200 OK** * Changed content type : `application/json` * Added property `default_relay_state` (string) > Default relay_state value for IDP-initiated logins ##### `PATCH` /providers/saml/{id}/ ###### Request: Changed content type : `application/json` * Added property `default_relay_state` (string) > Default relay_state value for IDP-initiated logins ###### Return Type: Changed response : **200 OK** * Changed content type : `application/json` * Added property `default_relay_state` (string) > Default relay_state value for IDP-initiated logins ##### `POST` /providers/saml/ ###### Request: Changed content type : `application/json` * Added property `default_relay_state` (string) > Default relay_state value for IDP-initiated logins ###### Return Type: Changed response : **201 Created** * Changed content type : `application/json` * Added property `default_relay_state` (string) > Default relay_state value for IDP-initiated logins ##### `GET` /providers/saml/ ###### Parameters: Added: `default_relay_state` in `query` ###### Return Type: Changed response : **200 OK** * Changed content type : `application/json` * Changed property `results` (array) Changed items (object): > SAMLProvider Serializer * Added property `default_relay_state` (string) > Default relay_state value for IDP-initiated logins ##### `PUT` /core/transactional/applications/ ###### Request: Changed content type : `application/json` * Changed property `provider` (object) Updated `authentik_providers_saml.samlprovider` provider_model: * Added property `default_relay_state` (string) > Default relay_state value for IDP-initiated logins
goauthentik · Oct 8, 2023 · 01c2887 · 01c2887
1 parent ef3430f
commit 01c2887
Show file tree

Hide file tree

Showing 11 changed files with 262 additions and 2 deletions.
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -18136,6 +18136,13 @@ paths:
           format: uuid
           type: string
         style: form
+      - explode: true
+        in: query
+        name: default_relay_state
+        required: false
+        schema:
+          type: string
+        style: form
       - description: |-
           * `http://www.w3.org/2000/09/xmldsig#sha1` - SHA1
           * `http://www.w3.org/2001/04/xmlenc#sha256` - SHA256
@@ -41863,6 +41870,7 @@ components:
           verbose_name_plural: verbose_name_plural
           url_slo_redirect: url_slo_redirect
           session_valid_not_on_or_after: session_valid_not_on_or_after
+          default_relay_state: default_relay_state
           assigned_application_slug: assigned_application_slug
           issuer: issuer
           url_sso_redirect: url_sso_redirect
@@ -41896,6 +41904,7 @@ components:
           verbose_name_plural: verbose_name_plural
           url_slo_redirect: url_slo_redirect
           session_valid_not_on_or_after: session_valid_not_on_or_after
+          default_relay_state: default_relay_state
           assigned_application_slug: assigned_application_slug
           issuer: issuer
           url_sso_redirect: url_sso_redirect
@@ -46492,6 +46501,7 @@ components:
         audience: audience
         session_valid_not_on_or_after: session_valid_not_on_or_after
         sp_binding: ""
+        default_relay_state: default_relay_state
         acs_url: https://openapi-generator.tech
         issuer: issuer
         assertion_valid_not_before: assertion_valid_not_before
@@ -46588,6 +46598,9 @@ components:
             * `redirect` - Redirect
             * `post` - Post
           title: Service Provider Binding
+        default_relay_state:
+          description: Default relay_state value for IDP-initiated logins
+          type: string
       type: object
     PatchedSAMLSourceRequest:
       description: SAMLSource Serializer
@@ -49368,6 +49381,7 @@ components:
         verbose_name_plural: verbose_name_plural
         url_slo_redirect: url_slo_redirect
         session_valid_not_on_or_after: session_valid_not_on_or_after
+        default_relay_state: default_relay_state
         assigned_application_slug: assigned_application_slug
         issuer: issuer
         url_sso_redirect: url_sso_redirect
@@ -49508,6 +49522,9 @@ components:
             * `redirect` - Redirect
             * `post` - Post
           title: Service Provider Binding
+        default_relay_state:
+          description: Default relay_state value for IDP-initiated logins
+          type: string
         url_download_metadata:
           description: Get metadata download URL
           readOnly: true
@@ -49575,6 +49592,7 @@ components:
         audience: audience
         session_valid_not_on_or_after: session_valid_not_on_or_after
         sp_binding: ""
+        default_relay_state: default_relay_state
         acs_url: https://openapi-generator.tech
         issuer: issuer
         assertion_valid_not_before: assertion_valid_not_before
@@ -49671,6 +49689,9 @@ components:
             * `redirect` - Redirect
             * `post` - Post
           title: Service Provider Binding
+        default_relay_state:
+          description: Default relay_state value for IDP-initiated logins
+          type: string
       required:
       - acs_url
       - authorization_flow

diff --git a/api_providers.go b/api_providers.go
diff --git a/docs/ModelRequest.md b/docs/ModelRequest.md
@@ -53,6 +53,7 @@ Name | Type | Description | Notes
 **SigningKp** | Pointer to **NullableString** | Keypair used to sign outgoing Responses going to the Service Provider. | [optional] 
 **VerificationKp** | Pointer to **NullableString** | When selected, incoming assertion&#39;s Signatures will be validated against this certificate. To allow unsigned Requests, leave on default. | [optional] 
 **SpBinding** | Pointer to [**SpBindingEnum**](SpBindingEnum.md) | This determines how authentik sends the response back to the Service Provider.  * &#x60;redirect&#x60; - Redirect * &#x60;post&#x60; - Post | [optional] 
+**DefaultRelayState** | Pointer to **string** | Default relay_state value for IDP-initiated logins | [optional] 
 **PropertyMappingsGroup** | Pointer to **[]string** | Property mappings used for group creation/updating. | [optional] 
 **Url** | **string** | Base URL to SCIM requests, usually ends in /v2 | 
 **Token** | **string** | Authentication token | 
@@ -1353,6 +1354,31 @@ SetSpBinding sets SpBinding field to given value.
 
 HasSpBinding returns a boolean if a field has been set.
 
+### GetDefaultRelayState
+
+`func (o *ModelRequest) GetDefaultRelayState() string`
+
+GetDefaultRelayState returns the DefaultRelayState field if non-nil, zero value otherwise.
+
+### GetDefaultRelayStateOk
+
+`func (o *ModelRequest) GetDefaultRelayStateOk() (*string, bool)`
+
+GetDefaultRelayStateOk returns a tuple with the DefaultRelayState field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetDefaultRelayState
+
+`func (o *ModelRequest) SetDefaultRelayState(v string)`
+
+SetDefaultRelayState sets DefaultRelayState field to given value.
+
+### HasDefaultRelayState
+
+`func (o *ModelRequest) HasDefaultRelayState() bool`
+
+HasDefaultRelayState returns a boolean if a field has been set.
+
 ### GetPropertyMappingsGroup
 
 `func (o *ModelRequest) GetPropertyMappingsGroup() []string`

diff --git a/docs/PatchedSAMLProviderRequest.md b/docs/PatchedSAMLProviderRequest.md
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
 **SigningKp** | Pointer to **NullableString** | Keypair used to sign outgoing Responses going to the Service Provider. | [optional] 
 **VerificationKp** | Pointer to **NullableString** | When selected, incoming assertion&#39;s Signatures will be validated against this certificate. To allow unsigned Requests, leave on default. | [optional] 
 **SpBinding** | Pointer to [**SpBindingEnum**](SpBindingEnum.md) | This determines how authentik sends the response back to the Service Provider.  * &#x60;redirect&#x60; - Redirect * &#x60;post&#x60; - Post | [optional] 
+**DefaultRelayState** | Pointer to **string** | Default relay_state value for IDP-initiated logins | [optional] 
 
 ## Methods
 
@@ -480,6 +481,31 @@ SetSpBinding sets SpBinding field to given value.
 
 HasSpBinding returns a boolean if a field has been set.
 
+### GetDefaultRelayState
+
+`func (o *PatchedSAMLProviderRequest) GetDefaultRelayState() string`
+
+GetDefaultRelayState returns the DefaultRelayState field if non-nil, zero value otherwise.
+
+### GetDefaultRelayStateOk
+
+`func (o *PatchedSAMLProviderRequest) GetDefaultRelayStateOk() (*string, bool)`
+
+GetDefaultRelayStateOk returns a tuple with the DefaultRelayState field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetDefaultRelayState
+
+`func (o *PatchedSAMLProviderRequest) SetDefaultRelayState(v string)`
+
+SetDefaultRelayState sets DefaultRelayState field to given value.
+
+### HasDefaultRelayState
+
+`func (o *PatchedSAMLProviderRequest) HasDefaultRelayState() bool`
+
+HasDefaultRelayState returns a boolean if a field has been set.
+
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/ProvidersApi.md b/docs/ProvidersApi.md
@@ -2799,7 +2799,7 @@ Name | Type | Description  | Notes
 
 ## ProvidersSamlList
 
-> PaginatedSAMLProviderList ProvidersSamlList(ctx).AcsUrl(acsUrl).AssertionValidNotBefore(assertionValidNotBefore).AssertionValidNotOnOrAfter(assertionValidNotOnOrAfter).Audience(audience).AuthenticationFlow(authenticationFlow).AuthorizationFlow(authorizationFlow).BackchannelApplication(backchannelApplication).DigestAlgorithm(digestAlgorithm).IsBackchannel(isBackchannel).Issuer(issuer).Name(name).NameIdMapping(nameIdMapping).Ordering(ordering).Page(page).PageSize(pageSize).PropertyMappings(propertyMappings).Search(search).SessionValidNotOnOrAfter(sessionValidNotOnOrAfter).SignatureAlgorithm(signatureAlgorithm).SigningKp(signingKp).SpBinding(spBinding).VerificationKp(verificationKp).Execute()
+> PaginatedSAMLProviderList ProvidersSamlList(ctx).AcsUrl(acsUrl).AssertionValidNotBefore(assertionValidNotBefore).AssertionValidNotOnOrAfter(assertionValidNotOnOrAfter).Audience(audience).AuthenticationFlow(authenticationFlow).AuthorizationFlow(authorizationFlow).BackchannelApplication(backchannelApplication).DefaultRelayState(defaultRelayState).DigestAlgorithm(digestAlgorithm).IsBackchannel(isBackchannel).Issuer(issuer).Name(name).NameIdMapping(nameIdMapping).Ordering(ordering).Page(page).PageSize(pageSize).PropertyMappings(propertyMappings).Search(search).SessionValidNotOnOrAfter(sessionValidNotOnOrAfter).SignatureAlgorithm(signatureAlgorithm).SigningKp(signingKp).SpBinding(spBinding).VerificationKp(verificationKp).Execute()
 
 
 
@@ -2825,6 +2825,7 @@ func main() {
     authenticationFlow := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
     authorizationFlow := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
     backchannelApplication := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
+    defaultRelayState := "defaultRelayState_example" // string |  (optional)
     digestAlgorithm := "digestAlgorithm_example" // string | * `http://www.w3.org/2000/09/xmldsig#sha1` - SHA1 * `http://www.w3.org/2001/04/xmlenc#sha256` - SHA256 * `http://www.w3.org/2001/04/xmldsig-more#sha384` - SHA384 * `http://www.w3.org/2001/04/xmlenc#sha512` - SHA512 (optional)
     isBackchannel := true // bool |  (optional)
     issuer := "issuer_example" // string |  (optional)
@@ -2843,7 +2844,7 @@ func main() {
 
     configuration := openapiclient.NewConfiguration()
     apiClient := openapiclient.NewAPIClient(configuration)
-    resp, r, err := apiClient.ProvidersApi.ProvidersSamlList(context.Background()).AcsUrl(acsUrl).AssertionValidNotBefore(assertionValidNotBefore).AssertionValidNotOnOrAfter(assertionValidNotOnOrAfter).Audience(audience).AuthenticationFlow(authenticationFlow).AuthorizationFlow(authorizationFlow).BackchannelApplication(backchannelApplication).DigestAlgorithm(digestAlgorithm).IsBackchannel(isBackchannel).Issuer(issuer).Name(name).NameIdMapping(nameIdMapping).Ordering(ordering).Page(page).PageSize(pageSize).PropertyMappings(propertyMappings).Search(search).SessionValidNotOnOrAfter(sessionValidNotOnOrAfter).SignatureAlgorithm(signatureAlgorithm).SigningKp(signingKp).SpBinding(spBinding).VerificationKp(verificationKp).Execute()
+    resp, r, err := apiClient.ProvidersApi.ProvidersSamlList(context.Background()).AcsUrl(acsUrl).AssertionValidNotBefore(assertionValidNotBefore).AssertionValidNotOnOrAfter(assertionValidNotOnOrAfter).Audience(audience).AuthenticationFlow(authenticationFlow).AuthorizationFlow(authorizationFlow).BackchannelApplication(backchannelApplication).DefaultRelayState(defaultRelayState).DigestAlgorithm(digestAlgorithm).IsBackchannel(isBackchannel).Issuer(issuer).Name(name).NameIdMapping(nameIdMapping).Ordering(ordering).Page(page).PageSize(pageSize).PropertyMappings(propertyMappings).Search(search).SessionValidNotOnOrAfter(sessionValidNotOnOrAfter).SignatureAlgorithm(signatureAlgorithm).SigningKp(signingKp).SpBinding(spBinding).VerificationKp(verificationKp).Execute()
     if err != nil {
         fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersSamlList``: %v\n", err)
         fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -2871,6 +2872,7 @@ Name | Type | Description  | Notes
  **authenticationFlow** | **string** |  | 
  **authorizationFlow** | **string** |  | 
  **backchannelApplication** | **string** |  | 
+ **defaultRelayState** | **string** |  | 
  **digestAlgorithm** | **string** | * &#x60;http://www.w3.org/2000/09/xmldsig#sha1&#x60; - SHA1 * &#x60;http://www.w3.org/2001/04/xmlenc#sha256&#x60; - SHA256 * &#x60;http://www.w3.org/2001/04/xmldsig-more#sha384&#x60; - SHA384 * &#x60;http://www.w3.org/2001/04/xmlenc#sha512&#x60; - SHA512 | 
  **isBackchannel** | **bool** |  | 
  **issuer** | **string** |  | 

diff --git a/docs/SAMLProvider.md b/docs/SAMLProvider.md
@@ -29,6 +29,7 @@ Name | Type | Description | Notes
 **SigningKp** | Pointer to **NullableString** | Keypair used to sign outgoing Responses going to the Service Provider. | [optional] 
 **VerificationKp** | Pointer to **NullableString** | When selected, incoming assertion&#39;s Signatures will be validated against this certificate. To allow unsigned Requests, leave on default. | [optional] 
 **SpBinding** | Pointer to [**SpBindingEnum**](SpBindingEnum.md) | This determines how authentik sends the response back to the Service Provider.  * &#x60;redirect&#x60; - Redirect * &#x60;post&#x60; - Post | [optional] 
+**DefaultRelayState** | Pointer to **string** | Default relay_state value for IDP-initiated logins | [optional] 
 **UrlDownloadMetadata** | **string** | Get metadata download URL | [readonly] 
 **UrlSsoPost** | **string** | Get SSO Post URL | [readonly] 
 **UrlSsoRedirect** | **string** | Get SSO Redirect URL | [readonly] 
@@ -660,6 +661,31 @@ SetSpBinding sets SpBinding field to given value.
 
 HasSpBinding returns a boolean if a field has been set.
 
+### GetDefaultRelayState
+
+`func (o *SAMLProvider) GetDefaultRelayState() string`
+
+GetDefaultRelayState returns the DefaultRelayState field if non-nil, zero value otherwise.
+
+### GetDefaultRelayStateOk
+
+`func (o *SAMLProvider) GetDefaultRelayStateOk() (*string, bool)`
+
+GetDefaultRelayStateOk returns a tuple with the DefaultRelayState field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetDefaultRelayState
+
+`func (o *SAMLProvider) SetDefaultRelayState(v string)`
+
+SetDefaultRelayState sets DefaultRelayState field to given value.
+
+### HasDefaultRelayState
+
+`func (o *SAMLProvider) HasDefaultRelayState() bool`
+
+HasDefaultRelayState returns a boolean if a field has been set.
+
 ### GetUrlDownloadMetadata
 
 `func (o *SAMLProvider) GetUrlDownloadMetadata() string`

diff --git a/docs/SAMLProviderRequest.md b/docs/SAMLProviderRequest.md
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
 **SigningKp** | Pointer to **NullableString** | Keypair used to sign outgoing Responses going to the Service Provider. | [optional] 
 **VerificationKp** | Pointer to **NullableString** | When selected, incoming assertion&#39;s Signatures will be validated against this certificate. To allow unsigned Requests, leave on default. | [optional] 
 **SpBinding** | Pointer to [**SpBindingEnum**](SpBindingEnum.md) | This determines how authentik sends the response back to the Service Provider.  * &#x60;redirect&#x60; - Redirect * &#x60;post&#x60; - Post | [optional] 
+**DefaultRelayState** | Pointer to **string** | Default relay_state value for IDP-initiated logins | [optional] 
 
 ## Methods
 
@@ -465,6 +466,31 @@ SetSpBinding sets SpBinding field to given value.
 
 HasSpBinding returns a boolean if a field has been set.
 
+### GetDefaultRelayState
+
+`func (o *SAMLProviderRequest) GetDefaultRelayState() string`
+
+GetDefaultRelayState returns the DefaultRelayState field if non-nil, zero value otherwise.
+
+### GetDefaultRelayStateOk
+
+`func (o *SAMLProviderRequest) GetDefaultRelayStateOk() (*string, bool)`
+
+GetDefaultRelayStateOk returns a tuple with the DefaultRelayState field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetDefaultRelayState
+
+`func (o *SAMLProviderRequest) SetDefaultRelayState(v string)`
+
+SetDefaultRelayState sets DefaultRelayState field to given value.
+
+### HasDefaultRelayState
+
+`func (o *SAMLProviderRequest) HasDefaultRelayState() bool`
+
+HasDefaultRelayState returns a boolean if a field has been set.
+
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/model_patched_saml_provider_request.go b/model_patched_saml_provider_request.go