The 1Password Source provides a secure endpoint to receive Sign-in Attempts, Item Usage, and Audit Events from the 1Password Event API. It securely stores the required authentication, scheduling, and state tracking information.
The 1Password Source ingests:
- Sign-in Attempts: Collects information about sign-in attempts, that include the name and IP address of the user who attempted to sign in to the account.
- Item Usage: Collects information about items in shared vaults that have been modified, accessed, or used.
- Audit Events: Collects information about the audit events.
- JSON is the only supported log format.
- Data is collected in five minute intervals.
You'll need a 1Password API token and your customer-specific 1Password domain (for example,
events.1password.com). To generate a 1Password API token, follow these steps:
- Sign in to your 1Password account and click Integrations in the sidebar.
- Switch to the Directory tab (or use this direct link to the Directory tab).
- Go to the Events Reporting section and click the Sumo Logic integration.
- In the System Name field, enter the name of your choice (default value
Sumo Logicshould be fine in most cases), then click Add Integration.
- In the Set up token section:
- Enter a Token Name. This can be any string that will help you recognize tokens generated for different environments like production, staging, and dev.
- Under Events to Report, leave enabled event sources which you want to share using the token.
- When you're done, click Issue Token.
- In the Save token section, click the copy icon (next to the token string) to copy it to your clipboard. You can also click Save in 1Password to store it for your future reference.
- Lastly, click View Integration Details to see the summary, then click Learn More pointing to 1Password App installation manual.
A 1Password Source tracks errors, reports its health, and start-up progress. You’re informed, in real-time, if the Source is having trouble connecting, if there's an error requiring user action, or if it is healthy and collecting by utilizing Health Events.
A 1Password Source goes through the following states when created:
- Pending. Once the Source is submitted, it is validated, stored, and placed in a Pending state.
- Started. A collection task is created on the Hosted Collector.
- Initialized. The task configuration is complete in Sumo Logic.
- Authenticated. The Source successfully authenticated with 1Password.
- Collecting. The Source is actively collecting data from 1Password.
If the Source has any issues during any one of these states, it is placed in an Error state.
When you delete the Source, it is placed in a Stopping state. When it has successfully stopped, it is deleted from your Hosted Collector.
On the Collection page, the Health and Status for Sources is displayed. Use Health Events to investigate issues with collection. You can click the text in the Health column, such as Error, to open the issue in Health Events to investigate.
Hover your mouse over the status icon to view a tooltip with details on the detected issue.
Create a 1Password Source
When you create a 1Password Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Create a Hosted Collector.
To configure a 1Password Source:
- In Sumo Logic, select Manage Data > Collection > Collection.
- On the Collectors page, click Add Source next to a Hosted** **Collector.
- Select 1Password.
- Enter a Name for the Source. The description is optional.
- (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called
- Forward to SIEM. Check the checkbox to forward your data to Cloud SIEM Enterprise. When configured with the Forward to SIEM option, the following metadata fields are set:
- (Optional) Fields. Click the +Add link to add custom log metadata Fields.
- Define the fields you want to associate, each field needs a name (key) and value.
- A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema.
- An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo that does not exist in the Fields schema or is disabled it is ignored, known as dropped.
- Define the fields you want to associate, each field needs a name (key) and value.
- Base URL. Provide your 1Password customer-specific domain, for example
- API Token. Enter the token you got from creating your 1Password API token in the Authentication section above.
- Supported APIs to collect. Select one or more of the available APIs, Item Usage and Sign-in Attempts.
- When you are finished configuring the Source, click Submit.
When Sumo Logic detects an issue it is tracked by Health Events. The following table shows the three possible error types, the reason the error would occur, if the Source attempts to retry, and the name of the event log in the Health Event Index.
|Type||Reason||Retries||Retry Behavior||Health Event Name|
|ThirdPartyConfig||Normally due to an invalid configuration. You'll need to review your Source configuration and make an update.||No retries are attempted until the Source is updated.||Not applicable||ThirdPartyConfigError|
|ThirdPartyGeneric||Normally due to an error communicating with the third party service APIs.||Yes||The Source will retry for up to 90 minutes, after which it quits.||ThirdPartyGenericError|
|FirstPartyGeneric||Normally due to an error communicating with the internal Sumo Logic APIs.||Yes||The Source will retry for up to 90 minutes, after which it quits.||FirstPartyGenericError|
Restarting your Source
If your Source encounters ThirdPartyConfig errors, you can restart it from either the Sumo Logic UI or Sumo Logic API.
To restart your source in the Sumo Logic platform, follow the steps below:
- Open the Collection page, and go to Manage Data > Collection > Collection.
- Select the source and click the information icon on the right side of the row.
- The API usage information popup is displayed. Click the Restart Source button on the bottom left.
- Click Confirm to send the restart request.
- The bottom left of the platform will provide a notification informing you the request was successful.
To restart your source using the Sumo Management API, follow the instructions below:
- Example endpoint:
Sumo Logic endpoints like
api.sumologic.com are different in deployments outside
us1. For example, an API endpoint in Europe would begin
api.eu.sumologic.com. A service endpoint in
us2 (Western U.S.) would begin
service.us2.sumologic.com. For more information, see Sumo Logic Endpoints.
Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See how to use JSON to configure Sources for details.
|config||JSON Object||Yes||Contains the [configuration parameters](#config-parameters) for the Source.|
|schemaRef||JSON Object||Yes||Use ||not modifiable|
|sourceType||String||Yes||Use ||not modifiable|
The following table shows the config parameters for a 1Password Source.
|name||String||Yes||Type a desired name of the Source. The name must be unique per Collector. This value is assigned to the metadata field ||modifiable|
|description||String||No||null||Type a description of the Source.||modifiable|
|category||String||No||null||Type a category of the source. This value is assigned to the metadata field field ||modifiable|
|fields||JSON Object||No||JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field ||modifiable|
|base_url||String||Yes||Provide your 1Password customer-specific domain, such as, ||modifiable|
|api_token||String||Yes||Provide the 1Password API token you want to use to authenticate collection requests.||modifiable|
|supported_apis||Array of strings||Yes||Define one or more of the available APIs to collect: |
For example, for both you'd use:
1Password Source JSON example:
After configuring your Source, you should check the status of the source in the Collectors page > Status column. If the Source is not functioning as expected, you may see an error next to the Source Category column as shown below:
To resolve these errors:
- Make sure the Base URL matches your domain.
- Make sure correct API Token is used to configure the source.
- If you're still seeing the
401 Unauthorized errorin the Status column, regenerate the API Token by following these Authentication steps and then updating the API Token for the source.