-
Notifications
You must be signed in to change notification settings - Fork 228
OneLogin (C2C) #5645
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
OneLogin (C2C) #5645
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
5c687d4
OneLogin (C2C)
amee-sumo 0bcdad3
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 16eb8c7
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 7a16cb2
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 6e82d75
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 5dac7ec
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo a78030c
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 95e777d
Merge branch 'main' into OneLogin-(c2c)
amee-sumo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| title: OneLogin Source (Collection) | ||
| image: https://help.sumologic.com/img/reuse/rss-image.jpg | ||
| keywords: | ||
| - c2c | ||
| - onelogin-source | ||
| hide_table_of_contents: true | ||
| --- | ||
|
|
||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| We're excited to announce the release of our new cloud-to-cloud source for OneLogin. This source aims to collect the user list logs from the OneLogin API and send it to Sumo Logic for streamlined analysis. [Learn more](/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/onelogin-source). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
101 changes: 101 additions & 0 deletions
101
...-data/hosted-collectors/cloud-to-cloud-integration-framework/onelogin-source.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| --- | ||
| id: onelogin-source | ||
| title: OneLogin Source | ||
| sidebar_label: OneLogin | ||
| tags: | ||
| - cloud-to-cloud | ||
| - onelogin-source | ||
| description: Learn how to collect the users list from the OneLogin API and send it to Sumo Logic. | ||
| --- | ||
|
|
||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| <img src={useBaseUrl('/img/platform-services/automation-service/app-central/logos/onelogin.png')} alt="logo" width="100" /> | ||
|
|
||
| OneLogin is a leading identity and access management (IAM) provider that offers secure, centralized access to applications and devices through single sign-on (SSO) and multi-factor authentication (MFA). Its cloud-based platform integrates with a wide range of applications, simplifying IT operations, enhancing security, and supporting compliance. OneLogin also provides tools for provisioning, lifecycle management, and directory synchronization to streamline user administration. | ||
|
|
||
| ## Data collected | ||
|
|
||
| The data will be collected from OneLogin database using the following log: | ||
amee-sumo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| | Polling Interval | Data | | ||
| | :--- | :--- | | ||
| | 24 hours | [Users List](https://developers.onelogin.com/api-docs/2/users/list-users) | | ||
|
|
||
| ## Setup | ||
|
|
||
| ### Vendor configuration | ||
|
|
||
| The OneLogin source requires you to provide the **Account URL**, **Client ID**, and **Client Secret** to set up the integration. | ||
|
|
||
| #### Sub Domain | ||
amee-sumo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| The Sub Domain is the account URL used to retrieve the source data from the OneLogin API. For example, `https://{subdomain}.onelogin.com`. | ||
| [Learn more](https://developers.onelogin.com/api-docs/2/getting-started/dev-overview) to obtain the sub domain URL. | ||
amee-sumo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
amee-sumo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| #### Client ID and Client Secret | ||
|
|
||
| To generate the Client Id and Client Secret, see [Creating an API Credential Pair](https://developers.onelogin.com/api-docs/2/getting-started/working-with-api-credentials). | ||
amee-sumo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Once you have all the required values, set up the source configuration to collect your desired log types available in the configuration section. | ||
|
|
||
| ### Source configuration | ||
|
|
||
| When you create a OneLogin 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 [Configure a Hosted Collector and Source](/docs/send-data/hosted-collectors/configure-hosted-collector). | ||
|
|
||
| To configure a OneLogin source: | ||
| 1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**. | ||
| 1. On the Collection page, click **Add Source** next to a Hosted Collector. | ||
| 1. Search for and select **OneLogin**. | ||
| 1. Enter a **Name** for the Source. The description is optional. | ||
| 1. (Optional) For **Source Category**, enter any string to tag the output collected from the source. Category metadata is stored in a searchable field called `_sourceCategory`. | ||
| 1. (Optional) **Fields**. Click the **+Add** button to 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 in the Fields table schema. | ||
| *  An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped. | ||
amee-sumo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 1. **Sub Domain**. Enter your [sub domain URL](#vendor-configuration). | ||
amee-sumo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
jpipkin1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 1. **Client ID**. Enter your [Client ID](#vendor-configuration). | ||
| 1. **Client Secret**. Enter your [Client Secret](#vendor-configuration). | ||
amee-sumo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 1. **Polling Interval**. The polling interval is set for 24 hours by default and can be configured from a minimum of 1 hour to a maximum of 24 hours. You can adjust it based on your needs. This sets how often the source checks for new data. | ||
| 1. **Processing Rules for Logs**. Configure any desired filters, such as allowlist, denylist, hash, or mask, as described in [Create a Processing Rule](/docs/send-data/collection/processing-rules/create-processing-rule). | ||
| 1. When you are finished configuring the source, click **Save**. | ||
|
|
||
| ## JSON schema | ||
|
|
||
| Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See [Use JSON to Configure Sources](/docs/send-data/use-json-configure-sources) for details. | ||
|
|
||
| | Parameter | Type | Value | Required | Description | | ||
| |:--|:--|:--|:--|:--| | ||
| | schemaRef | JSON Object | `{“type”: “OneLogin”}` | Yes | Define the specific schema type. | | ||
| | sourceType | String | `"Universal"` | Yes | Type of source. | | ||
| | config | JSON Object | [Configuration object](#configuration-object) | Yes | Source type specific values. | | ||
|
|
||
| ### Configuration Object | ||
|
|
||
| | Parameter | Type | Required | Default | Description | Example | | ||
| |:--|:--|:--|:--|:--|:--| | ||
| | name | String | Yes | `null` | Type a desired name of the source. The name must be unique per Collector. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_source`. | `"mySource"` | | ||
| | description | String | No | `null` | Type a description of the source. | `"Testing source"` | | ||
| | category | String | No | `null` | Type a category of the source. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_sourceCategory`. See [best practices](/docs/send-data/best-practices) for details. | `"mySource/test"` | ||
| | fields | JSON Object | No | `null` | JSON map of key-value fields (metadata) to apply to the Collector or source. Use the boolean field _siemForward to enable forwarding to SIEM.|`{"_siemForward": false, "fieldA": "valueA"}` | | ||
| | subDomain | String | Yes | `null` | The base URL to fetch the data from the OneLogin API. | `https://{subdomain}.onelogin.com` | | ||
| | clientId | String | Yes | `null` | The client identifier of your account. | | | ||
| | clientSecret | String | Yes | `null` | The client secret of your account. | | | ||
| | pollingInterval | Integer | Yes | `24 hours` | Time interval (in hours) after which the source will check for new data. | | | ||
|
|
||
| ### JSON example | ||
|
|
||
| ```json reference | ||
| https://github.com/SumoLogic/sumologic-documentation/blob/main/static/files/c2c/onelogin/example.json | ||
| ``` | ||
|
|
||
| ### Terraform example | ||
|
|
||
| ```sh reference | ||
| https://github.com/SumoLogic/sumologic-documentation/blob/main/static/files/c2c/onelogin/example.tf | ||
| ``` | ||
|
|
||
| ## FAQ | ||
|
|
||
| :::info | ||
| Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources. | ||
| ::: | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| { | ||
| "api.version": "v1", | ||
| "source": { | ||
| "config": { | ||
| "name": "OneLogin", | ||
| "subDomain": "xyz", | ||
| "clientId": "eRF12xxxR6ixxxjh1WSsqA", | ||
| "clientSecret": "452852c1xxe95eec3xxxx849fd956052ff212dcf6cbxxxdbdb208ef737290", | ||
| "pollingIntervalHour": 24 | ||
| }, | ||
| "schemaRef": { | ||
| "type": "OneLogin" | ||
| }, | ||
| "sourceType": "Universal" | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| resource "sumologic_cloud_to_cloud_source" "onelogin-source" { | ||
| collector_id = sumologic_collector.collector.id | ||
| schema_ref = { | ||
| type = "OneLogin" | ||
| } | ||
| config = jsonencode({ | ||
| "name": "OneLogin", | ||
| "subDomain": "xyz", | ||
| "clientId": "eRF12xxxR6ixxxjh1WSsqA", | ||
| "clientSecret": "452852c1xxe95eec3xxxx849fd956052ff212dcf6cbxxxdbdb208ef737290", | ||
| "pollingIntervalHour": 24 | ||
| }) | ||
| } | ||
| resource "sumologic_collector" "collector" { | ||
| name = "my-collector" | ||
| description = "Just testing this" | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.