Documentation ¶
Index ¶
- Constants
- func New(params sparks.Params) (sparks.Provider, error)
- type AuthChallenge
- type AuthToken
- type Provider
- func (p *Provider) Close()
- func (p *Provider) Decrypt(data []byte, params sparks.Params) ([]byte, error)
- func (p *Provider) Encrypt(data []byte, params sparks.Params) ([]byte, error)
- func (p *Provider) Name() string
- func (p *Provider) OpenObjectStore(name string, params ...sparks.Params) (sparks.ObjectStore, error)
- func (p *Provider) OpenQueue(name string, params sparks.Params) (sparks.Queue, error)
- func (p *Provider) OpenUserPool(name string, options sparks.Params) (sparks.UserPool, error)
- func (p *Provider) ProxyHTTP(handler http.Handler) error
- type User
- type UserPool
- func (p *UserPool) AuthenticateUser(username, password string) (keychain.AuthToken, error)
- func (p *UserPool) ChangeUserPassword(username, current, proposed string) error
- func (p *UserPool) CreateUser(username, password string, attributes map[string]string, ...) (sparks.User, error)
- func (p *UserPool) DeleteUser(username string) error
- func (p *UserPool) DisableUser(username string) error
- func (p *UserPool) GetUser(username string) (sparks.User, error)
- func (p *UserPool) UpdateUser(username string, attributes types.StringMap) error
Constants ¶
const (
// JWKSURL is the cognito well-known public keys url
JWKSURL = "https://cognito-idp.%s.amazonaws.com/%s/.well-known/jwks.json"
)
const (
// Name is the provider name
Name = "aws"
)
Variables ¶
This section is empty.
Functions ¶
Types ¶
type AuthChallenge ¶
AuthChallenge is a congnito auth challenge
func (*AuthChallenge) Error ¶
func (c *AuthChallenge) Error() string
type Provider ¶
type Provider struct {
// contains filtered or unexported fields
}
Provider is an AWS cloud provider
func DefaultProvider ¶ added in v1.5.2
func DefaultProvider() *Provider
DefaultProvider returns the default aws provider
func (*Provider) Decrypt ¶ added in v1.5.2
Decrypt implements the cloud.Encryption provider interface using KMS
func (*Provider) Encrypt ¶ added in v1.5.2
Encrypt implements the cloud.Encryption provider interface using KMS
func (*Provider) OpenObjectStore ¶
func (p *Provider) OpenObjectStore(name string, params ...sparks.Params) (sparks.ObjectStore, error)
OpenObjectStore returns an instance to an S3 bucket
func (*Provider) OpenUserPool ¶
OpenUserPool returns a cognito user pool instance. This method takes the following required parameters:
client_id: the cognito client id public_keys: base64 encoded json string, retrieved from: https://cognito-idp.<region>.amazonaws.com/<pool_id>/.well-known/jwks.json
type User ¶
type User struct { *cognitoidentityprovider.UserType // contains filtered or unexported fields }
User is a cognito User
func (*User) Attributes ¶
Attributes returns a map of user attributes
type UserPool ¶
type UserPool struct {
// contains filtered or unexported fields
}
UserPool is a congnito UserPool
func (*UserPool) AuthenticateUser ¶
AuthenticateUser authenticates the user and returns an AuthToken
func (*UserPool) ChangeUserPassword ¶
ChangeUserPassword changes the users password This method first attempt to authenticate the user to get a session token then it uses this token to perform the actual password change.
func (*UserPool) CreateUser ¶
func (p *UserPool) CreateUser(username, password string, attributes map[string]string, options ...sparks.Params) (sparks.User, error)
CreateUser creates a new user
func (*UserPool) DeleteUser ¶
DeleteUser deletes a user record
func (*UserPool) DisableUser ¶
DisableUser disables a user account