types

package
v0.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 24, 2021 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessKey added in v0.5.0 

type AccessKey struct {
	// Identifier of the access key.
	Id string `json:"id"`
	// The name of the access key.
	Label string `json:"label"`
	// An array of domains for which the access key is valid. Whether Sumo Logic accepts or rejects an API request depends on whether it contains an ORIGIN header and the entries in the allowlist. Sumo Logic will reject:   1. Requests with an ORIGIN header but the allowlist is empty.   2. Requests with an ORIGIN header that don't match any entry in the allowlist.
	CorsHeaders []string `json:"corsHeaders,omitempty"`
	// Indicates whether the access key is disabled or not.
	Disabled bool `json:"disabled"`
	// Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
	CreatedAt time.Time `json:"createdAt"`
	// Identifier of the user who created the access key.
	CreatedBy string `json:"createdBy"`
	// Last modification timestamp in UTC.
	ModifiedAt time.Time `json:"modifiedAt"`
	// The key for the created access key. This field will have values only in the response for an access key create request. The value will be an empty string while listing all keys.
	Key string `json:"key"`
}

type AccessKeyCreateRequest added in v0.5.0 

type AccessKeyCreateRequest struct {
	// A name for the access key to be created.
	Label string `json:"label"`
	// An array of domains for which the access key is valid. Whether Sumo Logic accepts or rejects an API request depends on whether it contains an ORIGIN header and the entries in the allowlist. Sumo Logic will reject:   1. Requests with an ORIGIN header but the allowlist is empty.   2. Requests with an ORIGIN header that don't match any entry in the allowlist.
	CorsHeaders []string `json:"corsHeaders,omitempty"`
}

type AccessKeyManagementApiListAccessKeysOpts added in v0.5.0 

type AccessKeyManagementApiListAccessKeysOpts struct {
	Limit optional.Int32
	Token optional.String
}

type AccessKeyPublic added in v0.5.0 

type AccessKeyPublic struct {
	// Identifier of the access key.
	Id string `json:"id"`
	// The name of the access key.
	Label string `json:"label"`
	// An array of domains for which the access key is valid. Whether Sumo Logic accepts or rejects an API request depends on whether it contains an ORIGIN header and the entries in the allowlist. Sumo Logic will reject:   1. Requests with an ORIGIN header but the allowlist is empty.   2. Requests with an ORIGIN header that don't match any entry in the allowlist.
	CorsHeaders []string `json:"corsHeaders,omitempty"`
	// Indicates whether the access key is disabled or not.
	Disabled bool `json:"disabled"`
	// Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
	CreatedAt time.Time `json:"createdAt"`
	// Identifier of the user who created the access key.
	CreatedBy string `json:"createdBy"`
	// Last modification timestamp in UTC.
	ModifiedAt time.Time `json:"modifiedAt"`
}

type AccessKeyUpdateRequest added in v0.5.0 

type AccessKeyUpdateRequest struct {
	// Indicates whether the access key is disabled or not.
	Disabled bool `json:"disabled"`
	// An array of domains for which the access key is valid. Whether Sumo Logic accepts or rejects an API request depends on whether it contains an ORIGIN header and the entries in the allowlist. Sumo Logic will reject:   1. Requests with an ORIGIN header but the allowlist is empty.   2. Requests with an ORIGIN header that don't match any entry in the allowlist.
	CorsHeaders []string `json:"corsHeaders,omitempty"`
}

type AccountStatusResponse added in v0.6.0 

type AccountStatusResponse struct {
	// Whether the account is `cloudflex` or `credits`
	PricingModel string `json:"pricingModel"`
	// If the plan can be updated by the given user
	CanUpdatePlan bool `json:"canUpdatePlan"`
	// Whether the account is `Free`/`Trial`/`Paid`
	PlanType string `json:"planType"`
	// The number of days in which the plan will expire
	PlanExpirationDays int32 `json:"planExpirationDays,omitempty"`
	// The current usage of the application.
	ApplicationUse string `json:"applicationUse"`
}

type App added in v0.7.0 

type App struct {
	AppDefinition *AppDefinition `json:"appDefinition"`
	AppManifest   *AppManifest   `json:"appManifest"`
}

