@modelcontextprotocol/sdk
    Preparing search index...

    Function discoverOAuthMetadata

    • Looks up RFC 8414 OAuth 2.0 Authorization Server Metadata.

      If the server returns a 404 for the well-known endpoint, this function will return undefined. Any other errors will be thrown as exceptions.

      Parameters

      • issuer: string | URL
      • __namedParameters: { authorizationServerUrl?: string | URL; protocolVersion?: string } = {}
      • fetchFn: FetchLike = fetch

      Returns Promise<
          | objectOutputType<
              {
                  authorization_endpoint: ZodEffects<
                      ZodEffects<ZodString, string, string>,
                      string,
                      string,
                  >;
                  code_challenge_methods_supported: ZodOptional<
                      ZodArray<ZodString, "many">,
                  >;
                  grant_types_supported: ZodOptional<ZodArray<ZodString, "many">>;
                  introspection_endpoint: ZodOptional<ZodString>;
                  introspection_endpoint_auth_methods_supported: ZodOptional<
                      ZodArray<ZodString, "many">,
                  >;
                  introspection_endpoint_auth_signing_alg_values_supported: ZodOptional<
                      ZodArray<ZodString, "many">,
                  >;
                  issuer: ZodString;
                  registration_endpoint: ZodOptional<
                      ZodEffects<ZodEffects<ZodString, string, string>, string, string>,
                  >;
                  response_modes_supported: ZodOptional<ZodArray<ZodString, "many">>;
                  response_types_supported: ZodArray<ZodString, "many">;
                  revocation_endpoint: ZodOptional<
                      ZodEffects<ZodEffects<ZodString, string, string>, string, string>,
                  >;
                  revocation_endpoint_auth_methods_supported: ZodOptional<
                      ZodArray<ZodString, "many">,
                  >;
                  revocation_endpoint_auth_signing_alg_values_supported: ZodOptional<
                      ZodArray<ZodString, "many">,
                  >;
                  scopes_supported: ZodOptional<ZodArray<ZodString, "many">>;
                  service_documentation: ZodOptional<
                      ZodEffects<ZodEffects<ZodString, string, string>, string, string>,
                  >;
                  token_endpoint: ZodEffects<
                      ZodEffects<ZodString, string, string>,
                      string,
                      string,
                  >;
                  token_endpoint_auth_methods_supported: ZodOptional<
                      ZodArray<ZodString, "many">,
                  >;
                  token_endpoint_auth_signing_alg_values_supported: ZodOptional<
                      ZodArray<ZodString, "many">,
                  >;
              },
              ZodTypeAny,
              "passthrough",
          >
          | undefined,
      >

      This function is deprecated in favor of discoverAuthorizationServerMetadata.

    Settings

    Member Visibility