v1alpha1

package
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 15, 2024 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

+kubebuilder:object:generate=true +groupName=openidgroup.keycloak.crossplane.io +versionName=v1alpha1

Index

Constants

View Source 
const (
	CRDGroup   = "openidgroup.keycloak.crossplane.io"
	CRDVersion = "v1alpha1"
)

Package type metadata.

Variables

View Source 
var (
	GroupMembershipProtocolMapper_Kind             = "GroupMembershipProtocolMapper"
	GroupMembershipProtocolMapper_GroupKind        = schema.GroupKind{Group: CRDGroup, Kind: GroupMembershipProtocolMapper_Kind}.String()
	GroupMembershipProtocolMapper_KindAPIVersion   = GroupMembershipProtocolMapper_Kind + "." + CRDGroupVersion.String()
	GroupMembershipProtocolMapper_GroupVersionKind = CRDGroupVersion.WithKind(GroupMembershipProtocolMapper_Kind)
)

Repository type metadata.

View Source 
var (
	// CRDGroupVersion is the API Group Version used to register the objects
	CRDGroupVersion = schema.GroupVersion{Group: CRDGroup, Version: CRDVersion}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: CRDGroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type GroupMembershipProtocolMapper 

type GroupMembershipProtocolMapper struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.claimName) || (has(self.initProvider) && has(self.initProvider.claimName))",message="spec.forProvider.claimName is a required parameter"
	// +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.name) || (has(self.initProvider) && has(self.initProvider.name))",message="spec.forProvider.name is a required parameter"
	Spec   GroupMembershipProtocolMapperSpec   `json:"spec"`
	Status GroupMembershipProtocolMapperStatus `json:"status,omitempty"`
}

GroupMembershipProtocolMapper is the Schema for the GroupMembershipProtocolMappers API. +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,keycloak}

func (*GroupMembershipProtocolMapper) DeepCopy 

func (in *GroupMembershipProtocolMapper) DeepCopy() *GroupMembershipProtocolMapper

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupMembershipProtocolMapper.

func (*GroupMembershipProtocolMapper) DeepCopyInto 

func (in *GroupMembershipProtocolMapper) DeepCopyInto(out *GroupMembershipProtocolMapper)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*GroupMembershipProtocolMapper) DeepCopyObject 

func (in *GroupMembershipProtocolMapper) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*GroupMembershipProtocolMapper) GetCondition 

func (mg *GroupMembershipProtocolMapper) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this GroupMembershipProtocolMapper.

func (*GroupMembershipProtocolMapper) GetConnectionDetailsMapping 

func (tr *GroupMembershipProtocolMapper) GetConnectionDetailsMapping() map[string]string

GetConnectionDetailsMapping for this GroupMembershipProtocolMapper

func (*GroupMembershipProtocolMapper) GetDeletionPolicy 

func (mg *GroupMembershipProtocolMapper) GetDeletionPolicy() xpv1.DeletionPolicy

GetDeletionPolicy of this GroupMembershipProtocolMapper.

func (*GroupMembershipProtocolMapper) GetID 

func (tr *GroupMembershipProtocolMapper) GetID() string

GetID returns ID of underlying Terraform resource of this GroupMembershipProtocolMapper

func (*GroupMembershipProtocolMapper) GetInitParameters added in v0.5.0 

func (tr *GroupMembershipProtocolMapper) GetInitParameters() (map[string]any, error)

GetInitParameters of this GroupMembershipProtocolMapper

func (*GroupMembershipProtocolMapper) GetManagementPolicies 

func (mg *GroupMembershipProtocolMapper) GetManagementPolicies() xpv1.ManagementPolicies

GetManagementPolicies of this GroupMembershipProtocolMapper.

func (*GroupMembershipProtocolMapper) GetMergedParameters added in v0.6.0 

func (tr *GroupMembershipProtocolMapper) GetMergedParameters(shouldMergeInitProvider bool) (map[string]any, error)

GetInitParameters of this GroupMembershipProtocolMapper

func (*GroupMembershipProtocolMapper) GetObservation 

func (tr *GroupMembershipProtocolMapper) GetObservation() (map[string]any, error)

GetObservation of this GroupMembershipProtocolMapper

func (*GroupMembershipProtocolMapper) GetParameters 

func (tr *GroupMembershipProtocolMapper) GetParameters() (map[string]any, error)

GetParameters of this GroupMembershipProtocolMapper

func (*GroupMembershipProtocolMapper) GetProviderConfigReference 

func (mg *GroupMembershipProtocolMapper) GetProviderConfigReference() *xpv1.Reference

GetProviderConfigReference of this GroupMembershipProtocolMapper.

func (*GroupMembershipProtocolMapper) GetPublishConnectionDetailsTo 

func (mg *GroupMembershipProtocolMapper) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo

