Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v0

v0.8.4

Oct 4, 2021

v0.8.3

Oct 4, 2021

v0.8.2

Oct 4, 2021

v0.8.1

Oct 4, 2021

v0.8.0

Oct 1, 2021

v0.7.0

Nov 18, 2020

v0.6.0

Nov 6, 2020

Changes in this version

+ const DefaultSignatureAlg

+ var ProviderSet = wire.NewSet(NewCerberusAPI, wire.Bind(new(ServerInterface), new(*CerberusAPI)))

+ func CalculatePageCount(total uint, pageSize uint) (pages int)

+ func GetSwagger() (*openapi3.Swagger, error)

+ func RegisterHandlers(router EchoRouter, si ServerInterface)

+ type AddClaimToScope struct

+ ClaimId int

+ type AddClaimToScopeJSONBody AddClaimToScope

+ type AddClaimToScopeJSONRequestBody AddClaimToScopeJSONBody

+ type ApiError struct

+ ErrorCode string

+ Message string

+ func (e *ApiError) Error() string

+ type CerberusAPI struct

+ SPStoreService core.ISPStoreService

+ ScopeClaimStore core.IScopeClaimStoreService

+ SecretStoreStore core.ISecretStoreService

+ UserStoreService core.IUserStoreService

+ func NewCerberusAPI(scopeClaimStore core.IScopeClaimStoreService, ...) *CerberusAPI

+ func (c *CerberusAPI) AddClaimToScope(ctx echo.Context, id int) error

+ func (c *CerberusAPI) ChangeUserPassword(ctx echo.Context, id int) error

+ func (c *CerberusAPI) CreateClaim(ctx echo.Context) error

+ func (c *CerberusAPI) CreateScope(ctx echo.Context) error

+ func (c *CerberusAPI) CreateSecretChannel(ctx echo.Context) error

+ func (c *CerberusAPI) CreateServiceProvider(ctx echo.Context) error

+ func (c *CerberusAPI) CreateUser(ctx echo.Context) error

+ func (c *CerberusAPI) DeleteClaim(ctx echo.Context, id int) error

+ func (c *CerberusAPI) DeleteScope(ctx echo.Context, id int) error

+ func (c *CerberusAPI) DeleteSecretChannel(ctx echo.Context, id int) error

+ func (c *CerberusAPI) DeleteServiceProvider(ctx echo.Context, id int) error

+ func (c *CerberusAPI) DeleteUser(ctx echo.Context, id int) error

+ func (c *CerberusAPI) FindClaimByName(ctx echo.Context, params FindClaimByNameParams) error

+ func (c *CerberusAPI) FindScopeByName(ctx echo.Context, params FindScopeByNameParams) error

+ func (c *CerberusAPI) FindSecretChannelByAlgouse(ctx echo.Context, params FindSecretChannelByAlgouseParams) error

+ func (c *CerberusAPI) FindSecretChannelByName(ctx echo.Context, params FindSecretChannelByNameParams) error

+ func (c *CerberusAPI) FindServiceProvider(ctx echo.Context, params FindServiceProviderParams) error

+ func (c *CerberusAPI) FindUser(ctx echo.Context, params FindUserParams) error

+ func (c *CerberusAPI) GenerateCredentials(ctx echo.Context, id int) error

+ func (c *CerberusAPI) GetClaim(ctx echo.Context, id int) error

+ func (c *CerberusAPI) GetClaims(ctx echo.Context, params GetClaimsParams) error

+ func (c *CerberusAPI) GetCredentials(ctx echo.Context, id int) error

+ func (c *CerberusAPI) GetScope(ctx echo.Context, id int) error

+ func (c *CerberusAPI) GetScopes(ctx echo.Context, params GetScopesParams) error

+ func (c *CerberusAPI) GetSecretChannel(ctx echo.Context, id int) error

+ func (c *CerberusAPI) GetSecretChannels(ctx echo.Context, params GetSecretChannelsParams) error

+ func (c *CerberusAPI) GetServiceProvider(ctx echo.Context, id int) error

