IBM API Connect · Schema

ConfiguredOauthProvider

API GatewayAPI ManagementDeveloper PortalDeveloper ToolsIBM

Properties

Name Type Description
type string
api_version string
id string
name string
title string
summary string
scope string
oauth_provider_url string
owned boolean
debug boolean
provider_type string
scopes objectnull
grants array
gateway_version string
advanced_scope object
native_provider object
third_party_config object
user_registry_urls array
jwt_provider_urls array
tls_client_profile_urls array
configured_gateway_service_urls array
api_urls array
product_urls array
space_urls array
org_url string
catalog_url string
space_url string
metadata object
created_at string
updated_at string
url string
View JSON Schema on GitHub

JSON Schema

ibm-api-connect-configured-oauth-provider-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-configured-oauth-provider-schema.json",
  "title": "ConfiguredOauthProvider",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ibm-api-connect-catalog-settings-api-openapi.yml#/components/schemas/ConfiguredOauthProvider",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "type": {
      "type": "string",
      "readOnly": true,
      "enum": [
        "configured_oauth_provider"
      ]
    },
    "api_version": {
      "type": "string",
      "readOnly": true,
      "enum": [
        "2.0.0"
      ]
    },
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "maxLength": 255
    },
    "title": {
      "type": "string",
      "maxLength": 1023
    },
    "summary": {
      "type": "string",
      "maxLength": 65535
    },
    "scope": {
      "type": "string"
    },
    "oauth_provider_url": {
      "type": "string",
      "format": "uri"
    },
    "owned": {
      "type": "boolean"
    },
    "debug": {
      "type": "boolean"
    },
    "provider_type": {
      "type": "string",
      "enum": [
        "native",
        "third_party"
      ]
    },
    "scopes": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": "string"
      }
    },
    "grants": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "access_code",
          "application",
          "password",
          "implicit",
          "jwt"
        ]
      }
    },
    "gateway_version": {
      "type": "string",
      "enum": [
        "5000",
        "6000",
        "12000",
        "13000"
      ]
    },
    "advanced_scope": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "override_endpoint_from_api": {
          "type": "boolean"
        },
        "default_validator_endpoint": {
          "type": [
            "object",
            "null"
          ],
          "additionalProperties": false,
          "required": [
            "endpoint"
          ],
          "properties": {
            "endpoint": {
              "type": "string"
            },
            "tls_client_profile_url": {
              "type": [
                "string",
                "null"
              ],
              "format": "uri"
            }
          }
        },
        "request_query": {
          "type": "string"
        },
        "request_headers_regex": {
          "type": "string"
        },
        "response_headers_regex": {
          "type": "string"
        },
        "advanced_scope_12000": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "default_validator_endpoint": {
              "type": [
                "object",
                "null"
              ],
              "additionalProperties": false,
              "required": [
                "endpoint"
              ],
              "properties": {
                "endpoint": {
                  "type": "string"
                },
                "tls_client_profile_url": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "uri"
                },
                "version": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "enum": [
                    "HTTP/1.0",
                    "HTTP/1.1",
                    "HTTP/2"
                  ]
                },
                "timeout": {
                  "type": [
                    "integer",
                    "null"
                  ]
                },
                "persistent_connections": {
                  "type": "boolean"
                },
                "compress_request": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "enum": [
                    "br",
                    "gzip",
                    "deflate",
                    "none"
                  ]
                },
                "decompress_response": {
                  "type": "boolean"
                },
                "chunked_upload": {
                  "type": "boolean"
                },
                "follow_redirects": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      }
    },
    "native_provider": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "api": {
          "$ref": "#/$defs/OAI3"
        },
        "default_scopes": {
          "type": [
            "string",
            "null"
          ]
        },
        "authorize_path": {
          "type": "string"
        },
        "token_path": {
          "type": "string"
        },
        "token_secret": {
          "type": [
            "object",
            "null"
          ],
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string"
            },
            "key": {
              "type": "string"
            }
          }
        },
        "clients": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "confidential",
              "public"
            ]
          }
        },
        "access_code_ttl": {
          "type": "integer",
          "minimum": 1,
          "maximum": 600
        },
        "access_token_ttl": {
          "type": "integer",
          "minimum": 0,
          "maximum": 2147483647
        },
        "access_token_one_time_use": {
          "type": "boolean"
        },
        "maximum_consent_ttl": {
          "type": "integer",
          "minimum": 0,
          "maximum": 2147483647
        },
        "refresh_token": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "count": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            },
            "ttl": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            },
            "one_time_use": {
              "type": "boolean"
            }
          }
        },
        "revocation": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "type": {
              "type": "string",
              "enum": [
                "native",
                "third_party"
              ]
            },
            "resource_owner_revocation_path": {
              "type": "string"
            },
            "client_revocation_path": {
              "type": "string"
            },
            "third_party_endpoint": {
              "type": [
                "object",
                "null"
              ],
              "additionalProperties": false,
              "required": [
                "endpoint"
              ],
              "properties": {
                "endpoint": {
                  "type": "string"
                },
                "tls_client_profile_url": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "uri"
                }
              }
            },
            "application_revocation": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "enabled": {
                  "type": "boolean"
                },
                "apprevoke_path": {
                  "type": "string"
                }
              }
            },
            "third_party_security": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "basic-auth"
                ]
              }
            },
            "basic_auth": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "username": {
                  "type": "string"
                },
                "password": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "request_headername": {
                  "type": "string"
                }
              }
            },
            "custom_headername_format": {
              "type": "string"
            },
            "third_party_cache_type": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "no-cache",
                  "protocol",
                  "time-to-live"
                ]
              }
            },
            "third_party_revocation_protocol": {
              "type": "string",
              "items": {
                "type": "string",
                "enum": [
                  "XML",
                  "JSON"
                ]
              }
            },
            "time_to_live": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "cache_ttl": {
                  "type": "integer"
                }
              }
            },
            "third_party_fail_on_error": {
              "type": "boolean",
              "default": true
            },
            "owner_revocation": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "enabled": {
                  "type": "boolean"
                },
                "owner_revoke_path": {
                  "type": "string"
                }
              }
            }
          }
        },
        "token_introspection": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "introspection_path": {
              "type": "string"
            }
          }
        },
        "token_metadata": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "source": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "external_url",
                  "authentication_url"
                ]
              }
            },
            "external_endpoint": {
              "type": [
                "object",
                "null"
              ],
              "additionalProperties": false,
              "required": [
                "endpoint"
              ],
              "properties": {
                "endpoint": {
                  "type": "string"
                },
                "tls_client_profile_url": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "uri"
                }
              }
            },
            "header_name_token": {
              "type": "string"
            },
            "header_name_payload": {
              "type": "string"
            }
          }
        },
        "openid_connect": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "discovery_path": {
              "type": [
                "string",
                "null"
              ]
            },
            "supported_response_types": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "code_id_token",
                  "code_access_token",
                  "code_id_token_access_token"
                ]
              }
            }
          }
        },
        "pkce": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "required": {
              "type": "boolean"
            },
            "allow_plain": {
              "type": "boolean"
            }
          }
        },
        "advanced_scope_security": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "mode": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "basic-auth"
                ]
              }
            },
            "basic_auth": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "request_headername": {
                  "type": "string"
                },
                "username": {
                  "type": "string"
                },
                "password": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              }
            }
          }
        },
        "native_provider_5000": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "identity_extraction": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "basic",
                    "default_form",
                    "custom_form",
                    "redirect"
                  ]
                },
                "redirect_endpoint": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "custom_form_endpoint": {
                  "$ref": "#/$defs/SecuredEndpoint"
                }
              }
            },
            "authentication": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "user_registry_url": {
                  "type": "string",
                  "format": "uri"
                }
              }
            },
            "authorization": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "default_form",
                    "custom_form",
                    "authenticated"
                  ]
                },
                "custom_form_endpoint": {
                  "$ref": "#/$defs/SecuredEndpoint"
                }
              }
            },
            "scope_validators": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "application_endpoint": {
                  "$ref": "#/$defs/SecuredEndpoint"
                },
                "owner_endpoint": {
                  "$ref": "#/$defs/SecuredEndpoint"
                }
              }
            }
          }
        }
      }
    },
    "third_party_config": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "token_validation_requirement": {
          "type": "string",
          "enum": [
            "connected",
            "active",
            "custom"
          ]
        },
        "authorize_endpoint": {
          "type": "string"
        },
        "token_endpoint": {
          "type": "string"
        },
        "introspection_endpoint": {
          "type": [
            "object",
            "null"
          ],
          "additionalProperties": false,
          "required": [
            "endpoint"
          ],
          "properties": {
            "endpoint": {
              "type": "string"
            },
            "tls_client_profile_url": {
              "type": [
                "string",
                "null"
              ],
              "format": "uri"
            }
          }
        },
        "security": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "basic-auth"
            ]
          }
        },
        "basic_auth": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "request_headername": {
              "type": [
                "string",
                "null"
              ]
            },
            "username": {
              "type": "string"
            },
            "password": {
              "type": [
                "string",
                "null"
              ]
            }
          }
        },
        "custom_headername_format": {
          "type": "string"
        },
        "advanced_scope_security": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "mode": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "basic-auth"
                ]
              }
            },
            "basic_auth": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "request_headername": {
                  "type": "string"
                },
                "username": {
                  "type": "string"
                },
                "password": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              }
            }
          }
        },
        "auth_header_pass_thru": {
          "type": "boolean",
          "default": false
        },
        "introspect_cache_type": {
          "type": "string",
          "default": "no-cache",
          "enum": [
            "no-cache",
            "protocol",
            "time-to-live"
          ]
        },
        "introspect_cache_ttl": {
          "type": "integer"
        },
        "third_party_config_12000": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "oauth_specification": {
              "type": "string",
              "enum": [
                "oauth2.0",
                "oauth2.1"
              ]
            },
            "jwt_provider_url": {
              "type": "string",
              "format": "uri"
            },
            "introspection_endpoint": {
              "type": [
                "object",
                "null"
              ],
              "additionalProperties": false,
              "required": [
                "endpoint"
              ],
              "properties": {
                "endpoint": {
                  "type": "string"
                },
                "security": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "basic-auth"
                    ]
                  }
                },
                "basic_auth": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "body_credentials": {
                      "type": [
                        "object",
                        "null"
                      ],
                      "additionalProperties": false,
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "secret": {
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      }
                    },
                    "username": {
                      "type": "string"
                    },
                    "password": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  }
                },
                "tls_client_profile_url": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "uri"
                },
                "version": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "enum": [
                    "HTTP/1.0",
                    "HTTP/1.1",
                    "HTTP/2"
                  ]
                },
                "timeout": {
                  "type": [
                    "integer",
                    "null"
                  ]
                },
                "persistent_connections": {
                  "type": "boolean"
                },
                "compress_request": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "enum": [
                    "br",
                    "gzip",
                    "deflate",
                    "none"
                  ]
                },
                "decompress_response": {
                  "type": "boolean"
                },
                "chunked_upload": {
                  "type": "boolean"
                },
                "follow_redirects": {
                  "type": "boolean"
                }
              }
            }
          }
        },
        "third_party_config_13000": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "introspection_mode": {
              "type": "string",
              "enum": [
                "remote",
                "local"
              ]
            },
            "remote_introspection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "gateway_user": {
                  "type": "string"
                }
              }
            },
            "local_introspection": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "issuer": {
                  "type": "string"
                },
                "jwks_uri": {
                  "type": "string"
                },
                "use_local_clock_skew": {
                  "type": "boolean"
                },
                "clock_skew_in_seconds": {
                  "type": "integer"
                }
              }
            },
            "token_generator": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "access_token_exp_interval": {
                  "type": "integer"
                },
                "auth_code_exp_interval": {
                  "type": "integer"
                },
                "expiry": {
                  "type": "integer"
                },
                "enforce_pkce": {
                  "type": "boolean"
                },
                "algorithm": {
                  "type": "string"
                }
              }
            },
            "refresh_token_url": {
              "type": "string"
            },
            "dcr": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "provider_name": {
                  "type": "string"
                },
                "endpoint": {
                  "type": "string"
                },
                "endpoint_headers": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  }
                },
                "auth_type": {
                  "type": "string",
                  "enum": [
                    "basic",
                    "token",
                    "refresh_token",
                    "client_credentials",
                    "none"
                  ]
                },
                "username": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "password": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "token": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "token_type": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "client_id": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "client_secret": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "scope": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              }
            }
          }
        }
      }
    },
    "user_registry_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      }
    },
    "jwt_provider_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      }
    },
    "tls_client_profile_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      }
    },
    "configured_gateway_service_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      }
    },
    "api_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      }
    },
    "product_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      }
    },
    "space_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      }
    },
    "org_url": {
      "type": "string",
      "format": "uri"
    },
    "catalog_url": {
      "type": "string",
      "format": "uri"
    },
    "space_url": {
      "type": "string",
      "format": "uri"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "format": "uri"
    }
  },
  "$defs": {
    "OAI3": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": true
    },
    "SecuredEndpoint": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "required": [
        "endpoint"
      ],
      "properties": {
        "endpoint": {
          "type": "string",
          "format": "uri"
        },
        "tls_client_profile_url": {
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/ibm-api-connect-configured-oauth-provider"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.