package cognito

import "github.com/oslokommune/okctl/pkg/cognito"

Package cognito implements some functionality to interact with the cognito API

Index ¶

• Constants
• func RegisterMFADevice(opts RegisterMFADeviceOpts) error
• type AuthCertDeleter
• func NewCertDeleter(usprovider v1alpha1.CloudProvider) *AuthCertDeleter
• func (c *AuthCertDeleter) DeleteAuthCert(opts DeleteAuthCertOpts) error
• type Cognito
• func New(provider v1alpha1.CloudProvider) *Cognito
• func (c *Cognito) DeleteAuthDomain(userPoolID, domain string) error
• func (c *Cognito) DeleteUserPool(userPoolID string) error
• func (c *Cognito) EnableMFA(userPoolID string) error
• func (c *Cognito) UserPoolClientSecret(clientID, userPoolID string) (string, error)
• func (c *Cognito) UserPoolDomainInfo(domain string) (*UserPoolDomainInfo, error)
• type DeleteAuthCertOpts
• func (o *DeleteAuthCertOpts) Validate() error
• type RegisterMFADeviceOpts
• type UserPoolDomainInfo

Constants ¶

const (
	// MFAOutputFormatQRCode represents showing the MFA details as a QR code
	MFAOutputFormatQRCode = "qrcode"
	// MFAOutputFormatText represents showing the MFA details as text
	MFAOutputFormatText = "text"
)

Functions ¶

func RegisterMFADevice ¶

func RegisterMFADevice(opts RegisterMFADeviceOpts) error

RegisterMFADevice knows how to register an MFA device with a user

Types ¶

type AuthCertDeleter ¶

type AuthCertDeleter struct {
	// contains filtered or unexported fields
}

AuthCertDeleter is used just to delete the auth. cert in us-east-1

func NewCertDeleter ¶

func NewCertDeleter(usprovider v1alpha1.CloudProvider) *AuthCertDeleter

NewCertDeleter returns an initialised AuthCertDeleter

func (*AuthCertDeleter) DeleteAuthCert ¶

func (c *AuthCertDeleter) DeleteAuthCert(opts DeleteAuthCertOpts) error

DeleteAuthCert delete the auth certificate that was made in us-east-1 for identitypool

type Cognito ¶

type Cognito struct {
	// contains filtered or unexported fields
}

Cognito contains all required state for interacting with the Cognito API

func New ¶

func New(provider v1alpha1.CloudProvider) *Cognito

New returns an initialised cognito interaction

func (*Cognito) DeleteAuthDomain ¶

func (c *Cognito) DeleteAuthDomain(userPoolID, domain string) error

DeleteAuthDomain dissociate auth domain with user pool, to allow pool deletion

func (*Cognito) DeleteUserPool ¶

func (c *Cognito) DeleteUserPool(userPoolID string) error

DeleteUserPool removes the userpool

func (*Cognito) EnableMFA ¶

func (c *Cognito) EnableMFA(userPoolID string) error

EnableMFA for a user pool

func (*Cognito) UserPoolClientSecret ¶

func (c *Cognito) UserPoolClientSecret(clientID, userPoolID string) (string, error)

UserPoolClientSecret returns the client secret for a user pool client

func (*Cognito) UserPoolDomainInfo ¶

func (c *Cognito) UserPoolDomainInfo(domain string) (*UserPoolDomainInfo, error)

UserPoolDomainInfo returns information about the cognito user pool domain

type DeleteAuthCertOpts ¶

type DeleteAuthCertOpts struct {
	Domain string
}

DeleteAuthCertOpts options needed to delete an auth certificate

func (*DeleteAuthCertOpts) Validate ¶

func (o *DeleteAuthCertOpts) Validate() error

Validate the inputs to delete an auth certificate

type RegisterMFADeviceOpts ¶

type RegisterMFADeviceOpts struct {
	Ctx                    context.Context
	CognitoProvider        cognitoidentityprovideriface.CognitoIdentityProviderAPI
	ParameterStoreProvider ssmiface.SSMAPI
	Cluster                v1alpha1.Cluster
	UserEmail              string
	OutputFormat           string
}

RegisterMFADeviceOpts are the options for registering an MFA device

type UserPoolDomainInfo ¶

type UserPoolDomainInfo struct {
	CloudFrontDomainName string
	UserPoolDomain       string
}

UserPoolDomainInfo contains the retrieved state about a cognito user pool domain

Source Files ¶

api.go authcertdeleter.go cognito.go docs.go mfa.go