type AppDefinition added in v0.7.0 

type AppDefinition struct {
	// Content identifier of the app in hexadecimal format.
	ContentId string `json:"contentId"`
	// Unique identifier for the app.
	Uuid string `json:"uuid"`
	// Name of the app.
	Name string `json:"name"`
	// Version of the app.
	AppVersion string `json:"appVersion"`
	// Indicates whether the app is in preview or not.
	Preview bool `json:"preview,omitempty"`
	// Manifest version of the app
	ManifestVersion string `json:"manifestVersion,omitempty"`
}

type AppInstallRequest added in v0.7.0 

type AppInstallRequest struct {
	// Preferred name of the app to be installed. This will be the name of the app in the selected installation folder.
	Name string `json:"name"`
	// Preferred description of the app to be installed. This will be displayed as the app description in the selected installation folder.
	Description string `json:"description"`
	// Identifier of the folder in which the app will be installed in hexadecimal format.
	DestinationFolderId string `json:"destinationFolderId"`
	// Dictionary of properties specifying log-source name and value.
	DataSourceValues map[string]string `json:"dataSourceValues,omitempty"`
}

type AppManifest added in v0.7.0 

type AppManifest struct {
	// The app family
	Family string `json:"family,omitempty"`
	// Description of the app.
	Description string `json:"description"`
	// Categories that the app belongs to.
	Categories []string `json:"categories,omitempty"`
	// Text to be displayed when hovered over in UI.
	HoverText string `json:"hoverText"`
	// App icon URL.
	IconURL string `json:"iconURL"`
	// App screenshot URLs.
	ScreenshotURLs []string `json:"screenshotURLs,omitempty"`
	// App help page URL.
	HelpURL string `json:"helpURL,omitempty"`
	// the IDs of the docs pages for this app
	HelpDocIdMap map[string]string `json:"helpDocIdMap,omitempty"`
	// App community page URL.
	CommunityURL string `json:"communityURL,omitempty"`
	// Requirements for the app.
	Requirements []string `json:"requirements,omitempty"`
	// Account types that are allowed to install the app
	AccountTypes []string `json:"accountTypes,omitempty"`
	// Indicates whether installation instructions are required or not.
	RequiresInstallationInstructions bool `json:"requiresInstallationInstructions,omitempty"`
	// Installation instructions for the app.
	InstallationInstructions string `json:"installationInstructions,omitempty"`
	// Content identifier of the app.
	Parameters []ServiceManifestDataSourceParameter `json:"parameters,omitempty"`
	// App author.
	Author string `json:"author,omitempty"`
	// App author website URL.
	AuthorWebsite string `json:"authorWebsite,omitempty"`
}

type ArchiveJob added in v0.7.0 

type ArchiveJob struct {
	// The name of the ingestion job.
	Name string `json:"name"`
	// The starting timestamp of the ingestion job.
	StartTime time.Time `json:"startTime"`
	// The ending timestamp of the ingestion job.
	EndTime time.Time `json:"endTime"`
	// The unique identifier of the ingestion job.
	Id string `json:"id"`
	// The total number of objects scanned by the ingestion job.
	TotalObjectsScanned int64 `json:"totalObjectsScanned"`
	// The total number of objects ingested by the ingestion job.
	TotalObjectsIngested int64 `json:"totalObjectsIngested"`
	// The total bytes ingested by the ingestion job.
	TotalBytesIngested int64 `json:"totalBytesIngested"`
	// The status of the ingestion job, either `Pending`,`Scanning`,`Ingesting`,`Failed`, or `Succeeded`.
	Status string `json:"status"`
	// The creation timestamp in UTC of the ingestion job.
	CreatedAt time.Time `json:"createdAt"`
	// The identifier of the user who created the ingestion job.
	CreatedBy string `json:"createdBy"`
}

type ArchiveJobsCount added in v0.7.0 

type ArchiveJobsCount struct {
	// Identifier for the archive source.
	SourceId string `json:"sourceId"`
	// The total number of archive jobs with pending status for the archive source.
	Pending int64 `json:"pending"`
	// The total number of archive jobs with scanning status for the archive source.
	Scanning int64 `json:"scanning"`
	// The total number of archive jobs with ingesting status for the archive source.
	Ingesting int64 `json:"ingesting"`
	// The total number of archive jobs with failed status for the archive source.
	Failed int64 `json:"failed"`
	// The total number of archive jobs with succeeded status for the archive source.
	Succeeded int64 `json:"succeeded"`
}