+ func (c *CerberusAPI) GetServiceProviders(ctx echo.Context, params GetServiceProvidersParams) error

+ func (c *CerberusAPI) GetUser(ctx echo.Context, id int) error

+ func (c *CerberusAPI) GetUsers(ctx echo.Context, params GetUsersParams) error

+ func (c *CerberusAPI) InitiatePasswordRecovery(ctx echo.Context) error

+ func (c *CerberusAPI) PatchServiceProvider(ctx echo.Context, _ int) error

+ func (c *CerberusAPI) RemoveClaimFromScope(ctx echo.Context, id int, claimId int) error

+ func (c *CerberusAPI) RenewSecretChannel(ctx echo.Context, id int) error

+ func (c *CerberusAPI) ResetUserPassword(ctx echo.Context) error

+ func (c *CerberusAPI) UpdateClaim(ctx echo.Context, id int) error

+ func (c *CerberusAPI) UpdateScope(ctx echo.Context, id int) error

+ func (c *CerberusAPI) UpdateServiceProvider(ctx echo.Context, id int) error

+ func (c *CerberusAPI) UpdateServiceProviderStatus(ctx echo.Context, id int) error

+ func (c *CerberusAPI) UpdateUser(ctx echo.Context, id int) error

+ func (c *CerberusAPI) UpdateUserStatus(ctx echo.Context, id int) error

+ type ChangePasswordRequest struct

+ NewPassword string

+ OldPassword string

+ type ChangeUserPasswordJSONBody ChangePasswordRequest

+ type ChangeUserPasswordJSONRequestBody ChangeUserPasswordJSONBody

+ type Claim struct

+ Description *string

+ Id int

+ Name string

+ type ClaimPage struct

+ Claims []Claim

+ type CreateClaimJSONBody Claim

+ type CreateClaimJSONRequestBody CreateClaimJSONBody

+ type CreateScopeJSONBody Scope

+ type CreateScopeJSONRequestBody CreateScopeJSONBody

+ type CreateSecretChannelJSONBody SecretChannel

+ type CreateSecretChannelJSONRequestBody CreateSecretChannelJSONBody

+ type CreateServiceProviderJSONBody ServiceProvider

+ type CreateServiceProviderJSONRequestBody CreateServiceProviderJSONBody

+ type CreateUserJSONBody User

+ type CreateUserJSONRequestBody CreateUserJSONBody

+ type EchoRouter interface

+ CONNECT func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ DELETE func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ GET func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ HEAD func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ OPTIONS func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ PATCH func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ POST func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ PUT func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ TRACE func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ type FindClaimByNameParams struct

+ Name string

+ type FindScopeByNameParams struct

+ Name string

+ type FindSecretChannelByAlgouseParams struct

+ Algo string

+ Use string

+ type FindSecretChannelByNameParams struct

+ Name string

+ type FindServiceProviderParams struct

+ ClientId *string

+ Name *string

+ type FindUserParams struct

+ Email *string

+ Username *string

+ type GenerateCredentialsJSONBody RegenerateCredentials

+ type GenerateCredentialsJSONRequestBody GenerateCredentialsJSONBody

+ type GetClaimsParams struct

+ PageNumber *int

+ PageSize *int

+ type GetScopesParams struct

+ PageNumber *int

+ PageSize *int

+ type GetSecretChannelsParams struct

+ PageNumber *int

+ PageSize *int

+ type GetServiceProvidersParams struct

+ PageNumber *int

+ PageSize *int

+ type GetUsersParams struct

+ PageNumber *int

+ PageSize *int

+ type InitiatePasswordRecoveryJSONBody UserRecoverPassword

+ type InitiatePasswordRecoveryJSONRequestBody InitiatePasswordRecoveryJSONBody

+ type Page struct

+ PageNumber int

+ PageTotal int

+ type PatchServiceProviderJSONBody ServiceProvider

+ type PatchServiceProviderJSONRequestBody PatchServiceProviderJSONBody

+ type RegenerateCredentials struct

+ RefreshId *bool

+ type ResetUserPasswordJSONBody UserResetPassword

+ type ResetUserPasswordJSONRequestBody ResetUserPasswordJSONBody

