Skip to content

Latest commit

 

History

History
776 lines (415 loc) · 24.3 KB

ProxyProvider.md

File metadata and controls

776 lines (415 loc) · 24.3 KB

ProxyProvider

Properties

Name Type Description Notes
Pk int32 [readonly]
Name string
AuthenticationFlow Pointer to NullableString Flow used for authentication when the associated application is accessed by an un-authenticated user. [optional]
AuthorizationFlow string Flow used when authorizing this provider.
InvalidationFlow string Flow used ending the session from a provider.
PropertyMappings Pointer to []string [optional]
Component string Get object component so that we know how to edit the object [readonly]
AssignedApplicationSlug string Internal application name, used in URLs. [readonly]
AssignedApplicationName string Application's display Name. [readonly]
AssignedBackchannelApplicationSlug string Internal application name, used in URLs. [readonly]
AssignedBackchannelApplicationName string Application's display Name. [readonly]
VerboseName string Return object's verbose_name [readonly]
VerboseNamePlural string Return object's plural verbose_name [readonly]
MetaModelName string Return internal model name [readonly]
ClientId string [readonly]
InternalHost Pointer to string [optional]
ExternalHost string
InternalHostSslValidation Pointer to bool Validate SSL Certificates of upstream servers [optional]
Certificate Pointer to NullableString [optional]
SkipPathRegex Pointer to string Regular expressions for which authentication is not required. Each new line is interpreted as a new Regular Expression. [optional]
BasicAuthEnabled Pointer to bool Set a custom HTTP-Basic Authentication header based on values from authentik. [optional]
BasicAuthPasswordAttribute Pointer to string User/Group Attribute used for the password part of the HTTP-Basic Header. [optional]
BasicAuthUserAttribute Pointer to string User/Group Attribute used for the user part of the HTTP-Basic Header. If not set, the user's Email address is used. [optional]
Mode Pointer to ProxyMode Enable support for forwardAuth in traefik and nginx auth_request. Exclusive with internal_host. [optional]
InterceptHeaderAuth Pointer to bool When enabled, this provider will intercept the authorization header and authenticate requests based on its value. [optional]
RedirectUris string [readonly]
CookieDomain Pointer to string [optional]
JwksSources Pointer to []string [optional]
AccessTokenValidity Pointer to string Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3). [optional]
RefreshTokenValidity Pointer to string Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3). [optional]
OutpostSet []string [readonly]

Methods

NewProxyProvider

func NewProxyProvider(pk int32, name string, authorizationFlow string, invalidationFlow string, component string, assignedApplicationSlug string, assignedApplicationName string, assignedBackchannelApplicationSlug string, assignedBackchannelApplicationName string, verboseName string, verboseNamePlural string, metaModelName string, clientId string, externalHost string, redirectUris string, outpostSet []string, ) *ProxyProvider

NewProxyProvider instantiates a new ProxyProvider object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewProxyProviderWithDefaults

func NewProxyProviderWithDefaults() *ProxyProvider

NewProxyProviderWithDefaults instantiates a new ProxyProvider object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetPk

func (o *ProxyProvider) GetPk() int32

GetPk returns the Pk field if non-nil, zero value otherwise.

GetPkOk

func (o *ProxyProvider) GetPkOk() (*int32, bool)

GetPkOk returns a tuple with the Pk field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPk

func (o *ProxyProvider) SetPk(v int32)

SetPk sets Pk field to given value.

GetName

func (o *ProxyProvider) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *ProxyProvider) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *ProxyProvider) SetName(v string)

SetName sets Name field to given value.

GetAuthenticationFlow

func (o *ProxyProvider) GetAuthenticationFlow() string

GetAuthenticationFlow returns the AuthenticationFlow field if non-nil, zero value otherwise.

GetAuthenticationFlowOk

func (o *ProxyProvider) GetAuthenticationFlowOk() (*string, bool)

GetAuthenticationFlowOk returns a tuple with the AuthenticationFlow field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAuthenticationFlow

func (o *ProxyProvider) SetAuthenticationFlow(v string)

SetAuthenticationFlow sets AuthenticationFlow field to given value.

HasAuthenticationFlow

func (o *ProxyProvider) HasAuthenticationFlow() bool

HasAuthenticationFlow returns a boolean if a field has been set.

SetAuthenticationFlowNil

func (o *ProxyProvider) SetAuthenticationFlowNil(b bool)

SetAuthenticationFlowNil sets the value for AuthenticationFlow to be an explicit nil