type ArchiveManagementApiListArchiveJobsBySourceIdOpts added in v0.7.0 

type ArchiveManagementApiListArchiveJobsBySourceIdOpts struct {
	Limit optional.Int32
	Token optional.String
}

type AsyncJobStatus added in v0.4.0 

type AsyncJobStatus struct {
	// Whether or not the request is in progress (`InProgress`), has completed successfully (`Success`), or has completed with an error (`Failed`).
	Status string `json:"status"`
	// Additional status message generated if the status is not `Failed`.
	StatusMessage string            `json:"statusMessage,omitempty"`
	Error_        *ErrorDescription `json:"error,omitempty"`
}

type BeginAsyncJobResponse added in v0.4.0 

type BeginAsyncJobResponse struct {
	// Identifier to get the status of an asynchronous job.
	Id string `json:"id"`
}

type ChangeEmailRequest added in v0.6.0 

type ChangeEmailRequest struct {
	// New email address of the user.
	Email string `json:"email"`
}

type ConfigureSubdomainRequest added in v0.6.0 

type ConfigureSubdomainRequest struct {
	// The new subdomain.
	Subdomain string `json:"subdomain"`
}

type Content added in v0.3.0 

type Content struct {
	// Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
	CreatedAt time.Time `json:"createdAt"`
	// Identifier of the user who created the resource.
	CreatedBy string `json:"createdBy"`
	// Last modification timestamp in UTC.
	ModifiedAt time.Time `json:"modifiedAt"`
	// Identifier of the user who last modified the resource.
	ModifiedBy string `json:"modifiedBy"`
	// Identifier of the content item.
	Id string `json:"id"`
	// The name of the content item.
	Name string `json:"name"`
	// Type of the content item. Supported values are:   1. Folder   2. Search   3. Report (for old dashboards)   4. Dashboard (for new dashboards)   5. Lookups
	ItemType string `json:"itemType"`
	// Identifier of the parent content item.
	ParentId string `json:"parentId"`
	// List of permissions the user has on the content item.
	Permissions []string `json:"permissions"`
}

type ContentList added in v0.4.0 

type ContentList struct {
	// A list of the content items.
	Data []Content `json:"data"`
}

type CreateArchiveJobRequest added in v0.7.0 

type CreateArchiveJobRequest struct {
	// The name of the ingestion job.
	Name string `json:"name"`
	// The starting timestamp of the ingestion job.
	StartTime time.Time `json:"startTime"`
	// The ending timestamp of the ingestion job.
	EndTime time.Time `json:"endTime"`
}

type CreateEventHubSourceRequest added in v0.7.0 

type CreateEventHubSourceRequest struct {
	// ApiVersion version of the api
	ApiVersion string `json:"api.version"`
	// Source type of source
	Source EventHubSource `json:"source"`
}

type CreateRoleDefinition added in v0.4.0 

