|
| 1 | +--- |
| 2 | +id: onelogin-source |
| 3 | +title: OneLogin Source |
| 4 | +sidebar_label: OneLogin |
| 5 | +tags: |
| 6 | + - cloud-to-cloud |
| 7 | + - onelogin-source |
| 8 | +description: Learn how to collect the users list from the OneLogin API and send it to Sumo Logic. |
| 9 | +--- |
| 10 | + |
| 11 | +import useBaseUrl from '@docusaurus/useBaseUrl'; |
| 12 | + |
| 13 | +<img src={useBaseUrl('/img/platform-services/automation-service/app-central/logos/onelogin.png')} alt="logo" width="100" /> |
| 14 | + |
| 15 | +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. |
| 16 | + |
| 17 | +## Data collected |
| 18 | + |
| 19 | +The data will be collected from the OneLogin database using the following log: |
| 20 | + |
| 21 | +| Polling Interval | Data | |
| 22 | +| :--- | :--- | |
| 23 | +| 24 hours | [Users List](https://developers.onelogin.com/api-docs/2/users/list-users) | |
| 24 | + |
| 25 | +## Setup |
| 26 | + |
| 27 | +### Vendor configuration |
| 28 | + |
| 29 | +The OneLogin source requires you to provide the **Account URL**, **Client ID**, and **Client Secret** to set up the integration. |
| 30 | + |
| 31 | +#### Subdomain |
| 32 | + |
| 33 | +The subdomain 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 subdomain URL. |
| 34 | + |
| 35 | +#### Client ID and client secret |
| 36 | + |
| 37 | +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). |
| 38 | + |
| 39 | +Once you have all the required values, set up the source configuration to collect your desired log types available in the configuration section. |
| 40 | + |
| 41 | +### Source configuration |
| 42 | + |
| 43 | +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). |
| 44 | + |
| 45 | +To configure a OneLogin source: |
| 46 | +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**. |
| 47 | +1. On the Collection page, click **Add Source** next to a Hosted Collector. |
| 48 | +1. Search for and select **OneLogin**. |
| 49 | +1. Enter a **Name** for the Source. The description is optional. |
| 50 | +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`. |
| 51 | +1. (Optional) **Fields**. Click the **+Add** button to define the fields you want to associate. Each field needs a name (key) and value. |
| 52 | + *  A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema. |
| 53 | + *  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, you'll see an option to automatically add or enable the nonexistent fields to the Fields table schema. If a field is sent to Sumo Logic but isn’t present or enabled in the schema, it’s ignored and marked as **Dropped**. |
| 54 | +1. **Sub Domain**. Enter your [subdomain URL](#vendor-configuration). |
| 55 | +1. **Client ID**. Enter your [client ID](#vendor-configuration). |
| 56 | +1. **Client Secret**. Enter your [client secret](#vendor-configuration). |
| 57 | +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. |
| 58 | +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). |
| 59 | +1. When you are finished configuring the source, click **Save**. |
| 60 | + |
| 61 | +## JSON schema |
| 62 | + |
| 63 | +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. |
| 64 | + |
| 65 | +| Parameter | Type | Value | Required | Description | |
| 66 | +|:--|:--|:--|:--|:--| |
| 67 | +| schemaRef | JSON Object | `{“type”: “OneLogin”}` | Yes | Define the specific schema type. | |
| 68 | +| sourceType | String | `"Universal"` | Yes | Type of source. | |
| 69 | +| config | JSON Object | [Configuration object](#configuration-object) | Yes | Source type specific values. | |
| 70 | + |
| 71 | +### Configuration Object |
| 72 | + |
| 73 | +| Parameter | Type | Required | Default | Description | Example | |
| 74 | +|:--|:--|:--|:--|:--|:--| |
| 75 | +| 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"` | |
| 76 | +| description | String | No | `null` | Type a description of the source. | `"Testing source"` | |
| 77 | +| 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"` |
| 78 | +| 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"}` | |
| 79 | +| subDomain | String | Yes | `null` | The base URL to fetch the data from the OneLogin API. | `https://{subdomain}.onelogin.com` | |
| 80 | +| clientId | String | Yes | `null` | The client identifier of your account. | | |
| 81 | +| clientSecret | String | Yes | `null` | The client secret of your account. | | |
| 82 | +| pollingInterval | Integer | Yes | `24 hours` | Time interval (in hours) after which the source will check for new data. | | |
| 83 | + |
| 84 | +### JSON example |
| 85 | + |
| 86 | +```json reference |
| 87 | +https://github.com/SumoLogic/sumologic-documentation/blob/main/static/files/c2c/onelogin/example.json |
| 88 | +``` |
| 89 | + |
| 90 | +### Terraform example |
| 91 | + |
| 92 | +```sh reference |
| 93 | +https://github.com/SumoLogic/sumologic-documentation/blob/main/static/files/c2c/onelogin/example.tf |
| 94 | +``` |
| 95 | + |
| 96 | +## FAQ |
| 97 | + |
| 98 | +:::info |
| 99 | +Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources. |
| 100 | +::: |
0 commit comments