UnsetAuthenticationFlow

func (o *ProxyProvider) UnsetAuthenticationFlow()

UnsetAuthenticationFlow ensures that no value is present for AuthenticationFlow, not even an explicit nil

GetAuthorizationFlow

func (o *ProxyProvider) GetAuthorizationFlow() string

GetAuthorizationFlow returns the AuthorizationFlow field if non-nil, zero value otherwise.

GetAuthorizationFlowOk

func (o *ProxyProvider) GetAuthorizationFlowOk() (*string, bool)

GetAuthorizationFlowOk returns a tuple with the AuthorizationFlow field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAuthorizationFlow

func (o *ProxyProvider) SetAuthorizationFlow(v string)

SetAuthorizationFlow sets AuthorizationFlow field to given value.

GetInvalidationFlow

func (o *ProxyProvider) GetInvalidationFlow() string

GetInvalidationFlow returns the InvalidationFlow field if non-nil, zero value otherwise.

GetInvalidationFlowOk

func (o *ProxyProvider) GetInvalidationFlowOk() (*string, bool)

GetInvalidationFlowOk returns a tuple with the InvalidationFlow field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetInvalidationFlow

func (o *ProxyProvider) SetInvalidationFlow(v string)

SetInvalidationFlow sets InvalidationFlow field to given value.

GetPropertyMappings

func (o *ProxyProvider) GetPropertyMappings() []string

GetPropertyMappings returns the PropertyMappings field if non-nil, zero value otherwise.

GetPropertyMappingsOk

func (o *ProxyProvider) GetPropertyMappingsOk() (*[]string, bool)

GetPropertyMappingsOk returns a tuple with the PropertyMappings field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPropertyMappings

func (o *ProxyProvider) SetPropertyMappings(v []string)

SetPropertyMappings sets PropertyMappings field to given value.

HasPropertyMappings

func (o *ProxyProvider) HasPropertyMappings() bool

HasPropertyMappings returns a boolean if a field has been set.

GetComponent

func (o *ProxyProvider) GetComponent() string

GetComponent returns the Component field if non-nil, zero value otherwise.

GetComponentOk

func (o *ProxyProvider) GetComponentOk() (*string, bool)

GetComponentOk returns a tuple with the Component field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetComponent

func (o *ProxyProvider) SetComponent(v string)

SetComponent sets Component field to given value.

GetAssignedApplicationSlug

func (o *ProxyProvider) GetAssignedApplicationSlug() string

GetAssignedApplicationSlug returns the AssignedApplicationSlug field if non-nil, zero value otherwise.

GetAssignedApplicationSlugOk

func (o *ProxyProvider) GetAssignedApplicationSlugOk() (*string, bool)

GetAssignedApplicationSlugOk returns a tuple with the AssignedApplicationSlug field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAssignedApplicationSlug

func (o *ProxyProvider) SetAssignedApplicationSlug(v string)

SetAssignedApplicationSlug sets AssignedApplicationSlug field to given value.

GetAssignedApplicationName

func (o *ProxyProvider) GetAssignedApplicationName() string

GetAssignedApplicationName returns the AssignedApplicationName field if non-nil, zero value otherwise.

GetAssignedApplicationNameOk

func (o *ProxyProvider) GetAssignedApplicationNameOk() (*string, bool)

GetAssignedApplicationNameOk returns a tuple with the AssignedApplicationName field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAssignedApplicationName

func (o *ProxyProvider) SetAssignedApplicationName(v string)

SetAssignedApplicationName sets AssignedApplicationName field to given value.

GetAssignedBackchannelApplicationSlug

func (o *ProxyProvider) GetAssignedBackchannelApplicationSlug() string

GetAssignedBackchannelApplicationSlug returns the AssignedBackchannelApplicationSlug field if non-nil, zero value otherwise.

GetAssignedBackchannelApplicationSlugOk

func (o *ProxyProvider) GetAssignedBackchannelApplicationSlugOk() (*string, bool)

GetAssignedBackchannelApplicationSlugOk returns a tuple with the AssignedBackchannelApplicationSlug field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAssignedBackchannelApplicationSlug

func (o *ProxyProvider) SetAssignedBackchannelApplicationSlug(v string)

SetAssignedBackchannelApplicationSlug sets AssignedBackchannelApplicationSlug field to given value.

GetAssignedBackchannelApplicationName

func (o *ProxyProvider) GetAssignedBackchannelApplicationName() string