type CreateRoleDefinition struct {
	// Name of the role.
	Name string `json:"name"`
	// Description of the role.
	Description string `json:"description,omitempty"`
	// A search filter to restrict access to specific logs. The filter is silently added to the beginning of each query a user runs. For example, using '!_sourceCategory=billing' as a filter predicate will prevent users assigned to the role from viewing logs from the source category named 'billing'.
	FilterPredicate string `json:"filterPredicate,omitempty"`
	// List of user identifiers to assign the role to.
	Users []string `json:"users,omitempty"`
	// List of [capabilities](https://help.sumologic.com/Manage/Users-and-Roles/Manage-Roles/Role-Capabilities) associated with this role. Valid values are ### Data Management   - viewCollectors   - manageCollectors   - manageBudgets   - manageDataVolumeFeed   - viewFieldExtraction   - manageFieldExtractionRules   - manageS3DataForwarding   - manageContent   - dataVolumeIndex   - viewConnections   - manageConnections   - viewScheduledViews   - manageScheduledViews   - viewPartitions   - managePartitions   - viewFields   - manageFields   - viewAccountOverview   - manageTokens   - manageDataStreams  ### Entity management   - manageEntityTypeConfig  ### Metrics   - manageMonitors   - metricsTransformation   - metricsExtraction   - metricsRules  ### Security   - managePasswordPolicy   - ipAllowlisting   - createAccessKeys   - manageAccessKeys   - manageSupportAccountAccess   - manageAuditDataFeed   - manageSaml   - shareDashboardOutsideOrg   - manageOrgSettings   - changeDataAccessLevel  ### Dashboards   - shareDashboardWorld   - shareDashboardAllowlist  ### UserManagement   - manageUsersAndRoles  ### Observability   - searchAuditIndex   - auditEventIndex  ### Cloud SIEM Enterprise   - viewCse  ### Monitors (New)   - viewMonitorsV2   - manageMonitorsV2
	Capabilities []string `json:"capabilities,omitempty"`
	// Set this to true if you want to automatically append all missing capability requirements. If set to false an error will be thrown if any capabilities are missing their dependencies.
	AutofillDependencies bool `json:"autofillDependencies,omitempty"`
}

type CreateUserDefinition added in v0.6.0 

type CreateUserDefinition struct {
	// First name of the user.
	FirstName string `json:"firstName"`
	// Last name of the user.
	LastName string `json:"lastName"`
	// Email address of the user.
	Email string `json:"email"`
	// List of roleIds associated with the user.
	RoleIds []string `json:"roleIds"`
}

type DisableMfaRequest added in v0.6.0 

type DisableMfaRequest struct {
	// Email of user whose mfa is being disabled.
	Email string `json:"email"`
	// Password of user whose mfa is being disabled.
	Password string `json:"password"`
}

type ErrorDescription 

type ErrorDescription struct {
	// An error code describing the type of error.
	Code string `json:"code"`
	// A short English-language description of the error.
	Message string `json:"message"`
	// An optional fuller English-language description of the error.
	Detail string `json:"detail,omitempty"`
	// An optional list of metadata about the error.
	Meta *interface{} `json:"meta,omitempty"`
}

type ErrorResponse 

type ErrorResponse struct {
	// An identifier for the error; this is unique to the specific API request.
	Id string `json:"id"`
	// A list of one or more causes of the error.
	Errors []ErrorDescription `json:"errors"`
}

type EventHubModel added in v0.7.0 

type EventHubModel struct {
	// Source type of source
	Source EventHubSourceModel `json:"source"`
}

type EventHubSource added in v0.7.0 

type EventHubSource struct {
	// SchemaRef type of source
	SchemaRef EventHubSourceSchema `json:"schemaRef"`
	// Config Event Hub source configuration
	Config EventHubSourceConfigurationDefinition `json:"config"`
	//SourceType type of source (use "Universal")
	SourceType string `json:"sourceType"`
}

type EventHubSourceConfigurationDefinition added in v0.7.0 

type EventHubSourceConfigurationDefinition struct {
	// Name of the source
	Name string `json:"name"`
	// Description of the source
	Description string `json:"description,omitempty"`
	// Namespace Azure Event Hub namespace name
	Namespace string `json:"namespace"`
	// HubName Azure Event Hub name
	HubName string `json:"hub_name"`
	// AccessPolicyName Azure Event Hub Authorization Rule name
	AccessPolicyName string `json:"access_policy_name"`
	// AccessPolicyKey Azure Event Hub Access Key
	AccessPolicyKey string `json:"access_policy_key"`
	// ConsumerGroup specify a custom consumer group name if needed. If you don't need a custom group use "$Default"
	ConsumerGroup string `json:"consumer_group"`
	// Fields to apply to the source
	Fields map[string]string `json:"fields,omitempty"`
	// Category of the source
	Category string `json:"category"`
	// ReceiveWithLatestOffset receive data with the latest offset or from the timestamp
	ReceiveWithLatestOffset bool `json:"receive_with_latest_offset,omitempty"`
	// ReceiveFromTimestamp set to true when ReceiveWithLatestOffset is false
	ReceiveFromTimestamp bool `json:"receive_from_timestamp,omitempty"`
}

