oauth

Documentation

Index

• Constants
• func AddToContainer(c *restful.Container, im im.IdentityManagementInterface, ...) error
• type LoginRequest
• type Spec
• type Status
• type TokenReview
  • func (request *TokenReview) Validate() error

Constants

const (
	KindTokenReview = "TokenReview"
)

Functions

func AddToContainer

func AddToContainer(c *restful.Container, im im.IdentityManagementInterface,
	tokenOperator auth.TokenManagementInterface,
	passwordAuthenticator auth.PasswordAuthenticator,
	oauth2Authenticator auth.OAuthAuthenticator,
	loginRecorder auth.LoginRecorder,
	options *authoptions.AuthenticationOptions) error

ks-apiserver includes a built-in OAuth server. Users obtain OAuth access tokens to authenticate themselves to the API. The OAuth server supports standard authorization code grant and the implicit grant OAuth authorization flows. All requests for OAuth tokens involve a request to <ks-apiserver>/oauth/authorize. Most authentication integrations place an authenticating proxy in front of this endpoint, or configure ks-apiserver to validate credentials against a backing identity provider. Requests to <ks-apiserver>/oauth/authorize can come from user-agents that cannot display interactive login pages, such as the CLI.

Types

type LoginRequest

type LoginRequest struct {
	Username string `json:"username" description:"username"`
	Password string `json:"password" description:"password"`
}

type Spec

type Spec struct {
	Token string `json:"token" description:"access token"`
}

type Status

type Status struct {
	Authenticated bool                   `json:"authenticated" description:"is authenticated"`
	User          map[string]interface{} `json:"user,omitempty" description:"user info"`
}

type TokenReview

type TokenReview struct {
	APIVersion string  `json:"apiVersion" description:"Kubernetes API version"`
	Kind       string  `json:"kind" description:"kind of the API object"`
	Spec       *Spec   `json:"spec,omitempty"`
	Status     *Status `json:"status,omitempty" description:"token review status"`
}

func (*TokenReview) Validate

func (request *TokenReview) Validate() error