oauth

package
v3.10.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Aug 2, 2018 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

+groupName=oauth.openshift.io Package api is the internal version of the API.

Index

Constants

View Source 
const (
	GroupName       = "oauth.openshift.io"
	LegacyGroupName = ""
)

Variables

View Source 
var (
	SchemeGroupVersion       = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}
	LegacySchemeGroupVersion = schema.GroupVersion{Group: LegacyGroupName, Version: runtime.APIVersionInternal}

	LegacySchemeBuilder    = runtime.NewSchemeBuilder(addLegacyKnownTypes)
	AddToSchemeInCoreGroup = LegacySchemeBuilder.AddToScheme

	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)

SchemeGroupVersion is group version used to register these objects

Functions

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func OAuthAccessTokenFieldSelector 

func OAuthAccessTokenFieldSelector(obj runtime.Object, fieldSet fields.Set) error

func OAuthAuthorizeTokenFieldSelector 

func OAuthAuthorizeTokenFieldSelector(obj runtime.Object, fieldSet fields.Set) error

func OAuthClientAuthorizationFieldSelector 

func OAuthClientAuthorizationFieldSelector(obj runtime.Object, fieldSet fields.Set) error

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns back a Group qualified GroupResource

Types

type ClusterRoleScopeRestriction 

type ClusterRoleScopeRestriction struct {
	// RoleNames is the list of cluster roles that can referenced.  * means anything
	RoleNames []string
	// Namespaces is the list of namespaces that can be referenced.  * means any of them (including *)
	Namespaces []string
	// AllowEscalation indicates whether you can request roles and their escalating resources
	AllowEscalation bool
}

ClusterRoleScopeRestriction describes restrictions on cluster role scopes

func (*ClusterRoleScopeRestriction) DeepCopy 

func (in *ClusterRoleScopeRestriction) DeepCopy() *ClusterRoleScopeRestriction

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

func (*ClusterRoleScopeRestriction) DeepCopyInto 

func (in *ClusterRoleScopeRestriction) DeepCopyInto(out *ClusterRoleScopeRestriction)

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

type GrantHandlerType 

type GrantHandlerType string
const (
	// GrantHandlerAuto auto-approves client authorization grant requests
	GrantHandlerAuto GrantHandlerType = "auto"
	// GrantHandlerPrompt prompts the user to approve new client authorization grant requests
	GrantHandlerPrompt GrantHandlerType = "prompt"
	// GrantHandlerDeny auto-denies client authorization grant requests
	GrantHandlerDeny GrantHandlerType = "deny"
)

type OAuthAccessToken 

type OAuthAccessToken struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	// ClientName references the client that created this token.
	ClientName string

	// ExpiresIn is the seconds from CreationTime before this token expires.
	ExpiresIn int64

	// Scopes is an array of the requested scopes.
	Scopes []string

	// RedirectURI is the redirection associated with the token.
	RedirectURI string

	// UserName is the user name associated with this token
	UserName string

	// UserUID is the unique UID associated with this token
	UserUID string

	// AuthorizeToken contains the token that authorized this token
	AuthorizeToken string

	// RefreshToken is the value by which this token can be renewed. Can be blank.
	RefreshToken string

	// InactivityTimeoutSeconds is the value in seconds, from the
	// CreationTimestamp, after which this token can no longer be used.
	// The value is automatically incremented when the token is used.
	InactivityTimeoutSeconds int32
}

func (*OAuthAccessToken) DeepCopy 

func (in *OAuthAccessToken) DeepCopy() *OAuthAccessToken

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

func (*OAuthAccessToken) DeepCopyInto 

func (in *OAuthAccessToken) DeepCopyInto(out *OAuthAccessToken)

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

func (*OAuthAccessToken) DeepCopyObject 

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

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

type OAuthAccessTokenList 

type OAuthAccessTokenList struct {
	metav1.TypeMeta
	metav1.ListMeta
	Items []OAuthAccessToken
}

func (*OAuthAccessTokenList) DeepCopy 