type EventHubSourceModel added in v0.7.0 

type EventHubSourceModel struct {
	// Id of source
	Id int `json:"id"`
	// SchemaRef type of source
	SchemaRef EventHubSourceSchema `json:"schemaRef"`
	// Config Event Hub source configuration
	Config EventHubSourceConfigurationDefinition `json:"config"`
	//SourceType type of source ("Universal")
	SourceType string `json:"sourceType"`
	// State of the Event Hub source
	State EventHubSourceStateModel `json:"state"`
}

type EventHubSourceSchema added in v0.7.0 

type EventHubSourceSchema struct {
	// Type of source (use "Azure Event Hubs")
	Type string `json:"type"`
}

type EventHubSourceStateModel added in v0.7.0 

type EventHubSourceStateModel struct {
	// State of the Event Hub source
	State string `json:"state"`
}

type EventHubSourceUpdateDefinition added in v0.7.0 

type EventHubSourceUpdateDefinition struct {
	// Name of the source
	Name string `json:"name"`
	// Description of the source
	Description string `json:"description,omitempty"`
	// Namespace Azure Event Hub namespace name
	Namespace string `json:"namespace"`
	// HubName Azure Event Hub name
	HubName string `json:"hub_name"`
	// AccessPolicyName Azure Event Hub Authorization Rule name
	AccessPolicyName string `json:"access_policy_name"`
	// AccessPolicyKey Azure Event Hub Access Key
	AccessPolicyKey string `json:"access_policy_key"`
	// ConsumerGroup specify a custom consumer group name if needed. If you don't need a custom group use "$Default"
	ConsumerGroup string `json:"consumer_group"`
	// Fields to apply to the source
	Fields map[string]string `json:"fields,omitempty"`
	// Category of the source
	Category string `json:"category"`
	// ReceiveWithLatestOffset receive data with the latest offset or from the timestamp
	ReceiveWithLatestOffset bool `json:"receive_with_latest_offset,omitempty"`
	// ReceiveFromTimestamp set to true when ReceiveWithLatestOffset is false
	ReceiveFromTimestamp bool `json:"receive_from_timestamp,omitempty"`
}

type EventHubSourceUpdateModel added in v0.7.0 

type EventHubSourceUpdateModel struct {
	// Id of the source
	Id int `json:"id"`
	// SchemaRef type of source
	SchemaRef EventHubSourceSchema `json:"schemaRef"`
	// Config Event Hub source configuration
	Config EventHubSourceUpdateDefinition `json:"config"`
	//SourceType type of source (use "Universal")
	SourceType string `json:"sourceType"`
}

type Folder added in v0.3.0 

type Folder struct {
	// Identifier of the content item.
	Id string `json:"id"`
	// The name of the content item.
	Name string `json:"name"`
	// Type of the content item. Supported values are:   1. Folder   2. Search   3. Report (for old dashboards)   4. Dashboard (for new dashboards)   5. Lookups
	ItemType string `json:"itemType"`
	// Identifier of the parent content item.
	ParentId string `json:"parentId"`
	// List of permissions the user has on the content item.
	Permissions []string `json:"permissions"`
	// The description of the folder.
	Description string `json:"description,omitempty"`
	// A list of the content items.
	Children []Content `json:"children,omitempty"`
}

type FolderDefinition added in v0.4.0 

type FolderDefinition struct {
	// The name of the folder.
	Name string `json:"name"`
	// The description of the folder.
	Description string `json:"description,omitempty"`
	// The identifier of the parent folder.
	ParentId string `json:"parentId"`
}

type FolderManagementApiCreateFolderOpts added in v0.4.0 

type FolderManagementApiCreateFolderOpts struct {
	IsAdminMode optional.String
}

type FolderManagementApiGetAdminRecommendedFolderAsyncOpts added in v0.4.0 

type FolderManagementApiGetAdminRecommendedFolderAsyncOpts struct {
	IsAdminMode optional.String
}

type FolderManagementApiGetFolderOpts added in v0.4.0 

type FolderManagementApiGetFolderOpts struct {
	IsAdminMode optional.String
}

type FolderManagementApiGetGlobalFolderAsyncOpts added in v0.4.0 