GetPublishConnectionDetailsTo of this GroupMembershipProtocolMapper.

func (*GroupMembershipProtocolMapper) GetTerraformResourceType 

func (mg *GroupMembershipProtocolMapper) GetTerraformResourceType() string

GetTerraformResourceType returns Terraform resource type for this GroupMembershipProtocolMapper

func (*GroupMembershipProtocolMapper) GetTerraformSchemaVersion 

func (tr *GroupMembershipProtocolMapper) GetTerraformSchemaVersion() int

GetTerraformSchemaVersion returns the associated Terraform schema version

func (*GroupMembershipProtocolMapper) GetWriteConnectionSecretToReference 

func (mg *GroupMembershipProtocolMapper) GetWriteConnectionSecretToReference() *xpv1.SecretReference

GetWriteConnectionSecretToReference of this GroupMembershipProtocolMapper.

func (*GroupMembershipProtocolMapper) LateInitialize 

func (tr *GroupMembershipProtocolMapper) LateInitialize(attrs []byte) (bool, error)

LateInitialize this GroupMembershipProtocolMapper using its observed tfState. returns True if there are any spec changes for the resource.

func (*GroupMembershipProtocolMapper) ResolveReferences 

func (mg *GroupMembershipProtocolMapper) ResolveReferences(ctx context.Context, c client.Reader) error

ResolveReferences of this GroupMembershipProtocolMapper.

func (*GroupMembershipProtocolMapper) SetConditions 

func (mg *GroupMembershipProtocolMapper) SetConditions(c ...xpv1.Condition)

SetConditions of this GroupMembershipProtocolMapper.

func (*GroupMembershipProtocolMapper) SetDeletionPolicy 

func (mg *GroupMembershipProtocolMapper) SetDeletionPolicy(r xpv1.DeletionPolicy)

SetDeletionPolicy of this GroupMembershipProtocolMapper.

func (*GroupMembershipProtocolMapper) SetManagementPolicies 

func (mg *GroupMembershipProtocolMapper) SetManagementPolicies(r xpv1.ManagementPolicies)

SetManagementPolicies of this GroupMembershipProtocolMapper.

func (*GroupMembershipProtocolMapper) SetObservation 

func (tr *GroupMembershipProtocolMapper) SetObservation(obs map[string]any) error

SetObservation for this GroupMembershipProtocolMapper

func (*GroupMembershipProtocolMapper) SetParameters 

func (tr *GroupMembershipProtocolMapper) SetParameters(params map[string]any) error

SetParameters for this GroupMembershipProtocolMapper

func (*GroupMembershipProtocolMapper) SetProviderConfigReference 

func (mg *GroupMembershipProtocolMapper) SetProviderConfigReference(r *xpv1.Reference)

SetProviderConfigReference of this GroupMembershipProtocolMapper.

func (*GroupMembershipProtocolMapper) SetPublishConnectionDetailsTo 

func (mg *GroupMembershipProtocolMapper) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)

SetPublishConnectionDetailsTo of this GroupMembershipProtocolMapper.

func (*GroupMembershipProtocolMapper) SetWriteConnectionSecretToReference 

func (mg *GroupMembershipProtocolMapper) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)

SetWriteConnectionSecretToReference of this GroupMembershipProtocolMapper.

type GroupMembershipProtocolMapperInitParameters added in v0.5.0 

type GroupMembershipProtocolMapperInitParameters struct {

	// Indicates if the property should be added as a claim to the access token. Defaults to true.
	AddToAccessToken *bool `json:"addToAccessToken,omitempty" tf:"add_to_access_token,omitempty"`

	// Indicates if the property should be added as a claim to the id token. Defaults to true.
	AddToIDToken *bool `json:"addToIdToken,omitempty" tf:"add_to_id_token,omitempty"`

	// Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true.
	AddToUserinfo *bool `json:"addToUserinfo,omitempty" tf:"add_to_userinfo,omitempty"`

	// The name of the claim to insert into a token.
	ClaimName *string `json:"claimName,omitempty" tf:"claim_name,omitempty"`

	// Indicates whether the full path of the group including its parents will be used. Defaults to true.
	FullPath *bool `json:"fullPath,omitempty" tf:"full_path,omitempty"`

	// The display name of this protocol mapper in the GUI.
	// A human-friendly name that will appear in the Keycloak console.
	Name *string `json:"name,omitempty" tf:"name,omitempty"`
}

func (*GroupMembershipProtocolMapperInitParameters) DeepCopy added in v0.5.0 

func (in *GroupMembershipProtocolMapperInitParameters) DeepCopy() *GroupMembershipProtocolMapperInitParameters

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupMembershipProtocolMapperInitParameters.

func (*GroupMembershipProtocolMapperInitParameters) DeepCopyInto added in v0.5.0 