func (in *OAuthAccessTokenList) DeepCopy() *OAuthAccessTokenList

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

func (*OAuthAccessTokenList) DeepCopyInto 

func (in *OAuthAccessTokenList) DeepCopyInto(out *OAuthAccessTokenList)

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

func (*OAuthAccessTokenList) DeepCopyObject 

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

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

type OAuthAuthorizeToken 

type OAuthAuthorizeToken struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	// ClientName references the client that created this token.
	ClientName string

	// ExpiresIn is the seconds from CreationTime before this token expires.
	ExpiresIn int64

	// Scopes is an array of the requested scopes.
	Scopes []string

	// RedirectURI is the redirection associated with the token.
	RedirectURI string

	// State data from request
	State string

	// UserName is the user name associated with this token
	UserName string

	// UserUID is the unique UID associated with this token. UserUID and UserName must both match
	// for this token to be valid.
	UserUID string

	// CodeChallenge is the optional code_challenge associated with this authorization code, as described in rfc7636
	CodeChallenge string

	// CodeChallengeMethod is the optional code_challenge_method associated with this authorization code, as described in rfc7636
	CodeChallengeMethod string
}

func (*OAuthAuthorizeToken) DeepCopy 

func (in *OAuthAuthorizeToken) DeepCopy() *OAuthAuthorizeToken

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

func (*OAuthAuthorizeToken) DeepCopyInto 

func (in *OAuthAuthorizeToken) DeepCopyInto(out *OAuthAuthorizeToken)

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

func (*OAuthAuthorizeToken) DeepCopyObject 

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

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

type OAuthAuthorizeTokenList 

type OAuthAuthorizeTokenList struct {
	metav1.TypeMeta
	metav1.ListMeta
	Items []OAuthAuthorizeToken
}

func (*OAuthAuthorizeTokenList) DeepCopy 

func (in *OAuthAuthorizeTokenList) DeepCopy() *OAuthAuthorizeTokenList

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

func (*OAuthAuthorizeTokenList) DeepCopyInto 

func (in *OAuthAuthorizeTokenList) DeepCopyInto(out *OAuthAuthorizeTokenList)

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

func (*OAuthAuthorizeTokenList) DeepCopyObject 

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

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

type OAuthClient 

type OAuthClient struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	// Secret is the unique secret associated with a client
	Secret string

	// AdditionalSecrets holds other secrets that may be used to identify the client.  This is useful for rotation
	// and for service account token validation
	AdditionalSecrets []string

	// RespondWithChallenges indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects
	RespondWithChallenges bool

	// RedirectURIs is the valid redirection URIs associated with a client
	RedirectURIs []string

	// GrantMethod determines how to handle grants for this client. If no method is provided, the
	// cluster default grant handling method will be used
	GrantMethod GrantHandlerType

	// ScopeRestrictions describes which scopes this client can request.  Each requested scope
	// is checked against each restriction.  If any restriction matches, then the scope is allowed.
	// If no restriction matches, then the scope is denied.
	ScopeRestrictions []ScopeRestriction

	// AccessTokenMaxAgeSeconds overrides the default access token max age for tokens granted to this client.
	// 0 means no expiration.
	AccessTokenMaxAgeSeconds *int32

	// AccessTokenInactivityTimeoutSeconds overrides the default token
	// inactivity timeout for tokens granted to this client.
	// The value represents the maximum amount of time that can occur between
	// consecutive uses of the token. Tokens become invalid if they are not
	// used within this temporal window. The user will need to acquire a new
	// token to regain access once a token times out.
	// This value needs to be set only if the default set in configuration is
	// not appropriate for this client. Valid values are:
	// - 0: Tokens for this client never time out
	// - X: Tokens time out if there is no activity for X seconds
	// The current minimum allowed value for X is 300 (5 minutes)
	AccessTokenInactivityTimeoutSeconds *int32
}

func (*OAuthClient) DeepCopy 

func (in *OAuthClient) DeepCopy() *OAuthClient

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

