hydra

Documentation

Index

• type CodeGenSDK
  • func NewSDK(c *Configuration) (*CodeGenSDK, error)
• type Configuration
• type JWKApi
• type OAuth2API
• type SDK

Types

type CodeGenSDK

type CodeGenSDK struct {
	*swagger.OAuth2Api
	*swagger.JsonWebKeyApi

	Configuration *Configuration
	// contains filtered or unexported fields
}

CodeGenSDK contains all relevant API clients for interacting with ORY Hydra.

func NewSDK

func NewSDK(c *Configuration) (*CodeGenSDK, error)

NewSDK instantiates a new CodeGenSDK instance or returns an error.

type Configuration

type Configuration struct {
	// AdminURL should point to the administrative URL of ORY Hydra, for example: http://localhost:4445
	AdminURL string

	// PublicURL should point to the public url of ORY Hydra, for example: http://localhost:4444
	PublicURL string

	// ClientID is the id of the management client. The management client should have appropriate access rights
	// and the ability to request the client_credentials grant.
	ClientID string

	// ClientSecret is the secret of the management client.
	ClientSecret string

	// Scopes is a list of scopes the CodeGenSDK should request. If no scopes are given, this defaults to `hydra.*`
	Scopes []string
}

Configuration configures the CodeGenSDK.

type JWKApi

type JWKApi interface {
	CreateJsonWebKeySet(set string, body swagger.JsonWebKeySetGeneratorRequest) (*swagger.JsonWebKeySet, *swagger.APIResponse, error)
	DeleteJsonWebKey(kid string, set string) (*swagger.APIResponse, error)
	DeleteJsonWebKeySet(set string) (*swagger.APIResponse, error)
	GetJsonWebKey(kid string, set string) (*swagger.JsonWebKeySet, *swagger.APIResponse, error)
	GetJsonWebKeySet(set string) (*swagger.JsonWebKeySet, *swagger.APIResponse, error)
	UpdateJsonWebKey(kid string, set string, body swagger.JsonWebKey) (*swagger.JsonWebKey, *swagger.APIResponse, error)
	UpdateJsonWebKeySet(set string, body swagger.JsonWebKeySet) (*swagger.JsonWebKeySet, *swagger.APIResponse, error)
}

type OAuth2API

type OAuth2API interface {
	AcceptConsentRequest(challenge string, body swagger.AcceptConsentRequest) (*swagger.CompletedRequest, *swagger.APIResponse, error)
	AcceptLoginRequest(challenge string, body swagger.AcceptLoginRequest) (*swagger.CompletedRequest, *swagger.APIResponse, error)
	RejectConsentRequest(challenge string, body swagger.RejectRequest) (*swagger.CompletedRequest, *swagger.APIResponse, error)
	RejectLoginRequest(challenge string, body swagger.RejectRequest) (*swagger.CompletedRequest, *swagger.APIResponse, error)
	GetLoginRequest(challenge string) (*swagger.LoginRequest, *swagger.APIResponse, error)
	GetConsentRequest(challenge string) (*swagger.ConsentRequest, *swagger.APIResponse, error)

	CreateOAuth2Client(body swagger.OAuth2Client) (*swagger.OAuth2Client, *swagger.APIResponse, error)
	DeleteOAuth2Client(id string) (*swagger.APIResponse, error)
	GetOAuth2Client(id string) (*swagger.OAuth2Client, *swagger.APIResponse, error)
	GetWellKnown() (*swagger.WellKnown, *swagger.APIResponse, error)
	IntrospectOAuth2Token(token string, scope string) (*swagger.OAuth2TokenIntrospection, *swagger.APIResponse, error)
	ListOAuth2Clients(limit int64, offset int64) ([]swagger.OAuth2Client, *swagger.APIResponse, error)
	RevokeOAuth2Token(token string) (*swagger.APIResponse, error)
	UpdateOAuth2Client(id string, body swagger.OAuth2Client) (*swagger.OAuth2Client, *swagger.APIResponse, error)

	ListUserConsentSessions(user string) ([]swagger.PreviousConsentSession, *swagger.APIResponse, error)
	FlushInactiveOAuth2Tokens(body swagger.FlushInactiveOAuth2TokensRequest) (*swagger.APIResponse, error)
}

type SDK

type SDK interface {
	JWKApi
	OAuth2API
}

SDK helps developers interact with ORY Hydra using a Go API.