type FolderManagementApiGetGlobalFolderAsyncOpts struct {
	IsAdminMode optional.String
}

type FolderManagementApiUpdateFolderOpts added in v0.4.0 

type FolderManagementApiUpdateFolderOpts struct {
	IsAdminMode optional.String
}

type ListAccessKeysResult added in v0.5.0 

type ListAccessKeysResult struct {
	// An array of access keys.
	Data []AccessKeyPublic `json:"data"`
}

type ListAppsResult added in v0.7.0 

type ListAppsResult struct {
	// An array of Apps
	Apps []App `json:"apps"`
}

type ListArchiveJobsCount added in v0.7.0 

type ListArchiveJobsCount struct {
	// List of archive sources with count of jobs having various statuses.
	Data []ArchiveJobsCount `json:"data"`
}

type ListArchiveJobsResponse added in v0.7.0 

type ListArchiveJobsResponse struct {
	// List of Archive Jobs.
	Data []ArchiveJob `json:"data"`
	// Next continuation token.
	Next string `json:"next,omitempty"`
}

type ListRoleModelsResponse added in v0.4.0 

type ListRoleModelsResponse struct {
	// List of roles.
	Data []RoleModel `json:"data"`
	// Next continuation token.
	Next string `json:"next,omitempty"`
}

type ListRolesOpts added in v0.4.0 

type ListRolesOpts struct {
	Limit  optional.Int32
	Token  optional.String
	SortBy optional.String
	Name   optional.String
}

type ListTokensBaseResponse added in v0.7.0 

type ListTokensBaseResponse struct {
	// List of tokens.
	Data []TokenBaseResponse `json:"data"`
}

type ListUserModelsResponse added in v0.6.0 

type ListUserModelsResponse struct {
	// List of users.
	Data []UserModel `json:"data"`
	// Next continuation token.
	Next string `json:"next,omitempty"`
}

type PaginatedListAccessKeysResult added in v0.5.0 

type PaginatedListAccessKeysResult struct {
	// An array of access keys.
	Data []AccessKeyPublic `json:"data"`
	// Next continuation token.
	Next string `json:"next,omitempty"`
}

type RoleModel 

type RoleModel struct {
	// Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
	CreatedAt time.Time `json:"createdAt"`
	// Identifier of the user who created the resource.
	CreatedBy string `json:"createdBy"`
	// Last modification timestamp in UTC.
	ModifiedAt time.Time `json:"modifiedAt"`
	// Identifier of the user who last modified the resource.
	ModifiedBy string `json:"modifiedBy"`
	// Name of the role.
	Name string `json:"name"`
	// Description of the role.
	Description string `json:"description,omitempty"`
	// A search filter to restrict access to specific logs. The filter is silently added to the beginning of each query a user runs. For example, using '!_sourceCategory=billing' as a filter predicate will prevent users assigned to the role from viewing logs from the source category named 'billing'.
	FilterPredicate string `json:"filterPredicate,omitempty"`
	// List of user identifiers to assign the role to.
	Users []string `json:"users,omitempty"`
	// List of [capabilities](https://help.sumologic.com/Manage/Users-and-Roles/Manage-Roles/Role-Capabilities) associated with this role. Valid values are ### Data Management   - viewCollectors   - manageCollectors   - manageBudgets   - manageDataVolumeFeed   - viewFieldExtraction   - manageFieldExtractionRules   - manageS3DataForwarding   - manageContent   - dataVolumeIndex   - viewConnections   - manageConnections   - viewScheduledViews   - manageScheduledViews   - viewPartitions   - managePartitions   - viewFields   - manageFields   - viewAccountOverview   - manageTokens   - manageDataStreams  ### Entity management   - manageEntityTypeConfig  ### Metrics   - manageMonitors   - metricsTransformation   - metricsExtraction   - metricsRules  ### Security   - managePasswordPolicy   - ipAllowlisting   - createAccessKeys   - manageAccessKeys   - manageSupportAccountAccess   - manageAuditDataFeed   - manageSaml   - shareDashboardOutsideOrg   - manageOrgSettings   - changeDataAccessLevel  ### Dashboards   - shareDashboardWorld   - shareDashboardAllowlist  ### UserManagement   - manageUsersAndRoles  ### Observability   - searchAuditIndex   - auditEventIndex  ### Cloud SIEM Enterprise   - viewCse  ### Monitors (New)   - viewMonitorsV2   - manageMonitorsV2
	Capabilities []string `json:"capabilities,omitempty"`
	// Set this to true if you want to automatically append all missing capability requirements. If set to false an error will be thrown if any capabilities are missing their dependencies.
	AutofillDependencies bool `json:"autofillDependencies,omitempty"`
	// Unique identifier for the role.
	Id string `json:"id"`
	// Role is system or user defined.
	SystemDefined bool `json:"systemDefined,omitempty"`
}

