servicenow

type App struct {
	*lib.Process
	common.BaseApp

	PluginName string
	// contains filtered or unexported fields
}

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

type Client struct {
	ClientConfig
	// contains filtered or unexported fields
}

type ClientConfig struct {
	// APIEndpoint is the endpoint for the Servicenow API
	// api url of the form  https://instance.service-now.com/ with optional trailing '/'
	APIEndpoint string

	// WebProxyURL is the Teleport address used when building the bodies of the incidents
	// allowing links to the access requests to be built
	WebProxyURL *url.URL

	// ClusterName is the name of the Teleport cluster.
	ClusterName string

	// Username is the username used by the client for basic auth.
	Username string
	// APIToken is the token used for basic auth.
	APIToken string
	// CloseCode is the ServiceNow close code that incidents will be closed with.
	CloseCode string

	// StatusSink receives any status updates from the plugin for
	// further processing. Status updates will be ignored if not set.
	StatusSink common.StatusSink
}

type Config struct {
	common.BaseConfig
	ClientConfig
	ServiceNow common.GenericAPIConfig

	// Teleport is a handle to the client to use when communicating with
	// the Teleport auth server. The ServiceNow app will create a gRPC-based
	// client on startup if this is not set.
	Client teleport.Client

	// TeleportUser is the name of the Teleport user that will act
	// as the access request approver
	TeleportUser string
}

type Incident struct {
	// IncidentID is the sys_id of the incident
	IncidentID string `json:"sys_id,omitempty"`
	// ShortDescription contains a brief summary of the incident.
	ShortDescription string `json:"short_description,omitempty"`
	// Description contains the description of the incident.
	Description string `json:"description,omitempty"`
	// CloseCode contains the close code of the incident once it is resolved.
	CloseCode string `json:"close_code,omitempty"`
	// CloseNotes contains the closing comments on the incident once it is resolved.
	CloseNotes string `json:"close_notes,omitempty"`
	// IncidentState contains the current state the incident is in.
	IncidentState string `json:"incident_state,omitempty"`
	// WorkNotes contains comments on the progress of the incident.
	WorkNotes string `json:"work_notes,omitempty"`
	// Caller is the user on whose behalf the incident is being created. (Must be an existing servicenow user)
	Caller string `json:"caller_id,omitempty"`
	// AssignedTo is the ServiceNow user the incident is assigned.
	AssignedTo string `json:"assigned_to,omitempty"`
}

type PluginData struct {
	RequestData
	ServiceNowData
}

type RequestData struct {
	// User is the requesting user.
	User string
	// Roles are the roles being requested.
	Roles []string
	// Created is the request creation timestamp.
	Created time.Time
	// RequestReason is the reason for the request.
	RequestReason string
	// ReviewCount is the number of the of the reviews on the access request.
	ReviewsCount int
	// Resolution is the final resolution of the access request.
	Resolution Resolution
	// SystemAnnotations contains key value annotations for the request.
	SystemAnnotations map[string][]string
	// Resources are the resources being requested.
	Resources []string
	// SuggestedReviewers are the suggested reviewers for this access request.
	SuggestedReviewers []string
}

type Resolution struct {
	// State is the state of the servicenow incident
	State string
	// Reason is the reason the incident is being closed.
	Reason string
}

type ServiceNowData struct {
	// IncidentID is the serviceNow sys_id of the incident
	IncidentID string
}