+ type Scope struct

+ Description *string

+ Id int

+ Name string

+ type ScopePage struct

+ Scopes []Scope

+ type Secret struct

+ Algorithm string

+ ExpiresAt time.Time

+ IssuedAt time.Time

+ KeyUsage string

+ type SecretChannel struct

+ Algorithm string

+ Id int

+ KeyUsage string

+ Name string

+ Secrets []Secret

+ ValidityDay int

+ type SecretChannelPage struct

+ Channels []SecretChannelSummary

+ type SecretChannelSummary struct

+ Algorithm string

+ Id int

+ KeyUsage string

+ Name string

+ type ServerInterface interface

+ AddClaimToScope func(ctx echo.Context, id int) error

+ ChangeUserPassword func(ctx echo.Context, id int) error

+ CreateClaim func(ctx echo.Context) error

+ CreateScope func(ctx echo.Context) error

+ CreateSecretChannel func(ctx echo.Context) error

+ CreateServiceProvider func(ctx echo.Context) error

+ CreateUser func(ctx echo.Context) error

+ DeleteClaim func(ctx echo.Context, id int) error

+ DeleteScope func(ctx echo.Context, id int) error

+ DeleteSecretChannel func(ctx echo.Context, id int) error

+ DeleteServiceProvider func(ctx echo.Context, id int) error

+ DeleteUser func(ctx echo.Context, id int) error

+ FindClaimByName func(ctx echo.Context, params FindClaimByNameParams) error

+ FindScopeByName func(ctx echo.Context, params FindScopeByNameParams) error

+ FindSecretChannelByAlgouse func(ctx echo.Context, params FindSecretChannelByAlgouseParams) error

+ FindSecretChannelByName func(ctx echo.Context, params FindSecretChannelByNameParams) error

+ FindServiceProvider func(ctx echo.Context, params FindServiceProviderParams) error

+ FindUser func(ctx echo.Context, params FindUserParams) error

+ GenerateCredentials func(ctx echo.Context, id int) error

+ GetClaim func(ctx echo.Context, id int) error

+ GetClaims func(ctx echo.Context, params GetClaimsParams) error

+ GetCredentials func(ctx echo.Context, id int) error

+ GetScope func(ctx echo.Context, id int) error

+ GetScopes func(ctx echo.Context, params GetScopesParams) error

+ GetSecretChannel func(ctx echo.Context, id int) error

+ GetSecretChannels func(ctx echo.Context, params GetSecretChannelsParams) error

+ GetServiceProvider func(ctx echo.Context, id int) error

+ GetServiceProviders func(ctx echo.Context, params GetServiceProvidersParams) error

+ GetUser func(ctx echo.Context, id int) error

+ GetUsers func(ctx echo.Context, params GetUsersParams) error

+ InitiatePasswordRecovery func(ctx echo.Context) error

+ PatchServiceProvider func(ctx echo.Context, id int) error

+ RemoveClaimFromScope func(ctx echo.Context, id int, claimId int) error

+ RenewSecretChannel func(ctx echo.Context, id int) error

+ ResetUserPassword func(ctx echo.Context) error

+ UpdateClaim func(ctx echo.Context, id int) error

+ UpdateScope func(ctx echo.Context, id int) error

+ UpdateServiceProvider func(ctx echo.Context, id int) error

+ UpdateServiceProviderStatus func(ctx echo.Context, id int) error

+ UpdateUser func(ctx echo.Context, id int) error

+ UpdateUserStatus func(ctx echo.Context, id int) error

+ type ServerInterfaceWrapper struct

+ Handler ServerInterface

