 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Overview ¶
Package api is the internal version of the API.
Index ¶
- Constants
- Variables
- func DeepCopy_api_ClusterRoleScopeRestriction(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_api_OAuthAccessToken(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_api_OAuthAccessTokenList(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_api_OAuthAuthorizeToken(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_api_OAuthAuthorizeTokenList(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_api_OAuthClient(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_api_OAuthClientAuthorization(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_api_OAuthClientAuthorizationList(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_api_OAuthClientList(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_api_OAuthRedirectReference(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_api_RedirectReference(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_api_ScopeRestriction(in interface{}, out interface{}, c *conversion.Cloner) error
- func Kind(kind string) unversioned.GroupKind
- func OAuthAccessTokenToSelectableFields(obj *OAuthAccessToken) fields.Set
- func OAuthAuthorizeTokenToSelectableFields(obj *OAuthAuthorizeToken) fields.Set
- func OAuthClientAuthorizationToSelectableFields(obj *OAuthClientAuthorization) fields.Set
- func OAuthClientToSelectableFields(obj *OAuthClient) fields.Set
- func RegisterDeepCopies(scheme *runtime.Scheme) error
- func Resource(resource string) unversioned.GroupResource
- type ClusterRoleScopeRestriction
- type GrantHandlerType
- type OAuthAccessToken
- type OAuthAccessTokenList
- type OAuthAuthorizeToken
- type OAuthAuthorizeTokenList
- type OAuthClient
- type OAuthClientAuthorization
- type OAuthClientAuthorizationList
- type OAuthClientList
- type OAuthRedirectReference
- type RedirectReference
- type ScopeRestriction
Constants ¶
const FutureGroupName = "oauth.openshift.io"
    const GroupName = ""
    Variables ¶
var ( SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}
    SchemeGroupVersion is group version used to register these objects
Functions ¶
func DeepCopy_api_ClusterRoleScopeRestriction ¶ added in v1.3.0
func DeepCopy_api_ClusterRoleScopeRestriction(in interface{}, out interface{}, c *conversion.Cloner) error
    func DeepCopy_api_OAuthAccessToken ¶ added in v1.3.0
func DeepCopy_api_OAuthAccessToken(in interface{}, out interface{}, c *conversion.Cloner) error
    func DeepCopy_api_OAuthAccessTokenList ¶ added in v1.3.0
func DeepCopy_api_OAuthAccessTokenList(in interface{}, out interface{}, c *conversion.Cloner) error
    func DeepCopy_api_OAuthAuthorizeToken ¶ added in v1.3.0
func DeepCopy_api_OAuthAuthorizeToken(in interface{}, out interface{}, c *conversion.Cloner) error
    func DeepCopy_api_OAuthAuthorizeTokenList ¶ added in v1.3.0
func DeepCopy_api_OAuthAuthorizeTokenList(in interface{}, out interface{}, c *conversion.Cloner) error
    func DeepCopy_api_OAuthClient ¶ added in v1.3.0
func DeepCopy_api_OAuthClient(in interface{}, out interface{}, c *conversion.Cloner) error
    func DeepCopy_api_OAuthClientAuthorization ¶ added in v1.3.0
func DeepCopy_api_OAuthClientAuthorization(in interface{}, out interface{}, c *conversion.Cloner) error
    func DeepCopy_api_OAuthClientAuthorizationList ¶ added in v1.3.0
func DeepCopy_api_OAuthClientAuthorizationList(in interface{}, out interface{}, c *conversion.Cloner) error
    func DeepCopy_api_OAuthClientList ¶ added in v1.3.0
func DeepCopy_api_OAuthClientList(in interface{}, out interface{}, c *conversion.Cloner) error
    func DeepCopy_api_OAuthRedirectReference ¶ added in v1.4.0
func DeepCopy_api_OAuthRedirectReference(in interface{}, out interface{}, c *conversion.Cloner) error
    func DeepCopy_api_RedirectReference ¶ added in v1.4.0
func DeepCopy_api_RedirectReference(in interface{}, out interface{}, c *conversion.Cloner) error
    func DeepCopy_api_ScopeRestriction ¶ added in v1.3.0
func DeepCopy_api_ScopeRestriction(in interface{}, out interface{}, c *conversion.Cloner) error
    func Kind ¶ added in v1.1.2
func Kind(kind string) unversioned.GroupKind
Kind takes an unqualified kind and returns back a Group qualified GroupKind
func OAuthAccessTokenToSelectableFields ¶ added in v1.0.8
func OAuthAccessTokenToSelectableFields(obj *OAuthAccessToken) fields.Set
OAuthAccessTokenToSelectableFields returns a label set that represents the object
func OAuthAuthorizeTokenToSelectableFields ¶ added in v1.0.8
func OAuthAuthorizeTokenToSelectableFields(obj *OAuthAuthorizeToken) fields.Set
OAuthAuthorizeTokenToSelectableFields returns a label set that represents the object
func OAuthClientAuthorizationToSelectableFields ¶ added in v1.0.8
func OAuthClientAuthorizationToSelectableFields(obj *OAuthClientAuthorization) fields.Set
OAuthClientAuthorizationToSelectableFields returns a label set that represents the object
func OAuthClientToSelectableFields ¶ added in v1.0.8
func OAuthClientToSelectableFields(obj *OAuthClient) fields.Set
OAuthClientToSelectableFields returns a label set that represents the object
func RegisterDeepCopies ¶ added in v1.4.0
RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.
func Resource ¶ added in v1.1.2
func Resource(resource string) unversioned.GroupResource
Resource takes an unqualified resource and returns back a Group qualified GroupResource
Types ¶
type ClusterRoleScopeRestriction ¶ added in v1.3.0
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
type GrantHandlerType ¶ added in v1.3.0
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 {
	unversioned.TypeMeta
	kapi.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
}
    func (*OAuthAccessToken) GetObjectKind ¶ added in v1.1.3
func (obj *OAuthAccessToken) GetObjectKind() unversioned.ObjectKind
type OAuthAccessTokenList ¶
type OAuthAccessTokenList struct {
	unversioned.TypeMeta
	unversioned.ListMeta
	Items []OAuthAccessToken
}
    func (*OAuthAccessTokenList) GetObjectKind ¶ added in v1.1.3
func (obj *OAuthAccessTokenList) GetObjectKind() unversioned.ObjectKind
type OAuthAuthorizeToken ¶
type OAuthAuthorizeToken struct {
	unversioned.TypeMeta
	kapi.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) GetObjectKind ¶ added in v1.1.3
func (obj *OAuthAuthorizeToken) GetObjectKind() unversioned.ObjectKind
type OAuthAuthorizeTokenList ¶
type OAuthAuthorizeTokenList struct {
	unversioned.TypeMeta
	unversioned.ListMeta
	Items []OAuthAuthorizeToken
}
    func (*OAuthAuthorizeTokenList) GetObjectKind ¶ added in v1.1.3
func (obj *OAuthAuthorizeTokenList) GetObjectKind() unversioned.ObjectKind
type OAuthClient ¶
type OAuthClient struct {
	unversioned.TypeMeta
	kapi.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
}
    func (*OAuthClient) GetObjectKind ¶ added in v1.1.3
func (obj *OAuthClient) GetObjectKind() unversioned.ObjectKind
type OAuthClientAuthorization ¶
type OAuthClientAuthorization struct {
	unversioned.TypeMeta
	kapi.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) GetObjectKind ¶ added in v1.1.3
func (obj *OAuthClientAuthorization) GetObjectKind() unversioned.ObjectKind
type OAuthClientAuthorizationList ¶
type OAuthClientAuthorizationList struct {
	unversioned.TypeMeta
	unversioned.ListMeta
	Items []OAuthClientAuthorization
}
    func (*OAuthClientAuthorizationList) GetObjectKind ¶ added in v1.1.3
func (obj *OAuthClientAuthorizationList) GetObjectKind() unversioned.ObjectKind
type OAuthClientList ¶
type OAuthClientList struct {
	unversioned.TypeMeta
	unversioned.ListMeta
	Items []OAuthClient
}
    func (*OAuthClientList) GetObjectKind ¶ added in v1.1.3
func (obj *OAuthClientList) GetObjectKind() unversioned.ObjectKind
type OAuthRedirectReference ¶ added in v1.4.0
type OAuthRedirectReference struct {
	unversioned.TypeMeta
	kapi.ObjectMeta
	Reference RedirectReference
}
    func (*OAuthRedirectReference) GetObjectKind ¶ added in v1.4.0
func (obj *OAuthRedirectReference) GetObjectKind() unversioned.ObjectKind
type RedirectReference ¶ added in v1.4.0
type ScopeRestriction ¶ added in v1.3.0
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.
       Source Files
      ¶
      Source Files
      ¶
    
- doc.go
- fields.go
- register.go
- types.go
- zz_generated.deepcopy.go
       Directories
      ¶
      Directories
      ¶
    
    | Path | Synopsis | 
|---|---|
| Package v1 is the v1 version of the API. | 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. |