# Retrieve the identity provider and directory source catalogue

<div class="api-op" data-api-operation>
<div class="api-op__main">

<p class="api-endpoint"><span class="method method-get">GET</span> <code>/v1/providers</code></p>

Named identity providers and directory sources with their setup presets (protocols, metadata and issuer URL patterns, attribute name defaults, discovery hosts and known quirks). A preset is setup help only; every value it suggests is validated like a hand-entered one, and a name never attests a vendor, issuer or host. Directory sources not offered for new directories are left out; each directory source carries `availability` in this environment (`coming_soon` sources refuse new directories with `provider_coming_soon`). `google` is Google Workspace SCIM push from Google's custom SCIM profiles beta (people only, no groups, only Workspaces admitted to Google's beta); `google_admin_sdk` (Connect Google) is the recommended Google Workspace source and syncs people and groups.

<dl class="api-facts"><div><dt>Scope</dt><dd><code>connections:read</code></dd></div><div><dt>Auth</dt><dd>Secret key (<code>sk_…</code>)</dd></div><div><dt>Since</dt><dd>1.0</dd></div></dl>

## Headers

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">OhAuthCat-Version</code> <span class="api-field__type">string</span></p>
Minor version; defaults to the environment's pin.
</li>
</ul>

## Responses

<ul class="api-responses">
<li class="api-response"><span class="api-status api-status--ok">200</span> <span>OK <span class="api-field__type">ProviderCatalogue</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">401</span> <span>Codes: <a href="/errors/authentication_required/">authentication_required</a>, <a href="/errors/api_key_invalid/">api_key_invalid</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">403</span> <span>Codes: <a href="/errors/api_key_scope_missing/">api_key_scope_missing</a>, <a href="/errors/ip_not_allowed/">ip_not_allowed</a>, <a href="/errors/plan_limit_reached/">plan_limit_reached</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">429</span> <span>Code: <a href="/errors/rate_limited/">rate_limited</a>. Retry-After is set. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">503</span> <span>Code: <a href="/errors/service_unavailable/">service_unavailable</a>. Retry-After is set; writes are paused. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--neutral">default</span> <span>Any other error, including <a href="/errors/internal_error/">internal_error</a>. Every code is in the error catalogue. <span class="api-field__type">Error</span></span></li>
</ul>

Errors share one shape; see the [error code catalogue](/errors/).

</div>
<div class="api-op__code">

**curl**

```sh wrap
curl -X GET \
  "https://api.ohauthcat.com/v1/providers" \
  -H "Authorization: Bearer $OHAUTHCAT_API_KEY"
```

**Node**

```javascript wrap
const response = await fetch("https://api.ohauthcat.com/v1/providers", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`,
  },
});
const data = await response.json();
```

**Python**

```python wrap
import os
import requests

response = requests.get(
    "https://api.ohauthcat.com/v1/providers",
    headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},
)
data = response.json()
```

```json title="Response 200" wrap
{
  "object": "provider_catalogue",
  "sso": [
    {
      "id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
      "name": "Acme Corp",
      "portal_idp": "okta",
      "protocols": ["saml"],
      "saml": {
        "metadata_url_pattern": "example_metadata_url_pattern",
        "name_id_format": "example_name_id_format",
        "attributes": {
          "email": "jane@acme.com",
          "first_name": "Jane",
          "last_name": "Doe",
          "groups": "example_groups"
        }
      },
      "oidc": {
        "issuer_pattern": "example_issuer_pattern",
        "client_auth": ["client_secret_basic"],
        "scopes": ["organizations:read"],
        "acr_values": ["enterprise"],
        "claims": {
          "email": "jane@acme.com",
          "first_name": "Jane",
          "last_name": "Doe",
          "groups": "example_groups"
        }
      },
      "discovery_hosts": ["example_discovery_host"],
      "quirks": ["example_quirk"]
    }
  ],
  "directories": [
    {
      "id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
      "name": "Acme Corp",
      "portal_idp": "okta",
      "source": "scim",
      "quirks": ["example_quirk"],
      "availability": "available",
      "interested": true
    }
  ]
}
```

</div>
</div>