GetAssignedBackchannelApplicationName returns the AssignedBackchannelApplicationName field if non-nil, zero value otherwise.

GetAssignedBackchannelApplicationNameOk

func (o *ProxyProvider) GetAssignedBackchannelApplicationNameOk() (*string, bool)

GetAssignedBackchannelApplicationNameOk returns a tuple with the AssignedBackchannelApplicationName field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAssignedBackchannelApplicationName

func (o *ProxyProvider) SetAssignedBackchannelApplicationName(v string)

SetAssignedBackchannelApplicationName sets AssignedBackchannelApplicationName field to given value.

GetVerboseName

func (o *ProxyProvider) GetVerboseName() string

GetVerboseName returns the VerboseName field if non-nil, zero value otherwise.

GetVerboseNameOk

func (o *ProxyProvider) GetVerboseNameOk() (*string, bool)

GetVerboseNameOk returns a tuple with the VerboseName field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetVerboseName

func (o *ProxyProvider) SetVerboseName(v string)

SetVerboseName sets VerboseName field to given value.

GetVerboseNamePlural

func (o *ProxyProvider) GetVerboseNamePlural() string

GetVerboseNamePlural returns the VerboseNamePlural field if non-nil, zero value otherwise.

GetVerboseNamePluralOk

func (o *ProxyProvider) GetVerboseNamePluralOk() (*string, bool)

GetVerboseNamePluralOk returns a tuple with the VerboseNamePlural field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetVerboseNamePlural

func (o *ProxyProvider) SetVerboseNamePlural(v string)

SetVerboseNamePlural sets VerboseNamePlural field to given value.

GetMetaModelName

func (o *ProxyProvider) GetMetaModelName() string

GetMetaModelName returns the MetaModelName field if non-nil, zero value otherwise.

GetMetaModelNameOk

func (o *ProxyProvider) GetMetaModelNameOk() (*string, bool)

GetMetaModelNameOk returns a tuple with the MetaModelName field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetaModelName

func (o *ProxyProvider) SetMetaModelName(v string)

SetMetaModelName sets MetaModelName field to given value.

GetClientId

func (o *ProxyProvider) GetClientId() string

GetClientId returns the ClientId field if non-nil, zero value otherwise.

GetClientIdOk

func (o *ProxyProvider) GetClientIdOk() (*string, bool)

GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetClientId

func (o *ProxyProvider) SetClientId(v string)

SetClientId sets ClientId field to given value.

GetInternalHost

func (o *ProxyProvider) GetInternalHost() string

GetInternalHost returns the InternalHost field if non-nil, zero value otherwise.

GetInternalHostOk

func (o *ProxyProvider) GetInternalHostOk() (*string, bool)

GetInternalHostOk returns a tuple with the InternalHost field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetInternalHost

func (o *ProxyProvider) SetInternalHost(v string)

SetInternalHost sets InternalHost field to given value.

HasInternalHost

func (o *ProxyProvider) HasInternalHost() bool

HasInternalHost returns a boolean if a field has been set.

GetExternalHost

func (o *ProxyProvider) GetExternalHost() string

GetExternalHost returns the ExternalHost field if non-nil, zero value otherwise.

GetExternalHostOk

func (o *ProxyProvider) GetExternalHostOk() (*string, bool)

GetExternalHostOk returns a tuple with the ExternalHost field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetExternalHost

func (o *ProxyProvider) SetExternalHost(v string)

SetExternalHost sets ExternalHost field to given value.

GetInternalHostSslValidation

func (o *ProxyProvider) GetInternalHostSslValidation() bool

GetInternalHostSslValidation returns the InternalHostSslValidation field if non-nil, zero value otherwise.

GetInternalHostSslValidationOk

func (o *ProxyProvider) GetInternalHostSslValidationOk() (*bool, bool)

GetInternalHostSslValidationOk returns a tuple with the InternalHostSslValidation field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetInternalHostSslValidation

func (o *ProxyProvider) SetInternalHostSslValidation(v bool)

SetInternalHostSslValidation sets InternalHostSslValidation field to given value.

HasInternalHostSslValidation

func (o *ProxyProvider) HasInternalHostSslValidation() bool

HasInternalHostSslValidation returns a boolean if a field has been set.

GetCertificate

func (o *ProxyProvider) GetCertificate() string

GetCertificate returns the Certificate field if non-nil, zero value otherwise.

GetCertificateOk

