# User Directory

Pulls user data from Okta, including metadata for authentication and identity correlation.purposes.

**Sync Type: Full Synchronisation**

## Authentication

This input supports API Key and OAuth 2.0 (service app) authentication. See [Okta Authentication](./okta-auth) for setup instructions and required credentials for each method.

> **Note:** When using OAuth 2.0, ensure the `okta.users.read` scope is granted on your service app.

## Details
Monad uses the `cron` field to run this input on specific intervals and returns all users' details, performing a full sync of data each time.

## Configuration

The following configuration defines the input parameters. Each field's specifications, such as type, requirements, and descriptions, are detailed below. If using the Oauth flow, the token should be granted the ```okta.users.read``` scope.

#### Settings

| Setting | Type | Required | Description |
|---------|------|----------|-------------|
| Org URL | string | Yes | Your Okta Organization URL. |
| Cron | string | Yes | A cron expression defining how often to fetch user data. |
| API Rate Limit | object | No | Optional limit on the connector's outbound request rate to the source API. Leave blank to use the connector's default behavior. See [API Rate Limiting](../../../guides/rate-limiting) for the field format, limits, and how to choose a value. |

#### Secrets

Secrets vary by authentication method. See [Okta Authentication](./okta-auth) for details.

## Custom Schema Handling

If the source data doesn't align with any of the [OpenSecurityControlFramework (OSCF) schemas](https://schema.ocsf.io/), you can create a custom transformation using our JQ transform pipeline. For example:

```jq
{
  metadata: {
    schema_version: "1.0.0",
    custom_framework: "my_framework"
  },
  controls: .[]
}
```

For more information on JQ and how to write your own JQ transformations see the JQ docs [here](https://jqlang.github.io/jq/).

If you believe this data source should be included in the standard OSCF schema set, please reach out to our team at [support@monad.com](mailto:support@monad.com). We're always looking to expand our coverage of security control frameworks based on community needs.


## Related Articles
- [https://help.okta.com/en-us/content/topics/security/api.htm](https://help.okta.com/en-us/content/topics/security/api.htm)
- [https://developer.okta.com/docs/reference/api/users/](https://developer.okta.com/docs/reference/api/users/)
## Sample Record

```json
{
  "id": "f5c19356-b090-1832-e1be-f248b98902ae",
  "status": "DEPROVISIONED",
  "created": "2025-08-11T23:46:51.092762Z",
  "activated": "2025-08-11T23:46:51.092768Z",
  "statusChanged": "2025-08-11T23:46:51.092769Z",
  "lastLogin": "2025-08-11T23:46:51.09277Z",
  "lastUpdated": "2025-08-11T23:46:51.092772Z",
  "passwordChanged": "2025-08-11T23:46:51.092773Z",
  "profile": {
    "firstName": "John",
    "lastName": "Brown",
    "email": "john.smith@example.com",
    "login": "bob.williams@example.com",
    "mobilePhone": "555-987-6543"
  },
  "credentials": {
    "password": {},
    "recovery_question": {
      "question": "Who's a major player in the cowboy scene?"
    },
    "provider": {
      "type": "OKTA",
      "name": "OKTA"
    }
  },
  "_links": {
    "self": {
      "href": "https://{yourOktaDomain}/api/v1/users/92ccd869-05ce-0066-0ad9-ab6f8262417b"
    }
  }
}
```