type ServiceManifestDataSourceParameter added in v0.7.0 

type ServiceManifestDataSourceParameter struct {
	// Parameter type.
	ParameterType string `json:"parameterType"`
	// Parameter identifier.
	ParameterId string `json:"parameterId"`
	// Data source type.
	DataSourceType string `json:"dataSourceType,omitempty"`
	// Label.
	Label string `json:"label,omitempty"`
	// Description.
	Description string `json:"description,omitempty"`
	// Example.
	Example string `json:"example,omitempty"`
	// Should the UI display?
	Hidden bool `json:"hidden,omitempty"`
}

type SubdomainDefinitionResponse added in v0.6.0 

type SubdomainDefinitionResponse struct {
	// Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
	CreatedAt time.Time `json:"createdAt"`
	// Identifier of the user who created the resource.
	CreatedBy string `json:"createdBy"`
	// Last modification timestamp in UTC.
	ModifiedAt time.Time `json:"modifiedAt"`
	// Identifier of the user who last modified the resource.
	ModifiedBy string `json:"modifiedBy"`
	// The new subdomain.
	Subdomain string `json:"subdomain"`
	// Login URL corresponding to the subdomain.
	Url string `json:"url"`
}

type TokenBaseDefinition added in v0.7.0 

type TokenBaseDefinition struct {
	// Name of the token.
	Name string `json:"name"`
	// Description of the token.
	Description string `json:"description,omitempty"`
	// Status of the token. Can be `Active`, or `Inactive`.
	Status string `json:"status"`
	// Type of the token. Valid values: 1) CollectorRegistration
	Type_ string `json:"type"`
}

type TokenBaseDefinitionUpdate added in v0.7.0 

type TokenBaseDefinitionUpdate struct {
	// Name of the token.
	Name string `json:"name"`
	// Description of the token.
	Description string `json:"description,omitempty"`
	// Status of the token. Can be `Active`, or `Inactive`.
	Status string `json:"status"`
	// Type of the token. Valid values: 1) CollectorRegistration
	Type_ string `json:"type"`
	// Version of the token.
	Version int64 `json:"version"`
}

type TokenBaseResponse added in v0.7.0 

type TokenBaseResponse struct {
	// Identifier of the token.
	Id string `json:"id"`
	// Name of the token.
	Name string `json:"name"`
	// Description of the token.
	Description string `json:"description"`
	// Status of the token. Can be `Active`, or `Inactive`.
	Status string `json:"status"`
	// Type of the token. Valid values: 1) CollectorRegistrationTokenResponse
	Type_ string `json:"type"`
	// Version of the token.
	Version int64 `json:"version"`
	// Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
	CreatedAt time.Time `json:"createdAt"`
	// Identifier of the user who created the resource.
	CreatedBy string `json:"createdBy"`
	// Last modification timestamp in UTC.
	ModifiedAt time.Time `json:"modifiedAt"`
	// Identifier of the user who last modified the resource.
	ModifiedBy string `json:"modifiedBy"`
}

type UpdateEventHubSourceRequest added in v0.7.0 

type UpdateEventHubSourceRequest struct {
	// Source type of source
	Source EventHubSourceUpdateModel `json:"source"`
}

type UpdateFolderRequest added in v0.4.0 

type UpdateFolderRequest struct {
	// The name of the folder.
	Name string `json:"name"`
	// The description of the folder.
	Description string `json:"description,omitempty"`
}

type UpdateRoleDefinition added in v0.4.0 