func (o *ProxyProvider) GetCertificateOk() (*string, bool)

GetCertificateOk returns a tuple with the Certificate field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCertificate

func (o *ProxyProvider) SetCertificate(v string)

SetCertificate sets Certificate field to given value.

HasCertificate

func (o *ProxyProvider) HasCertificate() bool

HasCertificate returns a boolean if a field has been set.

SetCertificateNil

func (o *ProxyProvider) SetCertificateNil(b bool)

SetCertificateNil sets the value for Certificate to be an explicit nil

UnsetCertificate

func (o *ProxyProvider) UnsetCertificate()

UnsetCertificate ensures that no value is present for Certificate, not even an explicit nil

GetSkipPathRegex

func (o *ProxyProvider) GetSkipPathRegex() string

GetSkipPathRegex returns the SkipPathRegex field if non-nil, zero value otherwise.

GetSkipPathRegexOk

func (o *ProxyProvider) GetSkipPathRegexOk() (*string, bool)

GetSkipPathRegexOk returns a tuple with the SkipPathRegex field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSkipPathRegex

func (o *ProxyProvider) SetSkipPathRegex(v string)

SetSkipPathRegex sets SkipPathRegex field to given value.

HasSkipPathRegex

func (o *ProxyProvider) HasSkipPathRegex() bool

HasSkipPathRegex returns a boolean if a field has been set.

GetBasicAuthEnabled

func (o *ProxyProvider) GetBasicAuthEnabled() bool

GetBasicAuthEnabled returns the BasicAuthEnabled field if non-nil, zero value otherwise.

GetBasicAuthEnabledOk

func (o *ProxyProvider) GetBasicAuthEnabledOk() (*bool, bool)

GetBasicAuthEnabledOk returns a tuple with the BasicAuthEnabled field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetBasicAuthEnabled

func (o *ProxyProvider) SetBasicAuthEnabled(v bool)

SetBasicAuthEnabled sets BasicAuthEnabled field to given value.

HasBasicAuthEnabled

func (o *ProxyProvider) HasBasicAuthEnabled() bool

HasBasicAuthEnabled returns a boolean if a field has been set.

GetBasicAuthPasswordAttribute

func (o *ProxyProvider) GetBasicAuthPasswordAttribute() string

GetBasicAuthPasswordAttribute returns the BasicAuthPasswordAttribute field if non-nil, zero value otherwise.

GetBasicAuthPasswordAttributeOk

func (o *ProxyProvider) GetBasicAuthPasswordAttributeOk() (*string, bool)

GetBasicAuthPasswordAttributeOk returns a tuple with the BasicAuthPasswordAttribute field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetBasicAuthPasswordAttribute

func (o *ProxyProvider) SetBasicAuthPasswordAttribute(v string)

SetBasicAuthPasswordAttribute sets BasicAuthPasswordAttribute field to given value.

HasBasicAuthPasswordAttribute

func (o *ProxyProvider) HasBasicAuthPasswordAttribute() bool

HasBasicAuthPasswordAttribute returns a boolean if a field has been set.

GetBasicAuthUserAttribute

func (o *ProxyProvider) GetBasicAuthUserAttribute() string

GetBasicAuthUserAttribute returns the BasicAuthUserAttribute field if non-nil, zero value otherwise.

GetBasicAuthUserAttributeOk

func (o *ProxyProvider) GetBasicAuthUserAttributeOk() (*string, bool)

GetBasicAuthUserAttributeOk returns a tuple with the BasicAuthUserAttribute field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetBasicAuthUserAttribute

func (o *ProxyProvider) SetBasicAuthUserAttribute(v string)

SetBasicAuthUserAttribute sets BasicAuthUserAttribute field to given value.

HasBasicAuthUserAttribute

func (o *ProxyProvider) HasBasicAuthUserAttribute() bool

HasBasicAuthUserAttribute returns a boolean if a field has been set.

GetMode

func (o *ProxyProvider) GetMode() ProxyMode

GetMode returns the Mode field if non-nil, zero value otherwise.

GetModeOk

func (o *ProxyProvider) GetModeOk() (*ProxyMode, bool)

GetModeOk returns a tuple with the Mode field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMode

func (o *ProxyProvider) SetMode(v ProxyMode)

SetMode sets Mode field to given value.

HasMode

func (o *ProxyProvider) HasMode() bool

HasMode returns a boolean if a field has been set.

GetInterceptHeaderAuth

