accesslist

type AccessList struct {
	// ResourceHeader is the common resource header for all resources.
	header.ResourceHeader

	// Spec is the specification for the access list.
	Spec Spec `json:"spec" yaml:"spec"`

	// Status contains dynamically calculated fields.
	Status Status `json:"-" yaml:"-"`
}

type AccessListMember struct {
	// ResourceHeader is the common resource header for all resources.
	header.ResourceHeader

	// Spec is the specification for the access list member.
	Spec AccessListMemberSpec `json:"spec" yaml:"spec"`
}

type AccessListMemberSpec struct {
	// AccessList is the name of the associated access list.
	AccessList string `json:"access_list" yaml:"access_list"`

	// Name is the name of the member of the access list.
	Name string `json:"name" yaml:"name"`

	// Joined is when the user joined the access list.
	Joined time.Time `json:"joined" yaml:"joined"`

	// expires is when the user's membership to the access list expires.
	Expires time.Time `json:"expires" yaml:"expires"`

	// reason is the reason this user was added to the access list.
	Reason string `json:"reason" yaml:"reason"`

	// added_by is the user that added this user to the access list.
	AddedBy string `json:"added_by" yaml:"added_by"`

	// IneligibleStatus describes the reason why this member is not eligible.
	IneligibleStatus string `json:"ineligible_status" yaml:"ineligible_status"`
}

type Audit struct {
	// NextAuditDate is the date that the next audit should be performed.
	NextAuditDate time.Time `json:"next_audit_date" yaml:"next_audit_date"`

	// Recurrence is the recurrence definition for auditing. Valid values are
	// 1, first, 15, and last.
	Recurrence Recurrence `json:"recurrence" yaml:"recurrence"`

	// Notifications is the configuration for notifying users.
	Notifications Notifications `json:"notifications" yaml:"notifications"`
}

type Grants struct {
	// Roles are the roles that are granted to users who are members of the access list.
	Roles []string `json:"roles" yaml:"roles"`

	// Traits are the traits that are granted to users who are members of the access list.
	Traits trait.Traits `json:"traits" yaml:"traits"`
}

type Notifications struct {
	// Start specifies when to start notifying users that the next audit date is coming up.
	Start time.Duration `json:"start" yaml:"start"`
}

type Owner struct {
	// Name is the username of the owner.
	Name string `json:"name" yaml:"name"`

	// Description is the plaintext description of the owner and why they are an owner.
	Description string `json:"description" yaml:"description"`

	// IneligibleStatus describes the reason why this owner is not eligible.
	IneligibleStatus string `json:"ineligible_status" yaml:"ineligible_status"`
}

type Recurrence struct {
	// Frequency is the frequency between access list reviews.
	Frequency ReviewFrequency `json:"frequency" yaml:"frequency"`

	// DayOfMonth is the day of month subsequent reviews will be scheduled on.
	DayOfMonth ReviewDayOfMonth `json:"day_of_month" yaml:"day_of_month"`
}

type Requires struct {
	// Roles are the user roles that must be present for the user to obtain access.
	Roles []string `json:"roles" yaml:"roles"`

	// Traits are the traits that must be present for the user to obtain access.
	Traits trait.Traits `json:"traits" yaml:"traits"`
}

type Review struct {
	// ResourceHeader is the common resource header for all resources.
	header.ResourceHeader

	// Spec is the specification for the access list review.
	Spec ReviewSpec `json:"spec" yaml:"spec"`
}

type ReviewChanges struct {
	// MembershipRequirementsChanged is populated if the requirements were changed as part of this review.
	MembershipRequirementsChanged *Requires `json:"membership_requirements_changed" yaml:"membership_requirements_changed"`

	// RemovedMembers contains the members that were removed as part of this review.
	RemovedMembers []string `json:"removed_members" yaml:"removed_members"`

	// ReviewFrequencyChanged is populated if the review frequency has changed.
	ReviewFrequencyChanged ReviewFrequency `json:"review_frequency_changed" yaml:"review_frequency_changed"`

	// ReviewDayOfMonthChanged is populated if the review day of month has changed.
	ReviewDayOfMonthChanged ReviewDayOfMonth `json:"review_day_of_month_changed" yaml:"review_day_of_month_changed"`
}

type ReviewDayOfMonth int

type ReviewFrequency int

type ReviewSpec struct {
	// AccessList is the name of the associated access list.
	AccessList string `json:"access_list" yaml:"access_list"`

	// Reviewers are the users who performed the review.
	Reviewers []string `json:"reviewers" yaml:"reviewers"`

	// ReviewDate is the date that this review was created.
	ReviewDate time.Time `json:"review_date" yaml:"review_date"`

	// Notes is an optional plaintext attached to the review that can be used by the review for arbitrary
	// note taking on the review.
	Notes string `json:"notes" yaml:"notes"`

	// Changes are the changes made as part of the review.
	Changes ReviewChanges `json:"changes" yaml:"changes"`
}

type Spec struct {
	// Title is a plaintext short description of the access list.
	Title string `json:"title" yaml:"title"`

	// Description is an optional plaintext description of the access list.
	Description string `json:"description" yaml:"description"`

	// Owners is a list of owners of the access list.
	Owners []Owner `json:"owners" yaml:"owners"`

	// Audit describes the frequency that this access list must be audited.
	Audit Audit `json:"audit" yaml:"audit"`

	// MembershipRequires describes the requirements for a user to be a member of the access list.
	// For a membership to an access list to be effective, the user must meet the requirements of
	// MembershipRequires and must be in the members list.
	MembershipRequires Requires `json:"membership_requires" yaml:"membership_requires"`

	// OwnershipRequires describes the requirements for a user to be an owner of the access list.
	// For ownership of an access list to be effective, the user must meet the requirements of
	// OwnershipRequires and must be in the owners list.
	OwnershipRequires Requires `json:"ownership_requires" yaml:"ownership_requires"`

	// Grants describes the access granted by membership to this access list.
	Grants Grants `json:"grants" yaml:"grants"`

	// OwnerGrants describes the access granted by ownership of this access list.
	OwnerGrants Grants `json:"owner_grants" yaml:"owner_grants"`
}

type Status struct {
	// MemberCount is the number of members in the access list.
	MemberCount *uint32
}