Skip to content
Dashboard
Theme
Theme

Retrieve the identity provider and directory source catalogue

GET /v1/providers: Retrieve the identity provider and directory source catalogue.

View Markdown

GET /v1/providers

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.

Scope
connections:read
Auth
Secret key (sk_…)
Since
1.0
  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

Errors share one shape; see the error code catalogue.

curl -X GET \
"https://api.ohauthcat.com/v1/providers" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY"
Response 200
{
"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
}
]
}