Getting Started
Everything you need to get up and running with OSDU at Equinor.
| Step | Guide |
|---|---|
| 1. Get platform access | Getting Access to the OSDU Platform → |
| 2. Get data access | Getting Access to Data → |
| 3. Pick your tools | Interacting with OSDU → |
1. Get platform access
Before you can do anything on OSDU, you need platform access. This lets you call APIs and use services.
When does this apply?
You log in with your own Equinor account — including apps that use user impersonation (e.g. OSDU CLI, Python SDK with interactive login). Your personal identity is what ADME checks for access. This is the recommended starting point for most users.
Read access — lets you call OSDU API services, search for records, query metadata, and retrieve data:
| Environment | How |
|---|---|
| Dev | Automatic — you already have it through Entra ID |
| Test | Automatic — you already have it through Entra ID |
| Prod | Apply via AccessIT (step-by-step guide) |
Write access — lets you ingest, update, or delete data:
| Environment | How |
|---|---|
| Dev | Apply via AccessIT (step-by-step guide) |
| Test | Apply via AccessIT (step-by-step guide) |
| Prod | Apply via AccessIT (step-by-step guide) |
See Getting Access to the OSDU Platform for the full guide. Already have access? Pick your tools to start connecting.
When does this apply?
Your application authenticates with its own identity (client credentials) — e.g. automated scripts, pipelines, or backend services. ADME checks the app's service principal for access.
Your app needs an app registration in Microsoft Entra ID with a client_id and client_secret.
Read access — lets your app call OSDU API services, search for records, query metadata, and retrieve data:
| Environment | How |
|---|---|
| Dev | Apply via ServiceNow |
| Test | Apply via ServiceNow |
| Prod | Apply via ServiceNow |
Write access — lets your app ingest, update, or delete data:
| Environment | How |
|---|---|
| Dev | Apply via ServiceNow |
| Test | Apply via ServiceNow |
| Prod | Apply via ServiceNow |
See Getting Access to the OSDU Platform for the full guide.
2. Get data access
Platform access alone doesn't give you access to data. Each dataset is protected by its own access group.
When does this apply?
This applies if your app uses user impersonation to connect to ADME (e.g. OSDU CLI, Python SDK with interactive login). ADME resolves your personal identity against data office group memberships. This applies to most users.
- Apply via AccessIT for the data you need
See Getting Access to Data for the full guide.
When does this apply?
Your application authenticates with its own identity (client credentials). ADME checks the app's service principal against data office group memberships.
Apps need data access too. Contact the team that manages the data you need and ask them to add your app registration to the appropriate access group.
See Getting Access to Data for the full guide.
3. Pick your tools
Choose the tool that fits your workflow:
| Tool | Best for |
|---|---|
| OSDU CLI | Interactive exploration, quick queries, admin tasks |
| Python SDK | Scripts, notebooks, lightweight automation |
| Raw HTTP | Full control from any language — pipelines, CI/CD |
| OPUS | Visual exploration of SMDA data |
See Interacting with OSDU for setup instructions and examples.
After completing these steps you can
- Connect to OSDU services and call APIs
- Read and query data you have access to
- Ingest or modify data (if you have write access)
- Use the CLI, Python SDK, or raw HTTP to automate workflows
Next steps
- Searching for Data — run your first query
- FAQ — common questions answered