+ func (w *ServerInterfaceWrapper) AddClaimToScope(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) ChangeUserPassword(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) CreateClaim(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) CreateScope(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) CreateSecretChannel(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) CreateServiceProvider(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) CreateUser(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) DeleteClaim(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) DeleteScope(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) DeleteSecretChannel(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) DeleteServiceProvider(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) DeleteUser(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) FindClaimByName(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) FindScopeByName(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) FindSecretChannelByAlgouse(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) FindSecretChannelByName(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) FindServiceProvider(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) FindUser(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) GenerateCredentials(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) GetClaim(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) GetClaims(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) GetCredentials(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) GetScope(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) GetScopes(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) GetSecretChannel(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) GetSecretChannels(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) GetServiceProvider(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) GetServiceProviders(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) GetUser(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) GetUsers(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) InitiatePasswordRecovery(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) PatchServiceProvider(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) RemoveClaimFromScope(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) RenewSecretChannel(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) ResetUserPassword(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) UpdateClaim(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) UpdateScope(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) UpdateServiceProvider(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) UpdateServiceProviderStatus(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) UpdateUser(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) UpdateUserStatus(ctx echo.Context) error

+ type ServiceProvider struct

+ type ServiceProviderConfig struct

+ DefaultAcrValues *[]string

+ DefaultMaxAge *int

+ GrantTypes []string

+ IdTokenEncryptedResponseAlg *string

+ IdTokenEncryptedResponseEnc *string

+ IdTokenSignedResponseAlg *string

+ Jwks *string

+ JwksUri *string

+ RedirectUris []string

+ RequestObjectEncryptionAlg *string

+ RequestObjectEncryptionEnc *string

+ RequestObjectSigningAlg *string

+ RequestUris *[]string

+ RequireAuthTime *bool

+ Scope []string

+ TokenEndpointAuthMethod *string

+ TokenEndpointAuthSigningAlg *string

+ UserinfoEncryptedResponseAlg *string

+ UserinfoEncryptedResponseEnc *string

+ UserinfoSignedResponseAlg *string

+ type ServiceProviderCredentials struct

+ ClientId string

+ ClientSecret string

+ type ServiceProviderInfo struct

+ ApplicationType string

+ ClientUri *string

+ Contacts *[]string

+ InitiateLoginUri *string

+ LogoUri *string

+ PolicyUri *string

+ TosUri *string

+ type ServiceProviderSummary struct

+ Description *string

+ Id int

+ Name string

+ Public bool

+ type ServiceProviderSummaryPage struct

+ ServiceProviders []ServiceProviderSummary

+ type StatusUpdate struct

+ Active bool

+ type UnAuthorized ApiError

+ type UpdateClaimJSONBody Claim

+ type UpdateClaimJSONRequestBody UpdateClaimJSONBody

+ type UpdateScopeJSONBody Scope

+ type UpdateScopeJSONRequestBody UpdateScopeJSONBody

+ type UpdateServiceProviderJSONBody ServiceProvider

+ type UpdateServiceProviderJSONRequestBody UpdateServiceProviderJSONBody

+ type UpdateServiceProviderStatusJSONBody StatusUpdate

+ type UpdateServiceProviderStatusJSONRequestBody UpdateServiceProviderStatusJSONBody

+ type UpdateUserJSONBody User

+ type UpdateUserJSONRequestBody UpdateUserJSONBody

+ type UpdateUserStatusJSONBody StatusUpdate

+ type UpdateUserStatusJSONRequestBody UpdateUserStatusJSONBody

+ type User struct

+ type UserAddress struct

+ Country *string

+ Formatted *string

+ Locality *string

+ PostalCode *string

+ Region *string

+ StreetAddress *string

+ type UserContact struct

+ Email *string

+ EmailVerified *bool

+ PhoneNumber *string

+ PhoneNumberVerified *bool

+ type UserName struct

+ FamilyName *string

+ GivenName *string

+ MiddleName *string

+ Name *string

+ Nickname *string

+ PreferredUsername *string

+ type UserProfile struct

+ Address *UserAddress

+ Birthdate *openapi_types.Date

+ Gender *string

+ Locale *string

+ Picture *string

+ Profile *string

+ Website *string

+ Zoneinfo *string

+ type UserRecoverPassword struct

+ Email string

+ Username string

+ type UserResetPassword struct

+ Otp string

+ Password string

+ Username string

+ type UserSummary struct

+ Active bool

+ Blocked bool

+ Email string

+ Id int

+ Username string

+ type UserSummaryPage struct

+ Users []UserSummary