api

Documentation

Overview

Package api defines CRUD actions for the Cognito Api.

Index

• func CognitoTrigger(event *events.CognitoEventUserPoolsCustomMessage) (*events.CognitoEventUserPoolsCustomMessage, error)
• type API
  • func (API) GetUser(input *models.GetUserInput) (*models.GetUserOutput, error)
  • func (API) InviteUser(input *models.InviteUserInput) (*models.InviteUserOutput, error)
  • func (API) ListUsers(input *models.ListUsersInput) (*models.ListUsersOutput, error)
  • func (API) RemoveUser(input *models.RemoveUserInput) (*models.RemoveUserOutput, error)
  • func (API) ResetUserPassword(input *models.ResetUserPasswordInput) (*models.ResetUserPasswordOutput, error)
  • func (API) UpdateUser(input *models.UpdateUserInput) (*models.UpdateUserOutput, error)

Functions

func CognitoTrigger

func CognitoTrigger(event *events.CognitoEventUserPoolsCustomMessage) (*events.CognitoEventUserPoolsCustomMessage, error)

Instead of the standard API call, the users-api was invoked by Cognito as a custom message trigger

Types

type API

type API struct{}

The API has receiver methods for each of the handlers.

func (API) GetUser

func (API) GetUser(input *models.GetUserInput) (*models.GetUserOutput, error)

GetUser calls userGateway to get user information.

func (API) InviteUser

func (API) InviteUser(input *models.InviteUserInput) (*models.InviteUserOutput, error)

InviteUser adds a new user to the Cognito user pool.

func (API) ListUsers

func (API) ListUsers(input *models.ListUsersInput) (*models.ListUsersOutput, error)

ListUsers lists details for each user in Panther.

func (API) RemoveUser

func (API) RemoveUser(input *models.RemoveUserInput) (*models.RemoveUserOutput, error)

RemoveUser deletes a user from cognito.

func (API) ResetUserPassword

func (API) ResetUserPassword(input *models.ResetUserPasswordInput) (*models.ResetUserPasswordOutput, error)

ResetUserPassword resets a user password.

func (API) UpdateUser

func (API) UpdateUser(input *models.UpdateUserInput) (*models.UpdateUserOutput, error)

UpdateUser modifies user attributes.