Documentation
¶
Overview ¶
+k8s:deepcopy-gen=package +groupName=auth.platform.arangodb.com
Index ¶
- Constants
- func OpenIDDefaultDisabledPaths() []string
- type ConfigurationProviderEndpoints
- type OpenID
- func (in *OpenID) DeepCopy() *OpenID
- func (in *OpenID) DeepCopyInto(out *OpenID)
- func (c *OpenID) GetDisabledPaths() []string
- func (c *OpenID) GetEndpoint(ctx context.Context) (oauth2.Endpoint, error)
- func (c *OpenID) GetIDTokenVerifier(ctx context.Context) (*oidc.IDTokenVerifier, error)
- func (c *OpenID) GetOAuth2Config(ctx context.Context) (oauth2.Config, error)
- func (c *OpenID) IsDisabledPath(path string) bool
- type OpenIDClaims
- type OpenIDClient
- type OpenIDFeatures
- type OpenIDHTTPClient
- type OpenIDProvider
Constants ¶
const ( OpenIDJWTRedirect = "X-ArangoDB-OpenID-Redirect" OpenIDJWTSessionID = "X-ArangoDB-OpenID-Session-ID" OpenIDRedirectURL = "/oauth2/idpresponse" )
Variables ¶
This section is empty.
Functions ¶
func OpenIDDefaultDisabledPaths ¶
func OpenIDDefaultDisabledPaths() []string
Types ¶
type ConfigurationProviderEndpoints ¶
type ConfigurationProviderEndpoints struct {
// AuthorizationEndpoint defines OpenID Authorization Endpoint
// +doc/link: Documentation|https://www.ibm.com/docs/en/was-liberty/base?topic=connect-openid-endpoint-urls#rwlp_oidc_endpoint_urls__auth_endpoint__title__1
AuthorizationEndpoint *string `json:"authorizationEndpoint,omitempty"`
// TokenEndpoint defines OpenID Token Endpoint
// +doc/link: Documentation|https://www.ibm.com/docs/en/was-liberty/base?topic=connect-openid-endpoint-urls#rwlp_oidc_endpoint_urls__token_endpoint__title__1
TokenEndpoint *string `json:"tokenEndpoint,omitempty"`
// UserInfoEndpoint defines OpenID UserInfo Endpoint
// +doc/link: Documentation|https://www.ibm.com/docs/en/was-liberty/base?topic=connect-openid-endpoint-urls#rwlp_oidc_endpoint_urls__userinfo_endpoint__title__1
UserInfoEndpoint *string `json:"userInfoEndpoint,omitempty"`
}
func (*ConfigurationProviderEndpoints) DeepCopy ¶
func (in *ConfigurationProviderEndpoints) DeepCopy() *ConfigurationProviderEndpoints
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConfigurationProviderEndpoints.
func (*ConfigurationProviderEndpoints) DeepCopyInto ¶
func (in *ConfigurationProviderEndpoints) DeepCopyInto(out *ConfigurationProviderEndpoints)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type OpenID ¶
type OpenID struct {
// HTTP defines the HTTP Client Configuration
HTTP OpenIDHTTPClient `json:"http,omitempty"`
// Provider defines the OpenID Provider configuration
Provider OpenIDProvider `json:"provider,omitempty"`
// Client defines the OpenID Client configuration
Client OpenIDClient `json:"client,omitempty"`
// Endpoint defines the OpenID callback Endpoint
Endpoint string `json:"endpoint,omitempty"`
// Scope defines OpenID Scopes (OpenID is added by default).
Scope []string `json:"scope,omitempty"`
// DisabledPaths keeps the list of SSO disabled paths. By default, "_logout" endpoint is passed through
DisabledPaths []string `json:"disabledPaths,omitempty"`
// Features keeps the information about OpenID Features
Features *OpenIDFeatures `json:"features,omitempty"`
// Claims keeps the information about OpenID Claims Spec
Claims *OpenIDClaims `json:"claims,omitempty"`
}
func (*OpenID) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OpenID.
func (*OpenID) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*OpenID) GetDisabledPaths ¶
func (*OpenID) GetEndpoint ¶
func (*OpenID) GetIDTokenVerifier ¶
func (*OpenID) GetOAuth2Config ¶
func (*OpenID) IsDisabledPath ¶
type OpenIDClaims ¶
type OpenIDClaims struct {
// Username defines the claim key to extract username
// +doc/default: username
Username *string `json:"username,omitempty"`
}
func (*OpenIDClaims) DeepCopy ¶
func (in *OpenIDClaims) DeepCopy() *OpenIDClaims
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OpenIDClaims.
func (*OpenIDClaims) DeepCopyInto ¶
func (in *OpenIDClaims) DeepCopyInto(out *OpenIDClaims)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*OpenIDClaims) GetUsernameClaim ¶
func (o *OpenIDClaims) GetUsernameClaim() string
type OpenIDClient ¶
type OpenIDClient struct {
// ID defines OpenID Client ID
ID string `json:"id,omitempty"`
// Secret defines OpenID Client Secret
Secret string `json:"secret,omitempty"`
}
func (*OpenIDClient) DeepCopy ¶
func (in *OpenIDClient) DeepCopy() *OpenIDClient
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OpenIDClient.
func (*OpenIDClient) DeepCopyInto ¶
func (in *OpenIDClient) DeepCopyInto(out *OpenIDClient)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type OpenIDFeatures ¶
type OpenIDFeatures struct {
// RefreshEnabled defines if the Refresh OpenID Functionality is enabled
// +doc/default: false
// +doc/grade: Alpha
// +doc/grade: Experimental Feature, in development
RefreshEnabled *bool `json:"refreshEnabled,omitempty"`
}
func (*OpenIDFeatures) DeepCopy ¶
func (in *OpenIDFeatures) DeepCopy() *OpenIDFeatures
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OpenIDFeatures.
func (*OpenIDFeatures) DeepCopyInto ¶
func (in *OpenIDFeatures) DeepCopyInto(out *OpenIDFeatures)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*OpenIDFeatures) GetRefreshEnabled ¶
func (o *OpenIDFeatures) GetRefreshEnabled() bool
type OpenIDHTTPClient ¶
type OpenIDHTTPClient struct {
// Insecure defines if insecure HTTP Client is used
// +doc/default: false
Insecure *bool `json:"insecure,omitempty"`
}
func (*OpenIDHTTPClient) DeepCopy ¶
func (in *OpenIDHTTPClient) DeepCopy() *OpenIDHTTPClient
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OpenIDHTTPClient.
func (*OpenIDHTTPClient) DeepCopyInto ¶
func (in *OpenIDHTTPClient) DeepCopyInto(out *OpenIDHTTPClient)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type OpenIDProvider ¶
type OpenIDProvider struct {
*ConfigurationProviderEndpoints `json:",omitempty,inline"`
// Issuer defines OpenID Issuer
Issuer *string `json:"issuer,omitempty"`
}
func (*OpenIDProvider) DeepCopy ¶
func (in *OpenIDProvider) DeepCopy() *OpenIDProvider
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OpenIDProvider.
func (*OpenIDProvider) DeepCopyInto ¶
func (in *OpenIDProvider) DeepCopyInto(out *OpenIDProvider)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Source Files