func (o *ProxyProvider) GetInterceptHeaderAuth() bool

GetInterceptHeaderAuth returns the InterceptHeaderAuth field if non-nil, zero value otherwise.

GetInterceptHeaderAuthOk

func (o *ProxyProvider) GetInterceptHeaderAuthOk() (*bool, bool)

GetInterceptHeaderAuthOk returns a tuple with the InterceptHeaderAuth field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetInterceptHeaderAuth

func (o *ProxyProvider) SetInterceptHeaderAuth(v bool)

SetInterceptHeaderAuth sets InterceptHeaderAuth field to given value.

HasInterceptHeaderAuth

func (o *ProxyProvider) HasInterceptHeaderAuth() bool

HasInterceptHeaderAuth returns a boolean if a field has been set.

GetRedirectUris

func (o *ProxyProvider) GetRedirectUris() string

GetRedirectUris returns the RedirectUris field if non-nil, zero value otherwise.

GetRedirectUrisOk

func (o *ProxyProvider) GetRedirectUrisOk() (*string, bool)

GetRedirectUrisOk returns a tuple with the RedirectUris field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRedirectUris

func (o *ProxyProvider) SetRedirectUris(v string)

SetRedirectUris sets RedirectUris field to given value.

GetCookieDomain

func (o *ProxyProvider) GetCookieDomain() string

GetCookieDomain returns the CookieDomain field if non-nil, zero value otherwise.

GetCookieDomainOk

func (o *ProxyProvider) GetCookieDomainOk() (*string, bool)

GetCookieDomainOk returns a tuple with the CookieDomain field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCookieDomain

func (o *ProxyProvider) SetCookieDomain(v string)

SetCookieDomain sets CookieDomain field to given value.

HasCookieDomain

func (o *ProxyProvider) HasCookieDomain() bool

HasCookieDomain returns a boolean if a field has been set.

GetJwksSources

func (o *ProxyProvider) GetJwksSources() []string

GetJwksSources returns the JwksSources field if non-nil, zero value otherwise.

GetJwksSourcesOk

func (o *ProxyProvider) GetJwksSourcesOk() (*[]string, bool)

GetJwksSourcesOk returns a tuple with the JwksSources field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetJwksSources

func (o *ProxyProvider) SetJwksSources(v []string)

SetJwksSources sets JwksSources field to given value.

HasJwksSources

func (o *ProxyProvider) HasJwksSources() bool

HasJwksSources returns a boolean if a field has been set.

GetAccessTokenValidity

func (o *ProxyProvider) GetAccessTokenValidity() string

GetAccessTokenValidity returns the AccessTokenValidity field if non-nil, zero value otherwise.

GetAccessTokenValidityOk

func (o *ProxyProvider) GetAccessTokenValidityOk() (*string, bool)

GetAccessTokenValidityOk returns a tuple with the AccessTokenValidity field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAccessTokenValidity

func (o *ProxyProvider) SetAccessTokenValidity(v string)

SetAccessTokenValidity sets AccessTokenValidity field to given value.

HasAccessTokenValidity

func (o *ProxyProvider) HasAccessTokenValidity() bool

HasAccessTokenValidity returns a boolean if a field has been set.

GetRefreshTokenValidity

func (o *ProxyProvider) GetRefreshTokenValidity() string

GetRefreshTokenValidity returns the RefreshTokenValidity field if non-nil, zero value otherwise.

GetRefreshTokenValidityOk

func (o *ProxyProvider) GetRefreshTokenValidityOk() (*string, bool)

GetRefreshTokenValidityOk returns a tuple with the RefreshTokenValidity field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRefreshTokenValidity

func (o *ProxyProvider) SetRefreshTokenValidity(v string)

SetRefreshTokenValidity sets RefreshTokenValidity field to given value.

HasRefreshTokenValidity

func (o *ProxyProvider) HasRefreshTokenValidity() bool

HasRefreshTokenValidity returns a boolean if a field has been set.

GetOutpostSet

func (o *ProxyProvider) GetOutpostSet() []string

GetOutpostSet returns the OutpostSet field if non-nil, zero value otherwise.

GetOutpostSetOk

func (o *ProxyProvider) GetOutpostSetOk() (*[]string, bool)

GetOutpostSetOk returns a tuple with the OutpostSet field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetOutpostSet

func (o *ProxyProvider) SetOutpostSet(v []string)

SetOutpostSet sets OutpostSet field to given value.

[Back to Model list] [Back to API list] [Back to README]