type UpdateRoleDefinition struct {
	// Name of the role.
	Name string `json:"name"`
	// Description of the role.
	Description string `json:"description"`
	// A search filter to restrict access to specific logs. The filter is silently added to the beginning of each query a user runs. For example, using '!_sourceCategory=billing' as a filter predicate will prevent users assigned to the role from viewing logs from the source category named 'billing'.
	FilterPredicate string `json:"filterPredicate"`
	// List of user identifiers to assign the role to.
	Users []string `json:"users"`
	// List of [capabilities](https://help.sumologic.com/Manage/Users-and-Roles/Manage-Roles/Role-Capabilities) associated with this role. Valid values are ### Data Management   - viewCollectors   - manageCollectors   - manageBudgets   - manageDataVolumeFeed   - viewFieldExtraction   - manageFieldExtractionRules   - manageS3DataForwarding   - manageContent   - dataVolumeIndex   - viewConnections   - manageConnections   - viewScheduledViews   - manageScheduledViews   - viewPartitions   - managePartitions   - viewFields   - manageFields   - viewAccountOverview   - manageTokens   - manageDataStreams  ### Entity management   - manageEntityTypeConfig  ### Metrics   - manageMonitors   - metricsTransformation   - metricsExtraction   - metricsRules  ### Security   - managePasswordPolicy   - ipAllowlisting   - createAccessKeys   - manageAccessKeys   - manageSupportAccountAccess   - manageAuditDataFeed   - manageSaml   - shareDashboardOutsideOrg   - manageOrgSettings   - changeDataAccessLevel  ### Dashboards   - shareDashboardWorld   - shareDashboardAllowlist  ### UserManagement   - manageUsersAndRoles  ### Observability   - searchAuditIndex   - auditEventIndex  ### Cloud SIEM Enterprise   - viewCse  ### Monitors (New)   - viewMonitorsV2   - manageMonitorsV2
	Capabilities []string `json:"capabilities"`
	// Set this to true if you want to automatically append all missing capability requirements. If set to false an error will be thrown if any capabilities are missing their dependencies.
	AutofillDependencies bool `json:"autofillDependencies,omitempty"`
}

type UpdateUserDefinition added in v0.6.0 

type UpdateUserDefinition struct {
	// First name of the user.
	FirstName string `json:"firstName"`
	// Last name of the user.
	LastName string `json:"lastName"`
	// This has the value `true` if the user is active and `false` if they have been deactivated.
	IsActive bool `json:"isActive"`
	// List of role identifiers associated with the user.
	RoleIds []string `json:"roleIds"`
}

type UserManagementApiDeleteUserOpts added in v0.6.0 

type UserManagementApiDeleteUserOpts struct {
	TransferTo optional.String
}

type UserManagementApiListUsersOpts added in v0.6.0 

type UserManagementApiListUsersOpts struct {
	Limit  optional.Int32
	Token  optional.String
	SortBy optional.String
	Email  optional.String
}

type UserModel added in v0.6.0 

type UserModel struct {
	// Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
	CreatedAt time.Time `json:"createdAt"`
	// Identifier of the user who created the resource.
	CreatedBy string `json:"createdBy"`
	// Last modification timestamp in UTC.
	ModifiedAt time.Time `json:"modifiedAt"`
	// Identifier of the user who last modified the resource.
	ModifiedBy string `json:"modifiedBy"`
	// First name of the user.
	FirstName string `json:"firstName"`
	// Last name of the user.
	LastName string `json:"lastName"`
	// Email address of the user.
	Email string `json:"email"`
	// List of roleIds associated with the user.
	RoleIds []string `json:"roleIds"`
	// Unique identifier for the user.
	Id string `json:"id"`
	// True if the user is active.
	IsActive bool `json:"isActive,omitempty"`
	// This has the value `true` if the user's account has been locked. If a user tries to log into their account several times and fails, his or her account will be locked for security reasons.
	IsLocked bool `json:"isLocked,omitempty"`
	// True if multi factor authentication is enabled for the user.
	IsMfaEnabled bool `json:"isMfaEnabled,omitempty"`
	// Timestamp of the last login for the user in UTC. Will be null if the user has never logged in.
	LastLoginTimestamp time.Time `json:"lastLoginTimestamp,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.