func (in *GroupMembershipProtocolMapperInitParameters) DeepCopyInto(out *GroupMembershipProtocolMapperInitParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GroupMembershipProtocolMapperList 

type GroupMembershipProtocolMapperList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []GroupMembershipProtocolMapper `json:"items"`
}

GroupMembershipProtocolMapperList contains a list of GroupMembershipProtocolMappers

func (*GroupMembershipProtocolMapperList) DeepCopy 

func (in *GroupMembershipProtocolMapperList) DeepCopy() *GroupMembershipProtocolMapperList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupMembershipProtocolMapperList.

func (*GroupMembershipProtocolMapperList) DeepCopyInto 

func (in *GroupMembershipProtocolMapperList) DeepCopyInto(out *GroupMembershipProtocolMapperList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*GroupMembershipProtocolMapperList) DeepCopyObject 

func (in *GroupMembershipProtocolMapperList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*GroupMembershipProtocolMapperList) GetItems 

func (l *GroupMembershipProtocolMapperList) GetItems() []resource.Managed

GetItems of this GroupMembershipProtocolMapperList.

type GroupMembershipProtocolMapperObservation 

type GroupMembershipProtocolMapperObservation struct {

	// Indicates if the property should be added as a claim to the access token. Defaults to true.
	AddToAccessToken *bool `json:"addToAccessToken,omitempty" tf:"add_to_access_token,omitempty"`

	// Indicates if the property should be added as a claim to the id token. Defaults to true.
	AddToIDToken *bool `json:"addToIdToken,omitempty" tf:"add_to_id_token,omitempty"`

	// Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true.
	AddToUserinfo *bool `json:"addToUserinfo,omitempty" tf:"add_to_userinfo,omitempty"`

	// The name of the claim to insert into a token.
	ClaimName *string `json:"claimName,omitempty" tf:"claim_name,omitempty"`

	// The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
	// The mapper's associated client. Cannot be used at the same time as client_scope_id.
	ClientID *string `json:"clientId,omitempty" tf:"client_id,omitempty"`

	// The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified.
	// The mapper's associated client scope. Cannot be used at the same time as client_id.
	ClientScopeID *string `json:"clientScopeId,omitempty" tf:"client_scope_id,omitempty"`

	// Indicates whether the full path of the group including its parents will be used. Defaults to true.
	FullPath *bool `json:"fullPath,omitempty" tf:"full_path,omitempty"`

	ID *string `json:"id,omitempty" tf:"id,omitempty"`

	// The display name of this protocol mapper in the GUI.
	// A human-friendly name that will appear in the Keycloak console.
	Name *string `json:"name,omitempty" tf:"name,omitempty"`

	// The realm this protocol mapper exists within.
	// The realm id where the associated client or client scope exists.
	RealmID *string `json:"realmId,omitempty" tf:"realm_id,omitempty"`
}

func (*GroupMembershipProtocolMapperObservation) DeepCopy 

func (in *GroupMembershipProtocolMapperObservation) DeepCopy() *GroupMembershipProtocolMapperObservation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupMembershipProtocolMapperObservation.

func (*GroupMembershipProtocolMapperObservation) DeepCopyInto 