func (*OAuthClient) DeepCopyInto 

func (in *OAuthClient) DeepCopyInto(out *OAuthClient)

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

func (*OAuthClient) DeepCopyObject 

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

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

type OAuthClientAuthorization 

type OAuthClientAuthorization struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	// ClientName references the client that created this authorization
	ClientName string

	// UserName is the user name that authorized this client
	UserName string

	// UserUID is the unique UID associated with this authorization. UserUID and UserName
	// must both match for this authorization to be valid.
	UserUID string

	// Scopes is an array of the granted scopes.
	Scopes []string
}

func (*OAuthClientAuthorization) DeepCopy 

func (in *OAuthClientAuthorization) DeepCopy() *OAuthClientAuthorization

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

func (*OAuthClientAuthorization) DeepCopyInto 

func (in *OAuthClientAuthorization) DeepCopyInto(out *OAuthClientAuthorization)

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

func (*OAuthClientAuthorization) DeepCopyObject 

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

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

type OAuthClientAuthorizationList 

type OAuthClientAuthorizationList struct {
	metav1.TypeMeta
	metav1.ListMeta
	Items []OAuthClientAuthorization
}

func (*OAuthClientAuthorizationList) DeepCopy 

func (in *OAuthClientAuthorizationList) DeepCopy() *OAuthClientAuthorizationList

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

func (*OAuthClientAuthorizationList) DeepCopyInto 

func (in *OAuthClientAuthorizationList) DeepCopyInto(out *OAuthClientAuthorizationList)

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

func (*OAuthClientAuthorizationList) DeepCopyObject 

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

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

type OAuthClientList 

type OAuthClientList struct {
	metav1.TypeMeta
	metav1.ListMeta
	Items []OAuthClient
}

func (*OAuthClientList) DeepCopy 

func (in *OAuthClientList) DeepCopy() *OAuthClientList

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

func (*OAuthClientList) DeepCopyInto 

func (in *OAuthClientList) DeepCopyInto(out *OAuthClientList)

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

func (*OAuthClientList) DeepCopyObject 

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

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

type OAuthRedirectReference 

type OAuthRedirectReference struct {
	metav1.TypeMeta
	metav1.ObjectMeta
	Reference RedirectReference
}

func (*OAuthRedirectReference) DeepCopy 

func (in *OAuthRedirectReference) DeepCopy() *OAuthRedirectReference

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

func (*OAuthRedirectReference) DeepCopyInto 

func (in *OAuthRedirectReference) DeepCopyInto(out *OAuthRedirectReference)

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

func (*OAuthRedirectReference) DeepCopyObject 

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

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

type RedirectReference 

type RedirectReference struct {
	Group string
	Kind  string
	Name  string
}

func (*RedirectReference) DeepCopy 

func (in *RedirectReference) DeepCopy() *RedirectReference

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

func (*RedirectReference) DeepCopyInto 

func (in *RedirectReference) DeepCopyInto(out *RedirectReference)

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

type ScopeRestriction 

type ScopeRestriction struct {
	// ExactValues means the scope has to match a particular set of strings exactly
	ExactValues []string

	// ClusterRole describes a set of restrictions for cluster role scoping.
	ClusterRole *ClusterRoleScopeRestriction
}

ScopeRestriction describe one restriction on scopes. Exactly one option must be non-nil.

func (*ScopeRestriction) DeepCopy 

func (in *ScopeRestriction) DeepCopy() *ScopeRestriction

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

func (*ScopeRestriction) DeepCopyInto 

func (in *ScopeRestriction) DeepCopyInto(out *ScopeRestriction)

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

Source Files

View all Source files

Directories

Path Synopsis
+groupName=oauth.openshift.io Package v1 is the v1 version of the API.
 +groupName=oauth.openshift.io Package v1 is the v1 version of the API.
Package validation has functions for validating the correctness of api objects and explaining what is wrong with them when they aren't valid.
 Package validation has functions for validating the correctness of api objects and explaining what is wrong with them when they aren't valid.

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.