Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Action ¶
type Action = string
Action defines an action the organization took
const ( // VisitedOnboardingFlow defines when an organization visited the onboarding flow VisitedOnboardingFlow Action = "VISITED_ONBOARDING_FLOW" )
type AwsConfig ¶
type AwsConfig struct {
UserPoolID *string `json:"userPoolId"`
AppClientID *string `json:"appClientId"`
IdentityPoolID *string `json:"identityPoolId"`
}
AwsConfig defines metadata related to AWS infrastructure for the organization
type CompleteActionInput ¶
type CompleteActionInput struct {
CompletedActions []*Action `json:"actions"`
}
CompleteActionInput Adds a Action to an Organization
type CompleteActionOutput ¶
type CompleteActionOutput struct {
CompletedActions []*Action `json:"actions"`
}
CompleteActionOutput Adds a Action to an Organization
type CreateOrganizationInput ¶
type CreateOrganizationInput struct {
AlertReportFrequency *string `json:"alertReportFrequency" validate:"omitempty,oneof=P1D P1W"`
AwsConfig *AwsConfig `json:"awsConfig"`
DisplayName *string `json:"displayName" validate:"required,min=1"`
Email *string `genericapi:"redact" json:"email" validate:"required,email"`
Phone *string `genericapi:"redact" json:"phone"`
}
CreateOrganizationInput creates a new Panther customer account.
type CreateOrganizationOutput ¶
type CreateOrganizationOutput struct {
Organization *Organization `json:"organization"`
}
CreateOrganizationOutput returns the newly created organization.
type GetOrganizationInput ¶
type GetOrganizationInput struct {
}
GetOrganizationInput retrieves the details of a Panther customer account.
type GetOrganizationOutput ¶
type GetOrganizationOutput struct {
Organization *Organization `json:"organization"`
}
GetOrganizationOutput is the table row representing a customer account.
type LambdaInput ¶
type LambdaInput struct {
CompleteAction *CompleteActionInput `json:"getCompletedActions"`
CreateOrganization *CreateOrganizationInput `json:"createOrganization"`
GetOrganization *GetOrganizationInput `json:"getOrganization"`
UpdateOrganization *UpdateOrganizationInput `json:"updateOrganization"`
}
LambdaInput is the request structure for the organization-api Lambda function.
type Organization ¶
type Organization struct {
AlertReportFrequency *string `json:"alertReportFrequency"`
AwsConfig *AwsConfig `json:"awsConfig"`
CompletedActions []*Action `dynamodbav:"completedActions,omitempty,stringset" json:"completedActions"`
CreatedAt *string `json:"createdAt"`
DisplayName *string `json:"displayName"`
Email *string `json:"email"`
Phone *string `json:"phone"`
}
Organization defines the fields in the table row.
type UpdateOrganizationInput ¶
type UpdateOrganizationInput struct {
CreateOrganizationInput
}
UpdateOrganizationInput modifies the details of an existing organization.
type UpdateOrganizationOutput ¶
type UpdateOrganizationOutput struct {
Organization *Organization `json:"organization"`
}
UpdateOrganizationOutput is the table row representing the modified customer account.
Source Files