api

Documentation

Index

• type OAuthAccessToken
  • func (*OAuthAccessToken) IsAnAPIObject()
• type OAuthAccessTokenList
  • func (*OAuthAccessTokenList) IsAnAPIObject()
• type OAuthAuthorizeToken
  • func (*OAuthAuthorizeToken) IsAnAPIObject()
• type OAuthAuthorizeTokenList
  • func (*OAuthAuthorizeTokenList) IsAnAPIObject()
• type OAuthClient
  • func (*OAuthClient) IsAnAPIObject()
• type OAuthClientAuthorization
  • func (*OAuthClientAuthorization) IsAnAPIObject()
• type OAuthClientAuthorizationList
  • func (*OAuthClientAuthorizationList) IsAnAPIObject()
• type OAuthClientList
  • func (*OAuthClientList) IsAnAPIObject()

Types

type OAuthAccessToken

type OAuthAccessToken struct {
	kapi.TypeMeta   `json:",inline"`
	kapi.ObjectMeta `json:"metadata,omitempty"`

	// ClientName references the client that created this token.
	ClientName string `json:"clientName,omitempty"`

	// ExpiresIn is the seconds from CreationTime before this token expires.
	ExpiresIn int64 `json:"expiresIn,omitempty"`

	// Scopes is an array of the requested scopes.
	Scopes []string `json:"scopes,omitempty"`

	// RedirectURI is the redirection associated with the token.
	RedirectURI string `json:"redirectURI,omitempty"`

	// UserName is the user name associated with this token
	UserName string `json:"userName,omitempty"`

	// UserUID is the unique UID associated with this token
	UserUID string `json:"userUID,omitempty"`

	// AuthorizeToken contains the token that authorized this token
	AuthorizeToken string `json:"authorizeToken,omitempty"`

	// RefreshToken is the value by which this token can be renewed. Can be blank.
	RefreshToken string `json:"refreshToken,omitempty"`
}

func (*OAuthAccessToken) IsAnAPIObject

func (*OAuthAccessToken) IsAnAPIObject()

type OAuthAccessTokenList

type OAuthAccessTokenList struct {
	kapi.TypeMeta `json:",inline"`
	kapi.ListMeta `json:"metadata,omitempty"`
	Items         []OAuthAccessToken `json:"items"`
}

func (*OAuthAccessTokenList) IsAnAPIObject

func (*OAuthAccessTokenList) IsAnAPIObject()

type OAuthAuthorizeToken

type OAuthAuthorizeToken struct {
	kapi.TypeMeta   `json:",inline"`
	kapi.ObjectMeta `json:"metadata,omitempty"`

	// ClientName references the client that created this token.
	ClientName string `json:"clientName,omitempty"`

	// ExpiresIn is the seconds from CreationTime before this token expires.
	ExpiresIn int64 `json:"expiresIn,omitempty"`

	// Scopes is an array of the requested scopes.
	Scopes []string `json:"scopes,omitempty"`

	// RedirectURI is the redirection associated with the token.
	RedirectURI string `json:"redirectURI,omitempty"`

	// State data from request
	State string `json:"state,omitempty"`

	// UserName is the user name associated with this token
	UserName string `json:"userName,omitempty"`

	// UserUID is the unique UID associated with this token. UserUID and UserName must both match
	// for this token to be valid.
	UserUID string `json:"userUID,omitempty"`
}

func (*OAuthAuthorizeToken) IsAnAPIObject

func (*OAuthAuthorizeToken) IsAnAPIObject()

type OAuthAuthorizeTokenList

type OAuthAuthorizeTokenList struct {
	kapi.TypeMeta `json:",inline"`
	kapi.ListMeta `json:"metadata,omitempty"`
	Items         []OAuthAuthorizeToken `json:"items,"`
}

func (*OAuthAuthorizeTokenList) IsAnAPIObject

func (*OAuthAuthorizeTokenList) IsAnAPIObject()

type OAuthClient

type OAuthClient struct {
	kapi.TypeMeta   `json:",inline"`
	kapi.ObjectMeta `json:"metadata,omitempty"`

	// Secret is the unique secret associated with a client
	Secret string `json:"secret,omitempty"`

	// RespondWithChallenges indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects
	RespondWithChallenges bool `json:"respondWithChallenges,omitempty"`

	// RedirectURIs is the valid redirection URIs associated with a client
	RedirectURIs []string `json:"redirectURIs,omitempty"`
}

func (*OAuthClient) IsAnAPIObject

func (*OAuthClient) IsAnAPIObject()

type OAuthClientAuthorization

type OAuthClientAuthorization struct {
	kapi.TypeMeta   `json:",inline"`
	kapi.ObjectMeta `json:"metadata,omitempty"`

	// ClientName references the client that created this authorization
	ClientName string `json:"clientName,omitempty"`

	// UserName is the user name that authorized this client
	UserName string `json:"userName,omitempty"`

	// UserUID is the unique UID associated with this authorization. UserUID and UserName
	// must both match for this authorization to be valid.
	UserUID string `json:"userUID,omitempty"`

	// Scopes is an array of the granted scopes.
	Scopes []string `json:"scopes,omitempty"`
}

func (*OAuthClientAuthorization) IsAnAPIObject

func (*OAuthClientAuthorization) IsAnAPIObject()

type OAuthClientAuthorizationList

type OAuthClientAuthorizationList struct {
	kapi.TypeMeta `json:",inline"`
	kapi.ListMeta `json:"metadata,omitempty"`
	Items         []OAuthClientAuthorization `json:"items"`
}

func (*OAuthClientAuthorizationList) IsAnAPIObject

func (*OAuthClientAuthorizationList) IsAnAPIObject()

type OAuthClientList

type OAuthClientList struct {
	kapi.TypeMeta `json:",inline"`
	kapi.ListMeta `json:"metadata,omitempty"`
	Items         []OAuthClient `json:"items"`
}

func (*OAuthClientList) IsAnAPIObject

func (*OAuthClientList) IsAnAPIObject()