v1

Documentation

Overview

Package v1 contains API Schema definitions for the oidc.security v1 API group +kubebuilder:object:generate=true +groupName=oidc.security.ibm.com

Index

• Constants
• Variables
• type Client
  • func (in *Client) DeepCopy() *Client
  • func (in *Client) DeepCopyInto(out *Client)
  • func (in *Client) DeepCopyObject() runtime.Object
  • func (c *Client) IsCPClientCredentialsEnabled() bool
• type ClientList
  • func (in *ClientList) DeepCopy() *ClientList
  • func (in *ClientList) DeepCopyInto(out *ClientList)
  • func (in *ClientList) DeepCopyObject() runtime.Object
• type ClientSpec
  • func (in *ClientSpec) DeepCopy() *ClientSpec
  • func (in *ClientSpec) DeepCopyInto(out *ClientSpec)
• type ClientStatus
  • func (in *ClientStatus) DeepCopy() *ClientStatus
  • func (in *ClientStatus) DeepCopyInto(out *ClientStatus)
• type ConditionStatus
• type OidcLibertyClient
  • func (in *OidcLibertyClient) DeepCopy() *OidcLibertyClient
  • func (in *OidcLibertyClient) DeepCopyInto(out *OidcLibertyClient)

Constants

const (
	// ClientConditionReady indicates that a Client is ready for use.
	ClientConditionReady string = "Ready"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "oidc.security.ibm.com", Version: "v1"}

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

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

Types

type Client

type Client struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ClientSpec   `json:"spec,omitempty"`
	Status ClientStatus `json:"status,omitempty"`
}

Client is the Schema for the clients API

func (*Client) DeepCopy

func (in *Client) DeepCopy() *Client

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

func (*Client) DeepCopyInto

func (in *Client) DeepCopyInto(out *Client)

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

func (*Client) DeepCopyObject

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

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

func (*Client) IsCPClientCredentialsEnabled

func (c *Client) IsCPClientCredentialsEnabled() bool

IsCPClientCredentialsEnabled returns whether the fields required for a Client to be granted authentication tokens with a Client ID and Secret are set.

type ClientList

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

ClientList contains a list of Client

func (*ClientList) DeepCopy

func (in *ClientList) DeepCopy() *ClientList

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

func (*ClientList) DeepCopyInto

func (in *ClientList) DeepCopyInto(out *ClientList)

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

func (*ClientList) DeepCopyObject

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

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

type ClientSpec

type ClientSpec struct {
	OidcLibertyClient OidcLibertyClient `json:"oidcLibertyClient"`
	Secret            string            `json:"secret"`
	ClientId          string            `json:"clientId"`
	ZenAuditUrl       string            `json:"zenAuditUrl,omitempty"`
	ZenInstanceId     string            `json:"zenInstanceId,omitempty"`
	ZenProductNameUrl string            `json:"zenProductNameUrl,omitempty"`
	Roles             []string          `json:"roles,omitempty"`
}

ClientSpec defines the desired state of Client

func (*ClientSpec) DeepCopy

func (in *ClientSpec) DeepCopy() *ClientSpec

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

func (*ClientSpec) DeepCopyInto

func (in *ClientSpec) DeepCopyInto(out *ClientSpec)

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

type ClientStatus

type ClientStatus struct {
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	LastFailureTime *metav1.Time `json:"lastFailureTime,omitempty"`
}

ClientStatus defines the observed state of Client

func (*ClientStatus) DeepCopy

func (in *ClientStatus) DeepCopy() *ClientStatus

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

func (*ClientStatus) DeepCopyInto

func (in *ClientStatus) DeepCopyInto(out *ClientStatus)

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

type ConditionStatus

type ConditionStatus string

ConditionStatus represents a condition's status.

const (
	// ConditionTrue represents the fact that a given condition is true
	ConditionTrue ConditionStatus = "True"

	// ConditionFalse represents the fact that a given condition is false
	ConditionFalse ConditionStatus = "False"

	// ConditionUnknown represents the fact that a given condition is unknown
	ConditionUnknown ConditionStatus = "Unknown"
)

These are valid condition statuses. "ConditionTrue" means a resource is in the condition; "ConditionFalse" means a resource is not in the condition; "ConditionUnknown" means kubernetes can't decide if a resource is in the condition or not. In the future, we could add other intermediate conditions, e.g. ConditionDegraded.

type OidcLibertyClient

type OidcLibertyClient struct {
	RedirectUris []string `json:"redirect_uris"`
	TrustedUris  []string `json:"trusted_uri_prefixes"`
	LogoutUris   []string `json:"post_logout_redirect_uris"`
}

func (*OidcLibertyClient) DeepCopy

func (in *OidcLibertyClient) DeepCopy() *OidcLibertyClient

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

func (*OidcLibertyClient) DeepCopyInto

func (in *OidcLibertyClient) DeepCopyInto(out *OidcLibertyClient)

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