func (in *GroupMembershipProtocolMapperObservation) DeepCopyInto(out *GroupMembershipProtocolMapperObservation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GroupMembershipProtocolMapperParameters 

type GroupMembershipProtocolMapperParameters struct {

	// Indicates if the property should be added as a claim to the access token. Defaults to true.
	// +kubebuilder:validation:Optional
	AddToAccessToken *bool `json:"addToAccessToken,omitempty" tf:"add_to_access_token,omitempty"`

	// Indicates if the property should be added as a claim to the id token. Defaults to true.
	// +kubebuilder:validation:Optional
	AddToIDToken *bool `json:"addToIdToken,omitempty" tf:"add_to_id_token,omitempty"`

	// Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true.
	// +kubebuilder:validation:Optional
	AddToUserinfo *bool `json:"addToUserinfo,omitempty" tf:"add_to_userinfo,omitempty"`

	// The name of the claim to insert into a token.
	// +kubebuilder:validation:Optional
	ClaimName *string `json:"claimName,omitempty" tf:"claim_name,omitempty"`

	// The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
	// The mapper's associated client. Cannot be used at the same time as client_scope_id.
	// +crossplane:generate:reference:type=github.com/crossplane-contrib/provider-keycloak/apis/openidclient/v1alpha1.Client
	// +kubebuilder:validation:Optional
	ClientID *string `json:"clientId,omitempty" tf:"client_id,omitempty"`

	// Reference to a Client in openidclient to populate clientId.
	// +kubebuilder:validation:Optional
	ClientIDRef *v1.Reference `json:"clientIdRef,omitempty" tf:"-"`

	// Selector for a Client in openidclient to populate clientId.
	// +kubebuilder:validation:Optional
	ClientIDSelector *v1.Selector `json:"clientIdSelector,omitempty" tf:"-"`

	// The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified.
	// The mapper's associated client scope. Cannot be used at the same time as client_id.
	// +crossplane:generate:reference:type=github.com/crossplane-contrib/provider-keycloak/apis/openidclient/v1alpha1.ClientScope
	// +kubebuilder:validation:Optional
	ClientScopeID *string `json:"clientScopeId,omitempty" tf:"client_scope_id,omitempty"`

	// Reference to a ClientScope in openidclient to populate clientScopeId.
	// +kubebuilder:validation:Optional
	ClientScopeIDRef *v1.Reference `json:"clientScopeIdRef,omitempty" tf:"-"`

	// Selector for a ClientScope in openidclient to populate clientScopeId.
	// +kubebuilder:validation:Optional
	ClientScopeIDSelector *v1.Selector `json:"clientScopeIdSelector,omitempty" tf:"-"`

	// Indicates whether the full path of the group including its parents will be used. Defaults to true.
	// +kubebuilder:validation:Optional
	FullPath *bool `json:"fullPath,omitempty" tf:"full_path,omitempty"`

	// The display name of this protocol mapper in the GUI.
	// A human-friendly name that will appear in the Keycloak console.
	// +kubebuilder:validation:Optional
	Name *string `json:"name,omitempty" tf:"name,omitempty"`

	// The realm this protocol mapper exists within.
	// The realm id where the associated client or client scope exists.
	// +crossplane:generate:reference:type=github.com/crossplane-contrib/provider-keycloak/apis/realm/v1alpha1.Realm
	// +kubebuilder:validation:Optional
	RealmID *string `json:"realmId,omitempty" tf:"realm_id,omitempty"`

	// Reference to a Realm in realm to populate realmId.
	// +kubebuilder:validation:Optional
	RealmIDRef *v1.Reference `json:"realmIdRef,omitempty" tf:"-"`

	// Selector for a Realm in realm to populate realmId.
	// +kubebuilder:validation:Optional
	RealmIDSelector *v1.Selector `json:"realmIdSelector,omitempty" tf:"-"`
}

func (*GroupMembershipProtocolMapperParameters) DeepCopy 

func (in *GroupMembershipProtocolMapperParameters) DeepCopy() *GroupMembershipProtocolMapperParameters

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupMembershipProtocolMapperParameters.

func (*GroupMembershipProtocolMapperParameters) DeepCopyInto 

func (in *GroupMembershipProtocolMapperParameters) DeepCopyInto(out *GroupMembershipProtocolMapperParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GroupMembershipProtocolMapperSpec 

type GroupMembershipProtocolMapperSpec struct {
	v1.ResourceSpec `json:",inline"`
	ForProvider     GroupMembershipProtocolMapperParameters `json:"forProvider"`
	// THIS IS A BETA FIELD. It will be honored
	// unless the Management Policies feature flag is disabled.
	// InitProvider holds the same fields as ForProvider, with the exception
	// of Identifier and other resource reference fields. The fields that are
	// in InitProvider are merged into ForProvider when the resource is created.
	// The same fields are also added to the terraform ignore_changes hook, to
	// avoid updating them after creation. This is useful for fields that are
	// required on creation, but we do not desire to update them after creation,
	// for example because of an external controller is managing them, like an
	// autoscaler.
	InitProvider GroupMembershipProtocolMapperInitParameters `json:"initProvider,omitempty"`
}

GroupMembershipProtocolMapperSpec defines the desired state of GroupMembershipProtocolMapper

func (*GroupMembershipProtocolMapperSpec) DeepCopy 

func (in *GroupMembershipProtocolMapperSpec) DeepCopy() *GroupMembershipProtocolMapperSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupMembershipProtocolMapperSpec.

func (*GroupMembershipProtocolMapperSpec) DeepCopyInto 

func (in *GroupMembershipProtocolMapperSpec) DeepCopyInto(out *GroupMembershipProtocolMapperSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GroupMembershipProtocolMapperStatus 

type GroupMembershipProtocolMapperStatus struct {
	v1.ResourceStatus `json:",inline"`
	AtProvider        GroupMembershipProtocolMapperObservation `json:"atProvider,omitempty"`
}

GroupMembershipProtocolMapperStatus defines the observed state of GroupMembershipProtocolMapper.

func (*GroupMembershipProtocolMapperStatus) DeepCopy 

func (in *GroupMembershipProtocolMapperStatus) DeepCopy() *GroupMembershipProtocolMapperStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupMembershipProtocolMapperStatus.

func (*GroupMembershipProtocolMapperStatus) DeepCopyInto 

func (in *GroupMembershipProtocolMapperStatus) DeepCopyInto(out *GroupMembershipProtocolMapperStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.