github.com/icyphox/x@v0.0.355-0.20220311094250-029bd783e8b8/jsonschemax/.snapshots/TestListPaths-case=0.json (about) 1 [ 2 { 3 "Title": "Access Rules", 4 "Description": "Configure access rules. All sub-keys support configuration reloading without restarting.", 5 "Examples": null, 6 "Name": "access_rules", 7 "Default": null, 8 "Type": {}, 9 "TypeHint": 5, 10 "Format": "", 11 "Pattern": null, 12 "Enum": null, 13 "Constant": null, 14 "ReadOnly": false, 15 "MinLength": -1, 16 "MaxLength": -1, 17 "Required": false, 18 "Minimum": null, 19 "Maximum": null, 20 "MultipleOf": null, 21 "CustomProperties": null 22 }, 23 { 24 "Title": "Repositories", 25 "Description": "Locations (list of URLs) where access rules should be fetched from on boot. It is expected that the documents at those locations return a JSON or YAML Array containing ORY Oathkeeper Access Rules:\n\n- If the URL Scheme is `file://`, the access rules (an array of access rules is expected) will be fetched from the local file system.\n- If the URL Scheme is `inline://`, the access rules (an array of access rules is expected) are expected to be a base64 encoded (with padding!) JSON/YAML string (base64_encode(`[{\"id\":\"foo-rule\",\"authenticators\":[....]}]`)).\n- If the URL Scheme is `http://` or `https://`, the access rules (an array of access rules is expected) will be fetched from the provided HTTP(s) location.", 26 "Examples": [ 27 "[\"file://path/to/rules.json\",\"inline://W3siaWQiOiJmb28tcnVsZSIsImF1dGhlbnRpY2F0b3JzIjpbXX1d\",\"https://path-to-my-rules/rules.json\"]" 28 ], 29 "Name": "access_rules.repositories", 30 "Default": null, 31 "Type": [], 32 "TypeHint": 8, 33 "Format": "", 34 "Pattern": null, 35 "Enum": null, 36 "Constant": null, 37 "ReadOnly": false, 38 "MinLength": -1, 39 "MaxLength": -1, 40 "Required": false, 41 "Minimum": null, 42 "Maximum": null, 43 "MultipleOf": null, 44 "CustomProperties": null 45 }, 46 { 47 "Title": "", 48 "Description": "", 49 "Examples": null, 50 "Name": "access_rules.repositories.#", 51 "Default": null, 52 "Type": "", 53 "TypeHint": 1, 54 "Format": "uri", 55 "Pattern": null, 56 "Enum": null, 57 "Constant": null, 58 "ReadOnly": false, 59 "MinLength": -1, 60 "MaxLength": -1, 61 "Required": false, 62 "Minimum": null, 63 "Maximum": null, 64 "MultipleOf": null, 65 "CustomProperties": null 66 }, 67 { 68 "Title": "Authenticators", 69 "Description": "For more information on authenticators head over to: https://www.ory.sh/docs/oathkeeper/pipeline/authn", 70 "Examples": null, 71 "Name": "authenticators", 72 "Default": null, 73 "Type": {}, 74 "TypeHint": 5, 75 "Format": "", 76 "Pattern": null, 77 "Enum": null, 78 "Constant": null, 79 "ReadOnly": false, 80 "MinLength": -1, 81 "MaxLength": -1, 82 "Required": false, 83 "Minimum": null, 84 "Maximum": null, 85 "MultipleOf": null, 86 "CustomProperties": null 87 }, 88 { 89 "Title": "Anonymous", 90 "Description": "The [`anonymous` authenticator](https://www.ory.sh/docs/oathkeeper/pipeline/authn#anonymous).", 91 "Examples": null, 92 "Name": "authenticators.anonymous", 93 "Default": null, 94 "Type": {}, 95 "TypeHint": 5, 96 "Format": "", 97 "Pattern": null, 98 "Enum": null, 99 "Constant": null, 100 "ReadOnly": false, 101 "MinLength": -1, 102 "MaxLength": -1, 103 "Required": false, 104 "Minimum": null, 105 "Maximum": null, 106 "MultipleOf": null, 107 "CustomProperties": null 108 }, 109 { 110 "Title": "Anonymous Authenticator Configuration", 111 "Description": "This section is optional when the authenticator is disabled.", 112 "Examples": null, 113 "Name": "authenticators.anonymous.config", 114 "Default": null, 115 "Type": {}, 116 "TypeHint": 5, 117 "Format": "", 118 "Pattern": null, 119 "Enum": null, 120 "Constant": null, 121 "ReadOnly": false, 122 "MinLength": -1, 123 "MaxLength": -1, 124 "Required": false, 125 "Minimum": null, 126 "Maximum": null, 127 "MultipleOf": null, 128 "CustomProperties": null 129 }, 130 { 131 "Title": "Anonymous Subject", 132 "Description": "Sets the anonymous username.", 133 "Examples": [ 134 "guest", 135 "anon", 136 "anonymous", 137 "unknown" 138 ], 139 "Name": "authenticators.anonymous.config.subject", 140 "Default": "anonymous", 141 "Type": "", 142 "TypeHint": 1, 143 "Format": "", 144 "Pattern": null, 145 "Enum": null, 146 "Constant": null, 147 "ReadOnly": false, 148 "MinLength": -1, 149 "MaxLength": -1, 150 "Required": false, 151 "Minimum": null, 152 "Maximum": null, 153 "MultipleOf": null, 154 "CustomProperties": null 155 }, 156 { 157 "Title": "Enabled", 158 "Description": "En-/disables this component.", 159 "Examples": [ 160 true 161 ], 162 "Name": "authenticators.anonymous.enabled", 163 "Default": false, 164 "Type": false, 165 "TypeHint": 4, 166 "Format": "", 167 "Pattern": null, 168 "Enum": null, 169 "Constant": null, 170 "ReadOnly": false, 171 "MinLength": -1, 172 "MaxLength": -1, 173 "Required": false, 174 "Minimum": null, 175 "Maximum": null, 176 "MultipleOf": null, 177 "CustomProperties": null 178 }, 179 { 180 "Title": "Cookie Session", 181 "Description": "The [`cookie_session` authenticator](https://www.ory.sh/docs/oathkeeper/pipeline/authn#cookie_session).", 182 "Examples": null, 183 "Name": "authenticators.cookie_session", 184 "Default": null, 185 "Type": {}, 186 "TypeHint": 5, 187 "Format": "", 188 "Pattern": null, 189 "Enum": null, 190 "Constant": null, 191 "ReadOnly": false, 192 "MinLength": -1, 193 "MaxLength": -1, 194 "Required": false, 195 "Minimum": null, 196 "Maximum": null, 197 "MultipleOf": null, 198 "CustomProperties": null 199 }, 200 { 201 "Title": "Cookie Session Authenticator Configuration", 202 "Description": "This section is optional when the authenticator is disabled.", 203 "Examples": null, 204 "Name": "authenticators.cookie_session.config", 205 "Default": null, 206 "Type": {}, 207 "TypeHint": 5, 208 "Format": "", 209 "Pattern": null, 210 "Enum": null, 211 "Constant": null, 212 "ReadOnly": false, 213 "MinLength": -1, 214 "MaxLength": -1, 215 "Required": false, 216 "Minimum": null, 217 "Maximum": null, 218 "MultipleOf": null, 219 "CustomProperties": null 220 }, 221 { 222 "Title": "Session Check URL", 223 "Description": "The origin to proxy requests to. If the response is a 200 with body `{ \"subject\": \"...\", \"extra\": {} }`. The request will pass the subject through successfully, otherwise it will be marked as unauthorized.\n\n\u003eIf this authenticator is enabled, this value is required.", 224 "Examples": [ 225 "https://session-store-host" 226 ], 227 "Name": "authenticators.cookie_session.config.check_session_url", 228 "Default": null, 229 "Type": "", 230 "TypeHint": 1, 231 "Format": "uri", 232 "Pattern": null, 233 "Enum": null, 234 "Constant": null, 235 "ReadOnly": false, 236 "MinLength": -1, 237 "MaxLength": -1, 238 "Required": true, 239 "Minimum": null, 240 "Maximum": null, 241 "MultipleOf": null, 242 "CustomProperties": null 243 }, 244 { 245 "Title": "Only Cookies", 246 "Description": "A list of possible cookies to look for on incoming requests, and will fallthrough to the next authenticator if none of the passed cookies are set on the request.", 247 "Examples": null, 248 "Name": "authenticators.cookie_session.config.only", 249 "Default": null, 250 "Type": [], 251 "TypeHint": 8, 252 "Format": "", 253 "Pattern": null, 254 "Enum": null, 255 "Constant": null, 256 "ReadOnly": false, 257 "MinLength": -1, 258 "MaxLength": -1, 259 "Required": false, 260 "Minimum": null, 261 "Maximum": null, 262 "MultipleOf": null, 263 "CustomProperties": null 264 }, 265 { 266 "Title": "", 267 "Description": "", 268 "Examples": null, 269 "Name": "authenticators.cookie_session.config.only.#", 270 "Default": null, 271 "Type": "", 272 "TypeHint": 1, 273 "Format": "", 274 "Pattern": null, 275 "Enum": null, 276 "Constant": null, 277 "ReadOnly": false, 278 "MinLength": -1, 279 "MaxLength": -1, 280 "Required": false, 281 "Minimum": null, 282 "Maximum": null, 283 "MultipleOf": null, 284 "CustomProperties": null 285 }, 286 { 287 "Title": "Enabled", 288 "Description": "En-/disables this component.", 289 "Examples": [ 290 true 291 ], 292 "Name": "authenticators.cookie_session.enabled", 293 "Default": false, 294 "Type": false, 295 "TypeHint": 4, 296 "Format": "", 297 "Pattern": null, 298 "Enum": null, 299 "Constant": null, 300 "ReadOnly": false, 301 "MinLength": -1, 302 "MaxLength": -1, 303 "Required": false, 304 "Minimum": null, 305 "Maximum": null, 306 "MultipleOf": null, 307 "CustomProperties": null 308 }, 309 { 310 "Title": "JSON Web Token (jwt)", 311 "Description": "The [`jwt` authenticator](https://www.ory.sh/docs/oathkeeper/pipeline/authn#jwt).", 312 "Examples": null, 313 "Name": "authenticators.jwt", 314 "Default": null, 315 "Type": {}, 316 "TypeHint": 5, 317 "Format": "", 318 "Pattern": null, 319 "Enum": null, 320 "Constant": null, 321 "ReadOnly": false, 322 "MinLength": -1, 323 "MaxLength": -1, 324 "Required": false, 325 "Minimum": null, 326 "Maximum": null, 327 "MultipleOf": null, 328 "CustomProperties": null 329 }, 330 { 331 "Title": "JWT Authenticator Configuration", 332 "Description": "This section is optional when the authenticator is disabled.", 333 "Examples": null, 334 "Name": "authenticators.jwt.config", 335 "Default": null, 336 "Type": {}, 337 "TypeHint": 5, 338 "Format": "", 339 "Pattern": null, 340 "Enum": null, 341 "Constant": null, 342 "ReadOnly": false, 343 "MinLength": -1, 344 "MaxLength": -1, 345 "Required": false, 346 "Minimum": null, 347 "Maximum": null, 348 "MultipleOf": null, 349 "CustomProperties": null 350 }, 351 { 352 "Title": "", 353 "Description": "", 354 "Examples": null, 355 "Name": "authenticators.jwt.config.allowed_algorithms", 356 "Default": null, 357 "Type": [], 358 "TypeHint": 8, 359 "Format": "", 360 "Pattern": null, 361 "Enum": null, 362 "Constant": null, 363 "ReadOnly": false, 364 "MinLength": -1, 365 "MaxLength": -1, 366 "Required": false, 367 "Minimum": null, 368 "Maximum": null, 369 "MultipleOf": null, 370 "CustomProperties": null 371 }, 372 { 373 "Title": "", 374 "Description": "", 375 "Examples": null, 376 "Name": "authenticators.jwt.config.allowed_algorithms.#", 377 "Default": null, 378 "Type": "", 379 "TypeHint": 1, 380 "Format": "", 381 "Pattern": null, 382 "Enum": null, 383 "Constant": null, 384 "ReadOnly": false, 385 "MinLength": -1, 386 "MaxLength": -1, 387 "Required": false, 388 "Minimum": null, 389 "Maximum": null, 390 "MultipleOf": null, 391 "CustomProperties": null 392 }, 393 { 394 "Title": "JSON Web Key URLs", 395 "Description": "URLs where ORY Oathkeeper can retrieve JSON Web Keys from for validating the JSON Web Token. Usually something like \"https://my-keys.com/.well-known/jwks.json\". The response of that endpoint must return a JSON Web Key Set (JWKS).\n\n\u003eIf this authenticator is enabled, this value is required.", 396 "Examples": [ 397 "https://my-website.com/.well-known/jwks.json", 398 "https://my-other-website.com/.well-known/jwks.json", 399 "file://path/to/local/jwks.json" 400 ], 401 "Name": "authenticators.jwt.config.jwks_urls", 402 "Default": null, 403 "Type": [], 404 "TypeHint": 8, 405 "Format": "", 406 "Pattern": null, 407 "Enum": null, 408 "Constant": null, 409 "ReadOnly": false, 410 "MinLength": -1, 411 "MaxLength": -1, 412 "Required": true, 413 "Minimum": null, 414 "Maximum": null, 415 "MultipleOf": null, 416 "CustomProperties": null 417 }, 418 { 419 "Title": "", 420 "Description": "", 421 "Examples": null, 422 "Name": "authenticators.jwt.config.jwks_urls.#", 423 "Default": null, 424 "Type": "", 425 "TypeHint": 1, 426 "Format": "uri", 427 "Pattern": null, 428 "Enum": null, 429 "Constant": null, 430 "ReadOnly": false, 431 "MinLength": -1, 432 "MaxLength": -1, 433 "Required": false, 434 "Minimum": null, 435 "Maximum": null, 436 "MultipleOf": null, 437 "CustomProperties": null 438 }, 439 { 440 "Title": "Required Token Scope", 441 "Description": "An array of OAuth 2.0 scopes that are required when accessing an endpoint protected by this handler.\n If the token used in the Authorization header did not request that specific scope, the request is denied.", 442 "Examples": null, 443 "Name": "authenticators.jwt.config.required_scope", 444 "Default": null, 445 "Type": [], 446 "TypeHint": 8, 447 "Format": "", 448 "Pattern": null, 449 "Enum": null, 450 "Constant": null, 451 "ReadOnly": false, 452 "MinLength": -1, 453 "MaxLength": -1, 454 "Required": false, 455 "Minimum": null, 456 "Maximum": null, 457 "MultipleOf": null, 458 "CustomProperties": null 459 }, 460 { 461 "Title": "", 462 "Description": "", 463 "Examples": null, 464 "Name": "authenticators.jwt.config.required_scope.#", 465 "Default": null, 466 "Type": "", 467 "TypeHint": 1, 468 "Format": "", 469 "Pattern": null, 470 "Enum": null, 471 "Constant": null, 472 "ReadOnly": false, 473 "MinLength": -1, 474 "MaxLength": -1, 475 "Required": false, 476 "Minimum": null, 477 "Maximum": null, 478 "MultipleOf": null, 479 "CustomProperties": null 480 }, 481 { 482 "Title": "Scope Strategy", 483 "Description": "Sets the strategy validation algorithm.", 484 "Examples": null, 485 "Name": "authenticators.jwt.config.scope_strategy", 486 "Default": "none", 487 "Type": "", 488 "TypeHint": 1, 489 "Format": "", 490 "Pattern": null, 491 "Enum": [ 492 "hierarchic", 493 "exact", 494 "wildcard", 495 "none" 496 ], 497 "Constant": null, 498 "ReadOnly": false, 499 "MinLength": -1, 500 "MaxLength": -1, 501 "Required": false, 502 "Minimum": null, 503 "Maximum": null, 504 "MultipleOf": null, 505 "CustomProperties": null 506 }, 507 { 508 "Title": "Intended Audience", 509 "Description": "An array of audiences that are required when accessing an endpoint protected by this handler.\n If the token used in the Authorization header is not intended for any of the requested audiences, the request is denied.", 510 "Examples": null, 511 "Name": "authenticators.jwt.config.target_audience", 512 "Default": null, 513 "Type": [], 514 "TypeHint": 8, 515 "Format": "", 516 "Pattern": null, 517 "Enum": null, 518 "Constant": null, 519 "ReadOnly": false, 520 "MinLength": -1, 521 "MaxLength": -1, 522 "Required": false, 523 "Minimum": null, 524 "Maximum": null, 525 "MultipleOf": null, 526 "CustomProperties": null 527 }, 528 { 529 "Title": "", 530 "Description": "", 531 "Examples": null, 532 "Name": "authenticators.jwt.config.target_audience.#", 533 "Default": null, 534 "Type": "", 535 "TypeHint": 1, 536 "Format": "", 537 "Pattern": null, 538 "Enum": null, 539 "Constant": null, 540 "ReadOnly": false, 541 "MinLength": -1, 542 "MaxLength": -1, 543 "Required": false, 544 "Minimum": null, 545 "Maximum": null, 546 "MultipleOf": null, 547 "CustomProperties": null 548 }, 549 { 550 "Title": "", 551 "Description": "", 552 "Examples": null, 553 "Name": "authenticators.jwt.config.token_from", 554 "Default": null, 555 "Type": {}, 556 "TypeHint": 5, 557 "Format": "", 558 "Pattern": null, 559 "Enum": null, 560 "Constant": null, 561 "ReadOnly": false, 562 "MinLength": -1, 563 "MaxLength": -1, 564 "Required": false, 565 "Minimum": null, 566 "Maximum": null, 567 "MultipleOf": null, 568 "CustomProperties": null 569 }, 570 { 571 "Title": "Header", 572 "Description": "The header (case insensitive) that must contain a token for request authentication. It can't be set along with query_parameter.", 573 "Examples": null, 574 "Name": "authenticators.jwt.config.token_from.header", 575 "Default": null, 576 "Type": "", 577 "TypeHint": 1, 578 "Format": "", 579 "Pattern": null, 580 "Enum": null, 581 "Constant": null, 582 "ReadOnly": false, 583 "MinLength": -1, 584 "MaxLength": -1, 585 "Required": true, 586 "Minimum": null, 587 "Maximum": null, 588 "MultipleOf": null, 589 "CustomProperties": null 590 }, 591 { 592 "Title": "Query Parameter", 593 "Description": "The query parameter (case sensitive) that must contain a token for request authentication. It can't be set along with header.", 594 "Examples": null, 595 "Name": "authenticators.jwt.config.token_from.query_parameter", 596 "Default": null, 597 "Type": "", 598 "TypeHint": 1, 599 "Format": "", 600 "Pattern": null, 601 "Enum": null, 602 "Constant": null, 603 "ReadOnly": false, 604 "MinLength": -1, 605 "MaxLength": -1, 606 "Required": true, 607 "Minimum": null, 608 "Maximum": null, 609 "MultipleOf": null, 610 "CustomProperties": null 611 }, 612 { 613 "Title": "", 614 "Description": "", 615 "Examples": null, 616 "Name": "authenticators.jwt.config.trusted_issuers", 617 "Default": null, 618 "Type": [], 619 "TypeHint": 8, 620 "Format": "", 621 "Pattern": null, 622 "Enum": null, 623 "Constant": null, 624 "ReadOnly": false, 625 "MinLength": -1, 626 "MaxLength": -1, 627 "Required": false, 628 "Minimum": null, 629 "Maximum": null, 630 "MultipleOf": null, 631 "CustomProperties": null 632 }, 633 { 634 "Title": "", 635 "Description": "", 636 "Examples": null, 637 "Name": "authenticators.jwt.config.trusted_issuers.#", 638 "Default": null, 639 "Type": "", 640 "TypeHint": 1, 641 "Format": "", 642 "Pattern": null, 643 "Enum": null, 644 "Constant": null, 645 "ReadOnly": false, 646 "MinLength": -1, 647 "MaxLength": -1, 648 "Required": false, 649 "Minimum": null, 650 "Maximum": null, 651 "MultipleOf": null, 652 "CustomProperties": null 653 }, 654 { 655 "Title": "Enabled", 656 "Description": "En-/disables this component.", 657 "Examples": [ 658 true 659 ], 660 "Name": "authenticators.jwt.enabled", 661 "Default": false, 662 "Type": false, 663 "TypeHint": 4, 664 "Format": "", 665 "Pattern": null, 666 "Enum": null, 667 "Constant": null, 668 "ReadOnly": false, 669 "MinLength": -1, 670 "MaxLength": -1, 671 "Required": false, 672 "Minimum": null, 673 "Maximum": null, 674 "MultipleOf": null, 675 "CustomProperties": null 676 }, 677 { 678 "Title": "No Operation (noop)", 679 "Description": "The [`noop` authenticator](https://www.ory.sh/docs/oathkeeper/pipeline/authn#noop).", 680 "Examples": null, 681 "Name": "authenticators.noop", 682 "Default": null, 683 "Type": {}, 684 "TypeHint": 5, 685 "Format": "", 686 "Pattern": null, 687 "Enum": null, 688 "Constant": null, 689 "ReadOnly": false, 690 "MinLength": -1, 691 "MaxLength": -1, 692 "Required": false, 693 "Minimum": null, 694 "Maximum": null, 695 "MultipleOf": null, 696 "CustomProperties": null 697 }, 698 { 699 "Title": "Enabled", 700 "Description": "En-/disables this component.", 701 "Examples": [ 702 true 703 ], 704 "Name": "authenticators.noop.enabled", 705 "Default": false, 706 "Type": false, 707 "TypeHint": 4, 708 "Format": "", 709 "Pattern": null, 710 "Enum": null, 711 "Constant": null, 712 "ReadOnly": false, 713 "MinLength": -1, 714 "MaxLength": -1, 715 "Required": false, 716 "Minimum": null, 717 "Maximum": null, 718 "MultipleOf": null, 719 "CustomProperties": null 720 }, 721 { 722 "Title": "OAuth 2.0 Client Credentials", 723 "Description": "The [`oauth2_client_credentials` authenticator](https://www.ory.sh/docs/oathkeeper/pipeline/authn#oauth2_client_credentials).", 724 "Examples": null, 725 "Name": "authenticators.oauth2_client_credentials", 726 "Default": null, 727 "Type": {}, 728 "TypeHint": 5, 729 "Format": "", 730 "Pattern": null, 731 "Enum": null, 732 "Constant": null, 733 "ReadOnly": false, 734 "MinLength": -1, 735 "MaxLength": -1, 736 "Required": false, 737 "Minimum": null, 738 "Maximum": null, 739 "MultipleOf": null, 740 "CustomProperties": null 741 }, 742 { 743 "Title": "OAuth 2.0 Client Credentials Authenticator Configuration", 744 "Description": "This section is optional when the authenticator is disabled.", 745 "Examples": null, 746 "Name": "authenticators.oauth2_client_credentials.config", 747 "Default": null, 748 "Type": {}, 749 "TypeHint": 5, 750 "Format": "", 751 "Pattern": null, 752 "Enum": null, 753 "Constant": null, 754 "ReadOnly": false, 755 "MinLength": -1, 756 "MaxLength": -1, 757 "Required": false, 758 "Minimum": null, 759 "Maximum": null, 760 "MultipleOf": null, 761 "CustomProperties": null 762 }, 763 { 764 "Title": "Request Permissions (Token Scope)", 765 "Description": "Scopes is an array of OAuth 2.0 scopes that are required when accessing an endpoint protected by this rule.\n If the token used in the Authorization header did not request that specific scope, the request is denied.", 766 "Examples": null, 767 "Name": "authenticators.oauth2_client_credentials.config.required_scope", 768 "Default": null, 769 "Type": [], 770 "TypeHint": 8, 771 "Format": "", 772 "Pattern": null, 773 "Enum": null, 774 "Constant": null, 775 "ReadOnly": false, 776 "MinLength": -1, 777 "MaxLength": -1, 778 "Required": false, 779 "Minimum": null, 780 "Maximum": null, 781 "MultipleOf": null, 782 "CustomProperties": null 783 }, 784 { 785 "Title": "", 786 "Description": "", 787 "Examples": null, 788 "Name": "authenticators.oauth2_client_credentials.config.required_scope.#", 789 "Default": null, 790 "Type": "", 791 "TypeHint": 1, 792 "Format": "", 793 "Pattern": null, 794 "Enum": null, 795 "Constant": null, 796 "ReadOnly": false, 797 "MinLength": -1, 798 "MaxLength": -1, 799 "Required": false, 800 "Minimum": null, 801 "Maximum": null, 802 "MultipleOf": null, 803 "CustomProperties": null 804 }, 805 { 806 "Title": "", 807 "Description": "The OAuth 2.0 Token Endpoint that will be used to validate the client credentials.\n\n\u003eIf this authenticator is enabled, this value is required.", 808 "Examples": [ 809 "https://my-website.com/oauth2/token" 810 ], 811 "Name": "authenticators.oauth2_client_credentials.config.token_url", 812 "Default": null, 813 "Type": "", 814 "TypeHint": 1, 815 "Format": "uri", 816 "Pattern": null, 817 "Enum": null, 818 "Constant": null, 819 "ReadOnly": false, 820 "MinLength": -1, 821 "MaxLength": -1, 822 "Required": true, 823 "Minimum": null, 824 "Maximum": null, 825 "MultipleOf": null, 826 "CustomProperties": null 827 }, 828 { 829 "Title": "Enabled", 830 "Description": "En-/disables this component.", 831 "Examples": [ 832 true 833 ], 834 "Name": "authenticators.oauth2_client_credentials.enabled", 835 "Default": false, 836 "Type": false, 837 "TypeHint": 4, 838 "Format": "", 839 "Pattern": null, 840 "Enum": null, 841 "Constant": null, 842 "ReadOnly": false, 843 "MinLength": -1, 844 "MaxLength": -1, 845 "Required": false, 846 "Minimum": null, 847 "Maximum": null, 848 "MultipleOf": null, 849 "CustomProperties": null 850 }, 851 { 852 "Title": "OAuth 2.0 Token Introspection", 853 "Description": "The [`oauth2_introspection` authenticator](https://www.ory.sh/docs/oathkeeper/pipeline/authn#oauth2_introspection).", 854 "Examples": null, 855 "Name": "authenticators.oauth2_introspection", 856 "Default": null, 857 "Type": {}, 858 "TypeHint": 5, 859 "Format": "", 860 "Pattern": null, 861 "Enum": null, 862 "Constant": null, 863 "ReadOnly": false, 864 "MinLength": -1, 865 "MaxLength": -1, 866 "Required": false, 867 "Minimum": null, 868 "Maximum": null, 869 "MultipleOf": null, 870 "CustomProperties": null 871 }, 872 { 873 "Title": "OAuth 2.0 Introspection Authenticator Configuration", 874 "Description": "This section is optional when the authenticator is disabled.", 875 "Examples": null, 876 "Name": "authenticators.oauth2_introspection.config", 877 "Default": null, 878 "Type": {}, 879 "TypeHint": 5, 880 "Format": "", 881 "Pattern": null, 882 "Enum": null, 883 "Constant": null, 884 "ReadOnly": false, 885 "MinLength": -1, 886 "MaxLength": -1, 887 "Required": false, 888 "Minimum": null, 889 "Maximum": null, 890 "MultipleOf": null, 891 "CustomProperties": null 892 }, 893 { 894 "Title": "OAuth 2.0 Introspection URL", 895 "Description": "The OAuth 2.0 Token Introspection endpoint URL.\n\n\u003eIf this authenticator is enabled, this value is required.", 896 "Examples": [ 897 "https://my-website.com/oauth2/introspection" 898 ], 899 "Name": "authenticators.oauth2_introspection.config.introspection_url", 900 "Default": null, 901 "Type": "", 902 "TypeHint": 1, 903 "Format": "uri", 904 "Pattern": null, 905 "Enum": null, 906 "Constant": null, 907 "ReadOnly": false, 908 "MinLength": -1, 909 "MaxLength": -1, 910 "Required": true, 911 "Minimum": null, 912 "Maximum": null, 913 "MultipleOf": null, 914 "CustomProperties": null 915 }, 916 { 917 "Title": "Pre-Authorization", 918 "Description": "Enable pre-authorization in cases where the OAuth 2.0 Token Introspection endpoint is protected by OAuth 2.0 Bearer Tokens that can be retrieved using the OAuth 2.0 Client Credentials grant.", 919 "Examples": null, 920 "Name": "authenticators.oauth2_introspection.config.pre_authorization", 921 "Default": null, 922 "Type": {}, 923 "TypeHint": 5, 924 "Format": "", 925 "Pattern": null, 926 "Enum": null, 927 "Constant": null, 928 "ReadOnly": false, 929 "MinLength": -1, 930 "MaxLength": -1, 931 "Required": false, 932 "Minimum": null, 933 "Maximum": null, 934 "MultipleOf": null, 935 "CustomProperties": null 936 }, 937 { 938 "Title": "OAuth 2.0 Client ID", 939 "Description": "The OAuth 2.0 Client ID to be used for the OAuth 2.0 Client Credentials Grant.\n\n\u003eIf pre-authorization is enabled, this value is required.", 940 "Examples": null, 941 "Name": "authenticators.oauth2_introspection.config.pre_authorization.client_id", 942 "Default": null, 943 "Type": "", 944 "TypeHint": 1, 945 "Format": "", 946 "Pattern": null, 947 "Enum": null, 948 "Constant": null, 949 "ReadOnly": false, 950 "MinLength": -1, 951 "MaxLength": -1, 952 "Required": true, 953 "Minimum": null, 954 "Maximum": null, 955 "MultipleOf": null, 956 "CustomProperties": null 957 }, 958 { 959 "Title": "OAuth 2.0 Client Secret", 960 "Description": "The OAuth 2.0 Client Secret to be used for the OAuth 2.0 Client Credentials Grant.\n\n\u003eIf pre-authorization is enabled, this value is required.", 961 "Examples": null, 962 "Name": "authenticators.oauth2_introspection.config.pre_authorization.client_secret", 963 "Default": null, 964 "Type": "", 965 "TypeHint": 1, 966 "Format": "", 967 "Pattern": null, 968 "Enum": null, 969 "Constant": null, 970 "ReadOnly": false, 971 "MinLength": -1, 972 "MaxLength": -1, 973 "Required": true, 974 "Minimum": null, 975 "Maximum": null, 976 "MultipleOf": null, 977 "CustomProperties": null 978 }, 979 { 980 "Title": "", 981 "Description": "", 982 "Examples": null, 983 "Name": "authenticators.oauth2_introspection.config.pre_authorization.enabled", 984 "Default": null, 985 "Type": false, 986 "TypeHint": 4, 987 "Format": "", 988 "Pattern": null, 989 "Enum": null, 990 "Constant": [ 991 true 992 ], 993 "ReadOnly": false, 994 "MinLength": -1, 995 "MaxLength": -1, 996 "Required": false, 997 "Minimum": null, 998 "Maximum": null, 999 "MultipleOf": null, 1000 "CustomProperties": null 1001 }, 1002 { 1003 "Title": "OAuth 2.0 Scope", 1004 "Description": "The OAuth 2.0 Scope to be requested during the OAuth 2.0 Client Credentials Grant.", 1005 "Examples": [ 1006 [ 1007 "[\"foo\", \"bar\"]" 1008 ] 1009 ], 1010 "Name": "authenticators.oauth2_introspection.config.pre_authorization.scope", 1011 "Default": null, 1012 "Type": [], 1013 "TypeHint": 8, 1014 "Format": "", 1015 "Pattern": null, 1016 "Enum": null, 1017 "Constant": null, 1018 "ReadOnly": false, 1019 "MinLength": -1, 1020 "MaxLength": -1, 1021 "Required": false, 1022 "Minimum": null, 1023 "Maximum": null, 1024 "MultipleOf": null, 1025 "CustomProperties": null 1026 }, 1027 { 1028 "Title": "", 1029 "Description": "", 1030 "Examples": null, 1031 "Name": "authenticators.oauth2_introspection.config.pre_authorization.scope.#", 1032 "Default": null, 1033 "Type": "", 1034 "TypeHint": 1, 1035 "Format": "", 1036 "Pattern": null, 1037 "Enum": null, 1038 "Constant": null, 1039 "ReadOnly": false, 1040 "MinLength": -1, 1041 "MaxLength": -1, 1042 "Required": false, 1043 "Minimum": null, 1044 "Maximum": null, 1045 "MultipleOf": null, 1046 "CustomProperties": null 1047 }, 1048 { 1049 "Title": "OAuth 2.0 Token URL", 1050 "Description": "The OAuth 2.0 Token Endpoint where the OAuth 2.0 Client Credentials Grant will be performed.\n\n\u003eIf pre-authorization is enabled, this value is required.", 1051 "Examples": null, 1052 "Name": "authenticators.oauth2_introspection.config.pre_authorization.token_url", 1053 "Default": null, 1054 "Type": "", 1055 "TypeHint": 1, 1056 "Format": "uri", 1057 "Pattern": null, 1058 "Enum": null, 1059 "Constant": null, 1060 "ReadOnly": false, 1061 "MinLength": -1, 1062 "MaxLength": -1, 1063 "Required": true, 1064 "Minimum": null, 1065 "Maximum": null, 1066 "MultipleOf": null, 1067 "CustomProperties": null 1068 }, 1069 { 1070 "Title": "Required Scope", 1071 "Description": "An array of OAuth 2.0 scopes that are required when accessing an endpoint protected by this handler.\n If the token used in the Authorization header did not request that specific scope, the request is denied.", 1072 "Examples": null, 1073 "Name": "authenticators.oauth2_introspection.config.required_scope", 1074 "Default": null, 1075 "Type": [], 1076 "TypeHint": 8, 1077 "Format": "", 1078 "Pattern": null, 1079 "Enum": null, 1080 "Constant": null, 1081 "ReadOnly": false, 1082 "MinLength": -1, 1083 "MaxLength": -1, 1084 "Required": false, 1085 "Minimum": null, 1086 "Maximum": null, 1087 "MultipleOf": null, 1088 "CustomProperties": null 1089 }, 1090 { 1091 "Title": "", 1092 "Description": "", 1093 "Examples": null, 1094 "Name": "authenticators.oauth2_introspection.config.required_scope.#", 1095 "Default": null, 1096 "Type": "", 1097 "TypeHint": 1, 1098 "Format": "", 1099 "Pattern": null, 1100 "Enum": null, 1101 "Constant": null, 1102 "ReadOnly": false, 1103 "MinLength": -1, 1104 "MaxLength": -1, 1105 "Required": false, 1106 "Minimum": null, 1107 "Maximum": null, 1108 "MultipleOf": null, 1109 "CustomProperties": null 1110 }, 1111 { 1112 "Title": "Scope Strategy", 1113 "Description": "Sets the strategy validation algorithm.", 1114 "Examples": null, 1115 "Name": "authenticators.oauth2_introspection.config.scope_strategy", 1116 "Default": "none", 1117 "Type": "", 1118 "TypeHint": 1, 1119 "Format": "", 1120 "Pattern": null, 1121 "Enum": [ 1122 "hierarchic", 1123 "exact", 1124 "wildcard", 1125 "none" 1126 ], 1127 "Constant": null, 1128 "ReadOnly": false, 1129 "MinLength": -1, 1130 "MaxLength": -1, 1131 "Required": false, 1132 "Minimum": null, 1133 "Maximum": null, 1134 "MultipleOf": null, 1135 "CustomProperties": null 1136 }, 1137 { 1138 "Title": "Target Audience", 1139 "Description": "An array of audiences that are required when accessing an endpoint protected by this handler.\n If the token used in the Authorization header is not intended for any of the requested audiences, the request is denied.", 1140 "Examples": null, 1141 "Name": "authenticators.oauth2_introspection.config.target_audience", 1142 "Default": null, 1143 "Type": [], 1144 "TypeHint": 8, 1145 "Format": "", 1146 "Pattern": null, 1147 "Enum": null, 1148 "Constant": null, 1149 "ReadOnly": false, 1150 "MinLength": -1, 1151 "MaxLength": -1, 1152 "Required": false, 1153 "Minimum": null, 1154 "Maximum": null, 1155 "MultipleOf": null, 1156 "CustomProperties": null 1157 }, 1158 { 1159 "Title": "", 1160 "Description": "", 1161 "Examples": null, 1162 "Name": "authenticators.oauth2_introspection.config.target_audience.#", 1163 "Default": null, 1164 "Type": "", 1165 "TypeHint": 1, 1166 "Format": "", 1167 "Pattern": null, 1168 "Enum": null, 1169 "Constant": null, 1170 "ReadOnly": false, 1171 "MinLength": -1, 1172 "MaxLength": -1, 1173 "Required": false, 1174 "Minimum": null, 1175 "Maximum": null, 1176 "MultipleOf": null, 1177 "CustomProperties": null 1178 }, 1179 { 1180 "Title": "Token From", 1181 "Description": "The location of the token.\n If not configured, the token will be received from a default location - 'Authorization' header.\n One and only one location (header or query) must be specified.", 1182 "Examples": null, 1183 "Name": "authenticators.oauth2_introspection.config.token_from", 1184 "Default": null, 1185 "Type": {}, 1186 "TypeHint": 5, 1187 "Format": "", 1188 "Pattern": null, 1189 "Enum": null, 1190 "Constant": null, 1191 "ReadOnly": false, 1192 "MinLength": -1, 1193 "MaxLength": -1, 1194 "Required": false, 1195 "Minimum": null, 1196 "Maximum": null, 1197 "MultipleOf": null, 1198 "CustomProperties": null 1199 }, 1200 { 1201 "Title": "Header", 1202 "Description": "The header (case insensitive) that must contain a token for request authentication.\n It can't be set along with query_parameter.", 1203 "Examples": null, 1204 "Name": "authenticators.oauth2_introspection.config.token_from.header", 1205 "Default": null, 1206 "Type": "", 1207 "TypeHint": 1, 1208 "Format": "", 1209 "Pattern": null, 1210 "Enum": null, 1211 "Constant": null, 1212 "ReadOnly": false, 1213 "MinLength": -1, 1214 "MaxLength": -1, 1215 "Required": true, 1216 "Minimum": null, 1217 "Maximum": null, 1218 "MultipleOf": null, 1219 "CustomProperties": null 1220 }, 1221 { 1222 "Title": "Query Parameter", 1223 "Description": "The query parameter (case sensitive) that must contain a token for request authentication.\n It can't be set along with header.", 1224 "Examples": null, 1225 "Name": "authenticators.oauth2_introspection.config.token_from.query_parameter", 1226 "Default": null, 1227 "Type": "", 1228 "TypeHint": 1, 1229 "Format": "", 1230 "Pattern": null, 1231 "Enum": null, 1232 "Constant": null, 1233 "ReadOnly": false, 1234 "MinLength": -1, 1235 "MaxLength": -1, 1236 "Required": true, 1237 "Minimum": null, 1238 "Maximum": null, 1239 "MultipleOf": null, 1240 "CustomProperties": null 1241 }, 1242 { 1243 "Title": "Trusted Issuers", 1244 "Description": "The token must have been issued by one of the issuers listed in this array.", 1245 "Examples": null, 1246 "Name": "authenticators.oauth2_introspection.config.trusted_issuers", 1247 "Default": null, 1248 "Type": [], 1249 "TypeHint": 8, 1250 "Format": "", 1251 "Pattern": null, 1252 "Enum": null, 1253 "Constant": null, 1254 "ReadOnly": false, 1255 "MinLength": -1, 1256 "MaxLength": -1, 1257 "Required": false, 1258 "Minimum": null, 1259 "Maximum": null, 1260 "MultipleOf": null, 1261 "CustomProperties": null 1262 }, 1263 { 1264 "Title": "", 1265 "Description": "", 1266 "Examples": null, 1267 "Name": "authenticators.oauth2_introspection.config.trusted_issuers.#", 1268 "Default": null, 1269 "Type": "", 1270 "TypeHint": 1, 1271 "Format": "", 1272 "Pattern": null, 1273 "Enum": null, 1274 "Constant": null, 1275 "ReadOnly": false, 1276 "MinLength": -1, 1277 "MaxLength": -1, 1278 "Required": false, 1279 "Minimum": null, 1280 "Maximum": null, 1281 "MultipleOf": null, 1282 "CustomProperties": null 1283 }, 1284 { 1285 "Title": "Enabled", 1286 "Description": "En-/disables this component.", 1287 "Examples": [ 1288 true 1289 ], 1290 "Name": "authenticators.oauth2_introspection.enabled", 1291 "Default": false, 1292 "Type": false, 1293 "TypeHint": 4, 1294 "Format": "", 1295 "Pattern": null, 1296 "Enum": null, 1297 "Constant": null, 1298 "ReadOnly": false, 1299 "MinLength": -1, 1300 "MaxLength": -1, 1301 "Required": false, 1302 "Minimum": null, 1303 "Maximum": null, 1304 "MultipleOf": null, 1305 "CustomProperties": null 1306 }, 1307 { 1308 "Title": "Unauthorized", 1309 "Description": "The [`unauthorized` authenticator](https://www.ory.sh/docs/oathkeeper/pipeline/authn#unauthorized).", 1310 "Examples": null, 1311 "Name": "authenticators.unauthorized", 1312 "Default": null, 1313 "Type": {}, 1314 "TypeHint": 5, 1315 "Format": "", 1316 "Pattern": null, 1317 "Enum": null, 1318 "Constant": null, 1319 "ReadOnly": false, 1320 "MinLength": -1, 1321 "MaxLength": -1, 1322 "Required": false, 1323 "Minimum": null, 1324 "Maximum": null, 1325 "MultipleOf": null, 1326 "CustomProperties": null 1327 }, 1328 { 1329 "Title": "Enabled", 1330 "Description": "En-/disables this component.", 1331 "Examples": [ 1332 true 1333 ], 1334 "Name": "authenticators.unauthorized.enabled", 1335 "Default": false, 1336 "Type": false, 1337 "TypeHint": 4, 1338 "Format": "", 1339 "Pattern": null, 1340 "Enum": null, 1341 "Constant": null, 1342 "ReadOnly": false, 1343 "MinLength": -1, 1344 "MaxLength": -1, 1345 "Required": false, 1346 "Minimum": null, 1347 "Maximum": null, 1348 "MultipleOf": null, 1349 "CustomProperties": null 1350 }, 1351 { 1352 "Title": "Authorizers", 1353 "Description": "For more information on authorizers head over to: https://www.ory.sh/docs/oathkeeper/pipeline/authz", 1354 "Examples": null, 1355 "Name": "authorizers", 1356 "Default": null, 1357 "Type": {}, 1358 "TypeHint": 5, 1359 "Format": "", 1360 "Pattern": null, 1361 "Enum": null, 1362 "Constant": null, 1363 "ReadOnly": false, 1364 "MinLength": -1, 1365 "MaxLength": -1, 1366 "Required": false, 1367 "Minimum": null, 1368 "Maximum": null, 1369 "MultipleOf": null, 1370 "CustomProperties": null 1371 }, 1372 { 1373 "Title": "Allow", 1374 "Description": "The [`allow` authorizer](https://www.ory.sh/docs/oathkeeper/pipeline/authz#allow).", 1375 "Examples": null, 1376 "Name": "authorizers.allow", 1377 "Default": null, 1378 "Type": {}, 1379 "TypeHint": 5, 1380 "Format": "", 1381 "Pattern": null, 1382 "Enum": null, 1383 "Constant": null, 1384 "ReadOnly": false, 1385 "MinLength": -1, 1386 "MaxLength": -1, 1387 "Required": false, 1388 "Minimum": null, 1389 "Maximum": null, 1390 "MultipleOf": null, 1391 "CustomProperties": null 1392 }, 1393 { 1394 "Title": "Enabled", 1395 "Description": "En-/disables this component.", 1396 "Examples": [ 1397 true 1398 ], 1399 "Name": "authorizers.allow.enabled", 1400 "Default": false, 1401 "Type": false, 1402 "TypeHint": 4, 1403 "Format": "", 1404 "Pattern": null, 1405 "Enum": null, 1406 "Constant": null, 1407 "ReadOnly": false, 1408 "MinLength": -1, 1409 "MaxLength": -1, 1410 "Required": false, 1411 "Minimum": null, 1412 "Maximum": null, 1413 "MultipleOf": null, 1414 "CustomProperties": null 1415 }, 1416 { 1417 "Title": "Deny", 1418 "Description": "The [`deny` authorizer](https://www.ory.sh/docs/oathkeeper/pipeline/authz#allow).", 1419 "Examples": null, 1420 "Name": "authorizers.deny", 1421 "Default": null, 1422 "Type": {}, 1423 "TypeHint": 5, 1424 "Format": "", 1425 "Pattern": null, 1426 "Enum": null, 1427 "Constant": null, 1428 "ReadOnly": false, 1429 "MinLength": -1, 1430 "MaxLength": -1, 1431 "Required": false, 1432 "Minimum": null, 1433 "Maximum": null, 1434 "MultipleOf": null, 1435 "CustomProperties": null 1436 }, 1437 { 1438 "Title": "Enabled", 1439 "Description": "En-/disables this component.", 1440 "Examples": [ 1441 true 1442 ], 1443 "Name": "authorizers.deny.enabled", 1444 "Default": false, 1445 "Type": false, 1446 "TypeHint": 4, 1447 "Format": "", 1448 "Pattern": null, 1449 "Enum": null, 1450 "Constant": null, 1451 "ReadOnly": false, 1452 "MinLength": -1, 1453 "MaxLength": -1, 1454 "Required": false, 1455 "Minimum": null, 1456 "Maximum": null, 1457 "MultipleOf": null, 1458 "CustomProperties": null 1459 }, 1460 { 1461 "Title": "ORY Keto Access Control Policies Engine", 1462 "Description": "The [`keto_engine_acp_ory` authorizer](https://www.ory.sh/docs/oathkeeper/pipeline/authz#keto_engine_acp_ory).", 1463 "Examples": null, 1464 "Name": "authorizers.keto_engine_acp_ory", 1465 "Default": null, 1466 "Type": {}, 1467 "TypeHint": 5, 1468 "Format": "", 1469 "Pattern": null, 1470 "Enum": null, 1471 "Constant": null, 1472 "ReadOnly": false, 1473 "MinLength": -1, 1474 "MaxLength": -1, 1475 "Required": false, 1476 "Minimum": null, 1477 "Maximum": null, 1478 "MultipleOf": null, 1479 "CustomProperties": null 1480 }, 1481 { 1482 "Title": "ORY Keto Access Control Policy Authorizer Configuration", 1483 "Description": "This section is optional when the authorizer is disabled.", 1484 "Examples": null, 1485 "Name": "authorizers.keto_engine_acp_ory.config", 1486 "Default": null, 1487 "Type": {}, 1488 "TypeHint": 5, 1489 "Format": "", 1490 "Pattern": null, 1491 "Enum": null, 1492 "Constant": null, 1493 "ReadOnly": false, 1494 "MinLength": -1, 1495 "MaxLength": -1, 1496 "Required": false, 1497 "Minimum": null, 1498 "Maximum": null, 1499 "MultipleOf": null, 1500 "CustomProperties": null 1501 }, 1502 { 1503 "Title": "Base URL", 1504 "Description": "The base URL of ORY Keto.\n\n\u003eIf this authorizer is enabled, this value is required.", 1505 "Examples": [ 1506 "http://my-keto/" 1507 ], 1508 "Name": "authorizers.keto_engine_acp_ory.config.base_url", 1509 "Default": null, 1510 "Type": "", 1511 "TypeHint": 1, 1512 "Format": "uri", 1513 "Pattern": null, 1514 "Enum": null, 1515 "Constant": null, 1516 "ReadOnly": false, 1517 "MinLength": -1, 1518 "MaxLength": -1, 1519 "Required": true, 1520 "Minimum": null, 1521 "Maximum": null, 1522 "MultipleOf": null, 1523 "CustomProperties": null 1524 }, 1525 { 1526 "Title": "", 1527 "Description": "", 1528 "Examples": null, 1529 "Name": "authorizers.keto_engine_acp_ory.config.flavor", 1530 "Default": null, 1531 "Type": "", 1532 "TypeHint": 1, 1533 "Format": "", 1534 "Pattern": null, 1535 "Enum": null, 1536 "Constant": null, 1537 "ReadOnly": false, 1538 "MinLength": -1, 1539 "MaxLength": -1, 1540 "Required": false, 1541 "Minimum": null, 1542 "Maximum": null, 1543 "MultipleOf": null, 1544 "CustomProperties": null 1545 }, 1546 { 1547 "Title": "", 1548 "Description": "", 1549 "Examples": null, 1550 "Name": "authorizers.keto_engine_acp_ory.config.required_action", 1551 "Default": "unset", 1552 "Type": "", 1553 "TypeHint": 1, 1554 "Format": "", 1555 "Pattern": null, 1556 "Enum": null, 1557 "Constant": null, 1558 "ReadOnly": false, 1559 "MinLength": -1, 1560 "MaxLength": -1, 1561 "Required": true, 1562 "Minimum": null, 1563 "Maximum": null, 1564 "MultipleOf": null, 1565 "CustomProperties": null 1566 }, 1567 { 1568 "Title": "", 1569 "Description": "", 1570 "Examples": null, 1571 "Name": "authorizers.keto_engine_acp_ory.config.required_resource", 1572 "Default": "unset", 1573 "Type": "", 1574 "TypeHint": 1, 1575 "Format": "", 1576 "Pattern": null, 1577 "Enum": null, 1578 "Constant": null, 1579 "ReadOnly": false, 1580 "MinLength": -1, 1581 "MaxLength": -1, 1582 "Required": true, 1583 "Minimum": null, 1584 "Maximum": null, 1585 "MultipleOf": null, 1586 "CustomProperties": null 1587 }, 1588 { 1589 "Title": "", 1590 "Description": "", 1591 "Examples": null, 1592 "Name": "authorizers.keto_engine_acp_ory.config.subject", 1593 "Default": null, 1594 "Type": "", 1595 "TypeHint": 1, 1596 "Format": "", 1597 "Pattern": null, 1598 "Enum": null, 1599 "Constant": null, 1600 "ReadOnly": false, 1601 "MinLength": -1, 1602 "MaxLength": -1, 1603 "Required": false, 1604 "Minimum": null, 1605 "Maximum": null, 1606 "MultipleOf": null, 1607 "CustomProperties": null 1608 }, 1609 { 1610 "Title": "Enabled", 1611 "Description": "En-/disables this component.", 1612 "Examples": [ 1613 true 1614 ], 1615 "Name": "authorizers.keto_engine_acp_ory.enabled", 1616 "Default": false, 1617 "Type": false, 1618 "TypeHint": 4, 1619 "Format": "", 1620 "Pattern": null, 1621 "Enum": null, 1622 "Constant": null, 1623 "ReadOnly": false, 1624 "MinLength": -1, 1625 "MaxLength": -1, 1626 "Required": false, 1627 "Minimum": null, 1628 "Maximum": null, 1629 "MultipleOf": null, 1630 "CustomProperties": null 1631 }, 1632 { 1633 "Title": "Log", 1634 "Description": "Configure logging using the following options. Logging will always be sent to stdout and stderr.", 1635 "Examples": null, 1636 "Name": "log", 1637 "Default": null, 1638 "Type": {}, 1639 "TypeHint": 5, 1640 "Format": "", 1641 "Pattern": null, 1642 "Enum": null, 1643 "Constant": null, 1644 "ReadOnly": false, 1645 "MinLength": -1, 1646 "MaxLength": -1, 1647 "Required": false, 1648 "Minimum": null, 1649 "Maximum": null, 1650 "MultipleOf": null, 1651 "CustomProperties": null 1652 }, 1653 { 1654 "Title": "Format", 1655 "Description": "The log format can either be text or JSON.", 1656 "Examples": null, 1657 "Name": "log.format", 1658 "Default": "text", 1659 "Type": "", 1660 "TypeHint": 1, 1661 "Format": "", 1662 "Pattern": null, 1663 "Enum": [ 1664 "text", 1665 "json" 1666 ], 1667 "Constant": null, 1668 "ReadOnly": false, 1669 "MinLength": -1, 1670 "MaxLength": -1, 1671 "Required": false, 1672 "Minimum": null, 1673 "Maximum": null, 1674 "MultipleOf": null, 1675 "CustomProperties": null 1676 }, 1677 { 1678 "Title": "Level", 1679 "Description": "Debug enables stack traces on errors. Can also be set using environment variable LOG_LEVEL.", 1680 "Examples": null, 1681 "Name": "log.level", 1682 "Default": "info", 1683 "Type": "", 1684 "TypeHint": 1, 1685 "Format": "", 1686 "Pattern": null, 1687 "Enum": [ 1688 "panic", 1689 "fatal", 1690 "error", 1691 "warn", 1692 "info", 1693 "debug" 1694 ], 1695 "Constant": null, 1696 "ReadOnly": false, 1697 "MinLength": -1, 1698 "MaxLength": -1, 1699 "Required": false, 1700 "Minimum": null, 1701 "Maximum": null, 1702 "MultipleOf": null, 1703 "CustomProperties": null 1704 }, 1705 { 1706 "Title": "Mutators", 1707 "Description": "For more information on mutators head over to: https://www.ory.sh/docs/oathkeeper/pipeline/mutator", 1708 "Examples": null, 1709 "Name": "mutators", 1710 "Default": null, 1711 "Type": {}, 1712 "TypeHint": 5, 1713 "Format": "", 1714 "Pattern": null, 1715 "Enum": null, 1716 "Constant": null, 1717 "ReadOnly": false, 1718 "MinLength": -1, 1719 "MaxLength": -1, 1720 "Required": false, 1721 "Minimum": null, 1722 "Maximum": null, 1723 "MultipleOf": null, 1724 "CustomProperties": null 1725 }, 1726 { 1727 "Title": "HTTP Cookie", 1728 "Description": "The [`cookie` mutator](https://www.ory.sh/docs/oathkeeper/pipeline/mutator#cookie).", 1729 "Examples": null, 1730 "Name": "mutators.cookie", 1731 "Default": null, 1732 "Type": {}, 1733 "TypeHint": 5, 1734 "Format": "", 1735 "Pattern": null, 1736 "Enum": null, 1737 "Constant": null, 1738 "ReadOnly": false, 1739 "MinLength": -1, 1740 "MaxLength": -1, 1741 "Required": false, 1742 "Minimum": null, 1743 "Maximum": null, 1744 "MultipleOf": null, 1745 "CustomProperties": null 1746 }, 1747 { 1748 "Title": "Cookie Mutator Configuration", 1749 "Description": "This section is optional when the mutator is disabled.", 1750 "Examples": null, 1751 "Name": "mutators.cookie.config", 1752 "Default": null, 1753 "Type": {}, 1754 "TypeHint": 5, 1755 "Format": "", 1756 "Pattern": null, 1757 "Enum": null, 1758 "Constant": null, 1759 "ReadOnly": false, 1760 "MinLength": -1, 1761 "MaxLength": -1, 1762 "Required": false, 1763 "Minimum": null, 1764 "Maximum": null, 1765 "MultipleOf": null, 1766 "CustomProperties": null 1767 }, 1768 { 1769 "Title": "", 1770 "Description": "", 1771 "Examples": null, 1772 "Name": "mutators.cookie.config.cookies", 1773 "Default": null, 1774 "Type": {}, 1775 "TypeHint": 5, 1776 "Format": "", 1777 "Pattern": null, 1778 "Enum": null, 1779 "Constant": null, 1780 "ReadOnly": false, 1781 "MinLength": -1, 1782 "MaxLength": -1, 1783 "Required": true, 1784 "Minimum": null, 1785 "Maximum": null, 1786 "MultipleOf": null, 1787 "CustomProperties": null 1788 }, 1789 { 1790 "Title": "Enabled", 1791 "Description": "En-/disables this component.", 1792 "Examples": [ 1793 true 1794 ], 1795 "Name": "mutators.cookie.enabled", 1796 "Default": false, 1797 "Type": false, 1798 "TypeHint": 4, 1799 "Format": "", 1800 "Pattern": null, 1801 "Enum": null, 1802 "Constant": null, 1803 "ReadOnly": false, 1804 "MinLength": -1, 1805 "MaxLength": -1, 1806 "Required": false, 1807 "Minimum": null, 1808 "Maximum": null, 1809 "MultipleOf": null, 1810 "CustomProperties": null 1811 }, 1812 { 1813 "Title": "HTTP Header", 1814 "Description": "The [`header` mutator](https://www.ory.sh/docs/oathkeeper/pipeline/mutator#header).", 1815 "Examples": null, 1816 "Name": "mutators.header", 1817 "Default": null, 1818 "Type": {}, 1819 "TypeHint": 5, 1820 "Format": "", 1821 "Pattern": null, 1822 "Enum": null, 1823 "Constant": null, 1824 "ReadOnly": false, 1825 "MinLength": -1, 1826 "MaxLength": -1, 1827 "Required": false, 1828 "Minimum": null, 1829 "Maximum": null, 1830 "MultipleOf": null, 1831 "CustomProperties": null 1832 }, 1833 { 1834 "Title": "Header Mutator Configuration", 1835 "Description": "This section is optional when the mutator is disabled.", 1836 "Examples": null, 1837 "Name": "mutators.header.config", 1838 "Default": null, 1839 "Type": {}, 1840 "TypeHint": 5, 1841 "Format": "", 1842 "Pattern": null, 1843 "Enum": null, 1844 "Constant": null, 1845 "ReadOnly": false, 1846 "MinLength": -1, 1847 "MaxLength": -1, 1848 "Required": false, 1849 "Minimum": null, 1850 "Maximum": null, 1851 "MultipleOf": null, 1852 "CustomProperties": null 1853 }, 1854 { 1855 "Title": "", 1856 "Description": "", 1857 "Examples": null, 1858 "Name": "mutators.header.config.headers", 1859 "Default": null, 1860 "Type": {}, 1861 "TypeHint": 5, 1862 "Format": "", 1863 "Pattern": null, 1864 "Enum": null, 1865 "Constant": null, 1866 "ReadOnly": false, 1867 "MinLength": -1, 1868 "MaxLength": -1, 1869 "Required": true, 1870 "Minimum": null, 1871 "Maximum": null, 1872 "MultipleOf": null, 1873 "CustomProperties": null 1874 }, 1875 { 1876 "Title": "Enabled", 1877 "Description": "En-/disables this component.", 1878 "Examples": [ 1879 true 1880 ], 1881 "Name": "mutators.header.enabled", 1882 "Default": false, 1883 "Type": false, 1884 "TypeHint": 4, 1885 "Format": "", 1886 "Pattern": null, 1887 "Enum": null, 1888 "Constant": null, 1889 "ReadOnly": false, 1890 "MinLength": -1, 1891 "MaxLength": -1, 1892 "Required": false, 1893 "Minimum": null, 1894 "Maximum": null, 1895 "MultipleOf": null, 1896 "CustomProperties": null 1897 }, 1898 { 1899 "Title": "Hydrator", 1900 "Description": "The [`hydrator` mutator](https://www.ory.sh/docs/oathkeeper/pipeline/mutator#hydrator).", 1901 "Examples": null, 1902 "Name": "mutators.hydrator", 1903 "Default": null, 1904 "Type": {}, 1905 "TypeHint": 5, 1906 "Format": "", 1907 "Pattern": null, 1908 "Enum": null, 1909 "Constant": null, 1910 "ReadOnly": false, 1911 "MinLength": -1, 1912 "MaxLength": -1, 1913 "Required": false, 1914 "Minimum": null, 1915 "Maximum": null, 1916 "MultipleOf": null, 1917 "CustomProperties": null 1918 }, 1919 { 1920 "Title": "Hydrator Mutator Configuration", 1921 "Description": "This section is optional when the mutator is disabled.", 1922 "Examples": null, 1923 "Name": "mutators.hydrator.config", 1924 "Default": null, 1925 "Type": {}, 1926 "TypeHint": 5, 1927 "Format": "", 1928 "Pattern": null, 1929 "Enum": null, 1930 "Constant": null, 1931 "ReadOnly": false, 1932 "MinLength": -1, 1933 "MaxLength": -1, 1934 "Required": false, 1935 "Minimum": null, 1936 "Maximum": null, 1937 "MultipleOf": null, 1938 "CustomProperties": null 1939 }, 1940 { 1941 "Title": "", 1942 "Description": "", 1943 "Examples": null, 1944 "Name": "mutators.hydrator.config.api", 1945 "Default": null, 1946 "Type": {}, 1947 "TypeHint": 5, 1948 "Format": "", 1949 "Pattern": null, 1950 "Enum": null, 1951 "Constant": null, 1952 "ReadOnly": false, 1953 "MinLength": -1, 1954 "MaxLength": -1, 1955 "Required": true, 1956 "Minimum": null, 1957 "Maximum": null, 1958 "MultipleOf": null, 1959 "CustomProperties": null 1960 }, 1961 { 1962 "Title": "", 1963 "Description": "", 1964 "Examples": null, 1965 "Name": "mutators.hydrator.config.api.auth", 1966 "Default": null, 1967 "Type": {}, 1968 "TypeHint": 5, 1969 "Format": "", 1970 "Pattern": null, 1971 "Enum": null, 1972 "Constant": null, 1973 "ReadOnly": false, 1974 "MinLength": -1, 1975 "MaxLength": -1, 1976 "Required": false, 1977 "Minimum": null, 1978 "Maximum": null, 1979 "MultipleOf": null, 1980 "CustomProperties": null 1981 }, 1982 { 1983 "Title": "", 1984 "Description": "", 1985 "Examples": null, 1986 "Name": "mutators.hydrator.config.api.auth.basic", 1987 "Default": null, 1988 "Type": {}, 1989 "TypeHint": 5, 1990 "Format": "", 1991 "Pattern": null, 1992 "Enum": null, 1993 "Constant": null, 1994 "ReadOnly": false, 1995 "MinLength": -1, 1996 "MaxLength": -1, 1997 "Required": false, 1998 "Minimum": null, 1999 "Maximum": null, 2000 "MultipleOf": null, 2001 "CustomProperties": null 2002 }, 2003 { 2004 "Title": "", 2005 "Description": "", 2006 "Examples": null, 2007 "Name": "mutators.hydrator.config.api.auth.basic.password", 2008 "Default": null, 2009 "Type": "", 2010 "TypeHint": 1, 2011 "Format": "", 2012 "Pattern": null, 2013 "Enum": null, 2014 "Constant": null, 2015 "ReadOnly": false, 2016 "MinLength": -1, 2017 "MaxLength": -1, 2018 "Required": true, 2019 "Minimum": null, 2020 "Maximum": null, 2021 "MultipleOf": null, 2022 "CustomProperties": null 2023 }, 2024 { 2025 "Title": "", 2026 "Description": "", 2027 "Examples": null, 2028 "Name": "mutators.hydrator.config.api.auth.basic.username", 2029 "Default": null, 2030 "Type": "", 2031 "TypeHint": 1, 2032 "Format": "", 2033 "Pattern": null, 2034 "Enum": null, 2035 "Constant": null, 2036 "ReadOnly": false, 2037 "MinLength": -1, 2038 "MaxLength": -1, 2039 "Required": true, 2040 "Minimum": null, 2041 "Maximum": null, 2042 "MultipleOf": null, 2043 "CustomProperties": null 2044 }, 2045 { 2046 "Title": "", 2047 "Description": "", 2048 "Examples": null, 2049 "Name": "mutators.hydrator.config.api.retry", 2050 "Default": null, 2051 "Type": {}, 2052 "TypeHint": 5, 2053 "Format": "", 2054 "Pattern": null, 2055 "Enum": null, 2056 "Constant": null, 2057 "ReadOnly": false, 2058 "MinLength": -1, 2059 "MaxLength": -1, 2060 "Required": false, 2061 "Minimum": null, 2062 "Maximum": null, 2063 "MultipleOf": null, 2064 "CustomProperties": null 2065 }, 2066 { 2067 "Title": "", 2068 "Description": "", 2069 "Examples": null, 2070 "Name": "mutators.hydrator.config.api.retry.delay_in_milliseconds", 2071 "Default": 3, 2072 "Type": 0, 2073 "TypeHint": 3, 2074 "Format": "", 2075 "Pattern": null, 2076 "Enum": null, 2077 "Constant": null, 2078 "ReadOnly": false, 2079 "MinLength": -1, 2080 "MaxLength": -1, 2081 "Required": false, 2082 "Minimum": "0", 2083 "Maximum": null, 2084 "MultipleOf": null, 2085 "CustomProperties": null 2086 }, 2087 { 2088 "Title": "", 2089 "Description": "", 2090 "Examples": null, 2091 "Name": "mutators.hydrator.config.api.retry.number_of_retries", 2092 "Default": 100, 2093 "Type": 0, 2094 "TypeHint": 2, 2095 "Format": "", 2096 "Pattern": null, 2097 "Enum": null, 2098 "Constant": null, 2099 "ReadOnly": false, 2100 "MinLength": -1, 2101 "MaxLength": -1, 2102 "Required": false, 2103 "Minimum": "0", 2104 "Maximum": null, 2105 "MultipleOf": null, 2106 "CustomProperties": null 2107 }, 2108 { 2109 "Title": "", 2110 "Description": "", 2111 "Examples": null, 2112 "Name": "mutators.hydrator.config.api.url", 2113 "Default": null, 2114 "Type": "", 2115 "TypeHint": 1, 2116 "Format": "uri", 2117 "Pattern": null, 2118 "Enum": null, 2119 "Constant": null, 2120 "ReadOnly": false, 2121 "MinLength": -1, 2122 "MaxLength": -1, 2123 "Required": true, 2124 "Minimum": null, 2125 "Maximum": null, 2126 "MultipleOf": null, 2127 "CustomProperties": null 2128 }, 2129 { 2130 "Title": "Enabled", 2131 "Description": "En-/disables this component.", 2132 "Examples": [ 2133 true 2134 ], 2135 "Name": "mutators.hydrator.enabled", 2136 "Default": false, 2137 "Type": false, 2138 "TypeHint": 4, 2139 "Format": "", 2140 "Pattern": null, 2141 "Enum": null, 2142 "Constant": null, 2143 "ReadOnly": false, 2144 "MinLength": -1, 2145 "MaxLength": -1, 2146 "Required": false, 2147 "Minimum": null, 2148 "Maximum": null, 2149 "MultipleOf": null, 2150 "CustomProperties": null 2151 }, 2152 { 2153 "Title": "ID Token (JSON Web Token)", 2154 "Description": "The [`id_token` mutator](https://www.ory.sh/docs/oathkeeper/pipeline/mutator#id_token).", 2155 "Examples": null, 2156 "Name": "mutators.id_token", 2157 "Default": null, 2158 "Type": {}, 2159 "TypeHint": 5, 2160 "Format": "", 2161 "Pattern": null, 2162 "Enum": null, 2163 "Constant": null, 2164 "ReadOnly": false, 2165 "MinLength": -1, 2166 "MaxLength": -1, 2167 "Required": false, 2168 "Minimum": null, 2169 "Maximum": null, 2170 "MultipleOf": null, 2171 "CustomProperties": null 2172 }, 2173 { 2174 "Title": "ID Token Mutator Configuration", 2175 "Description": "This section is optional when the mutator is disabled.", 2176 "Examples": null, 2177 "Name": "mutators.id_token.config", 2178 "Default": null, 2179 "Type": {}, 2180 "TypeHint": 5, 2181 "Format": "", 2182 "Pattern": null, 2183 "Enum": null, 2184 "Constant": null, 2185 "ReadOnly": false, 2186 "MinLength": -1, 2187 "MaxLength": -1, 2188 "Required": false, 2189 "Minimum": null, 2190 "Maximum": null, 2191 "MultipleOf": null, 2192 "CustomProperties": null 2193 }, 2194 { 2195 "Title": "", 2196 "Description": "", 2197 "Examples": null, 2198 "Name": "mutators.id_token.config.claims", 2199 "Default": null, 2200 "Type": "", 2201 "TypeHint": 1, 2202 "Format": "", 2203 "Pattern": null, 2204 "Enum": null, 2205 "Constant": null, 2206 "ReadOnly": false, 2207 "MinLength": -1, 2208 "MaxLength": -1, 2209 "Required": false, 2210 "Minimum": null, 2211 "Maximum": null, 2212 "MultipleOf": null, 2213 "CustomProperties": null 2214 }, 2215 { 2216 "Title": "Issuer URL", 2217 "Description": "Sets the \"iss\" value of the ID Token.\n\n\u003eIf this mutator is enabled, this value is required.", 2218 "Examples": null, 2219 "Name": "mutators.id_token.config.issuer_url", 2220 "Default": null, 2221 "Type": "", 2222 "TypeHint": 1, 2223 "Format": "", 2224 "Pattern": null, 2225 "Enum": null, 2226 "Constant": null, 2227 "ReadOnly": false, 2228 "MinLength": -1, 2229 "MaxLength": -1, 2230 "Required": true, 2231 "Minimum": null, 2232 "Maximum": null, 2233 "MultipleOf": null, 2234 "CustomProperties": null 2235 }, 2236 { 2237 "Title": "JSON Web Key URL", 2238 "Description": "Sets the URL where keys should be fetched from. Supports remote locations (http, https) as well as local filesystem paths.\n\n\u003eIf this mutator is enabled, this value is required.", 2239 "Examples": [ 2240 "https://fetch-keys/from/this/location.json", 2241 "file:///from/this/absolute/location.json", 2242 "file://../from/this/relative/location.json" 2243 ], 2244 "Name": "mutators.id_token.config.jwks_url", 2245 "Default": null, 2246 "Type": "", 2247 "TypeHint": 1, 2248 "Format": "uri", 2249 "Pattern": null, 2250 "Enum": null, 2251 "Constant": null, 2252 "ReadOnly": false, 2253 "MinLength": -1, 2254 "MaxLength": -1, 2255 "Required": true, 2256 "Minimum": null, 2257 "Maximum": null, 2258 "MultipleOf": null, 2259 "CustomProperties": null 2260 }, 2261 { 2262 "Title": "Expire After", 2263 "Description": "Sets the time-to-live of the JSON Web Token.", 2264 "Examples": [ 2265 "1h", 2266 "1m", 2267 "30s" 2268 ], 2269 "Name": "mutators.id_token.config.ttl", 2270 "Default": "1m", 2271 "Type": "", 2272 "TypeHint": 1, 2273 "Format": "", 2274 "Pattern": {}, 2275 "Enum": null, 2276 "Constant": null, 2277 "ReadOnly": false, 2278 "MinLength": -1, 2279 "MaxLength": -1, 2280 "Required": false, 2281 "Minimum": null, 2282 "Maximum": null, 2283 "MultipleOf": null, 2284 "CustomProperties": null 2285 }, 2286 { 2287 "Title": "Enabled", 2288 "Description": "En-/disables this component.", 2289 "Examples": [ 2290 true 2291 ], 2292 "Name": "mutators.id_token.enabled", 2293 "Default": false, 2294 "Type": false, 2295 "TypeHint": 4, 2296 "Format": "", 2297 "Pattern": null, 2298 "Enum": null, 2299 "Constant": null, 2300 "ReadOnly": false, 2301 "MinLength": -1, 2302 "MaxLength": -1, 2303 "Required": false, 2304 "Minimum": null, 2305 "Maximum": null, 2306 "MultipleOf": null, 2307 "CustomProperties": null 2308 }, 2309 { 2310 "Title": "No Operation (noop)", 2311 "Description": "The [`noop` mutator](https://www.ory.sh/docs/oathkeeper/pipeline/mutator#noop).", 2312 "Examples": null, 2313 "Name": "mutators.noop", 2314 "Default": null, 2315 "Type": {}, 2316 "TypeHint": 5, 2317 "Format": "", 2318 "Pattern": null, 2319 "Enum": null, 2320 "Constant": null, 2321 "ReadOnly": false, 2322 "MinLength": -1, 2323 "MaxLength": -1, 2324 "Required": false, 2325 "Minimum": null, 2326 "Maximum": null, 2327 "MultipleOf": null, 2328 "CustomProperties": null 2329 }, 2330 { 2331 "Title": "Enabled", 2332 "Description": "En-/disables this component.", 2333 "Examples": [ 2334 true 2335 ], 2336 "Name": "mutators.noop.enabled", 2337 "Default": false, 2338 "Type": false, 2339 "TypeHint": 4, 2340 "Format": "", 2341 "Pattern": null, 2342 "Enum": null, 2343 "Constant": null, 2344 "ReadOnly": false, 2345 "MinLength": -1, 2346 "MaxLength": -1, 2347 "Required": false, 2348 "Minimum": null, 2349 "Maximum": null, 2350 "MultipleOf": null, 2351 "CustomProperties": null 2352 }, 2353 { 2354 "Title": "Profiling", 2355 "Description": "Enables CPU or memory profiling if set. For more details on profiling Go programs read [Profiling Go Programs](https://blog.golang.org/profiling-go-programs).", 2356 "Examples": null, 2357 "Name": "profiling", 2358 "Default": null, 2359 "Type": "", 2360 "TypeHint": 1, 2361 "Format": "", 2362 "Pattern": null, 2363 "Enum": [ 2364 "cpu", 2365 "mem" 2366 ], 2367 "Constant": null, 2368 "ReadOnly": false, 2369 "MinLength": -1, 2370 "MaxLength": -1, 2371 "Required": false, 2372 "Minimum": null, 2373 "Maximum": null, 2374 "MultipleOf": null, 2375 "CustomProperties": null 2376 }, 2377 { 2378 "Title": "HTTP(s)", 2379 "Description": "", 2380 "Examples": null, 2381 "Name": "serve", 2382 "Default": null, 2383 "Type": {}, 2384 "TypeHint": 5, 2385 "Format": "", 2386 "Pattern": null, 2387 "Enum": null, 2388 "Constant": null, 2389 "ReadOnly": false, 2390 "MinLength": -1, 2391 "MaxLength": -1, 2392 "Required": false, 2393 "Minimum": null, 2394 "Maximum": null, 2395 "MultipleOf": null, 2396 "CustomProperties": null 2397 }, 2398 { 2399 "Title": "HTTP REST API", 2400 "Description": "", 2401 "Examples": null, 2402 "Name": "serve.api", 2403 "Default": null, 2404 "Type": {}, 2405 "TypeHint": 5, 2406 "Format": "", 2407 "Pattern": null, 2408 "Enum": null, 2409 "Constant": null, 2410 "ReadOnly": false, 2411 "MinLength": -1, 2412 "MaxLength": -1, 2413 "Required": false, 2414 "Minimum": null, 2415 "Maximum": null, 2416 "MultipleOf": null, 2417 "CustomProperties": null 2418 }, 2419 { 2420 "Title": "Cross Origin Resource Sharing (CORS)", 2421 "Description": "Configure [Cross Origin Resource Sharing (CORS)](http://www.w3.org/TR/cors/) using the following options.", 2422 "Examples": null, 2423 "Name": "serve.api.cors", 2424 "Default": null, 2425 "Type": {}, 2426 "TypeHint": 5, 2427 "Format": "", 2428 "Pattern": null, 2429 "Enum": null, 2430 "Constant": null, 2431 "ReadOnly": false, 2432 "MinLength": -1, 2433 "MaxLength": -1, 2434 "Required": false, 2435 "Minimum": null, 2436 "Maximum": null, 2437 "MultipleOf": null, 2438 "CustomProperties": null 2439 }, 2440 { 2441 "Title": "Allow HTTP Credentials", 2442 "Description": "Indicates whether the request can include user credentials like cookies, HTTP authentication or client side SSL certificates.", 2443 "Examples": null, 2444 "Name": "serve.api.cors.allow_credentials", 2445 "Default": false, 2446 "Type": false, 2447 "TypeHint": 4, 2448 "Format": "", 2449 "Pattern": null, 2450 "Enum": null, 2451 "Constant": null, 2452 "ReadOnly": false, 2453 "MinLength": -1, 2454 "MaxLength": -1, 2455 "Required": false, 2456 "Minimum": null, 2457 "Maximum": null, 2458 "MultipleOf": null, 2459 "CustomProperties": null 2460 }, 2461 { 2462 "Title": "Allowed Request HTTP Headers", 2463 "Description": "A list of non simple headers the client is allowed to use with cross-domain requests.", 2464 "Examples": null, 2465 "Name": "serve.api.cors.allowed_headers", 2466 "Default": [ 2467 "Authorization", 2468 "Content-Type" 2469 ], 2470 "Type": [], 2471 "TypeHint": 8, 2472 "Format": "", 2473 "Pattern": null, 2474 "Enum": null, 2475 "Constant": null, 2476 "ReadOnly": false, 2477 "MinLength": 1, 2478 "MaxLength": -1, 2479 "Required": false, 2480 "Minimum": null, 2481 "Maximum": null, 2482 "MultipleOf": null, 2483 "CustomProperties": null 2484 }, 2485 { 2486 "Title": "", 2487 "Description": "", 2488 "Examples": null, 2489 "Name": "serve.api.cors.allowed_headers.#", 2490 "Default": null, 2491 "Type": "", 2492 "TypeHint": 1, 2493 "Format": "", 2494 "Pattern": null, 2495 "Enum": null, 2496 "Constant": null, 2497 "ReadOnly": false, 2498 "MinLength": -1, 2499 "MaxLength": -1, 2500 "Required": false, 2501 "Minimum": null, 2502 "Maximum": null, 2503 "MultipleOf": null, 2504 "CustomProperties": null 2505 }, 2506 { 2507 "Title": "Allowed HTTP Methods", 2508 "Description": "A list of methods the client is allowed to use with cross-domain requests.", 2509 "Examples": null, 2510 "Name": "serve.api.cors.allowed_methods", 2511 "Default": [ 2512 "GET", 2513 "POST", 2514 "PUT", 2515 "PATCH", 2516 "DELETE" 2517 ], 2518 "Type": [], 2519 "TypeHint": 8, 2520 "Format": "", 2521 "Pattern": null, 2522 "Enum": null, 2523 "Constant": null, 2524 "ReadOnly": false, 2525 "MinLength": -1, 2526 "MaxLength": -1, 2527 "Required": false, 2528 "Minimum": null, 2529 "Maximum": null, 2530 "MultipleOf": null, 2531 "CustomProperties": null 2532 }, 2533 { 2534 "Title": "", 2535 "Description": "", 2536 "Examples": null, 2537 "Name": "serve.api.cors.allowed_methods.#", 2538 "Default": null, 2539 "Type": "", 2540 "TypeHint": 1, 2541 "Format": "", 2542 "Pattern": null, 2543 "Enum": [ 2544 "GET", 2545 "HEAD", 2546 "POST", 2547 "PUT", 2548 "DELETE", 2549 "CONNECT", 2550 "TRACE", 2551 "PATCH" 2552 ], 2553 "Constant": null, 2554 "ReadOnly": false, 2555 "MinLength": -1, 2556 "MaxLength": -1, 2557 "Required": false, 2558 "Minimum": null, 2559 "Maximum": null, 2560 "MultipleOf": null, 2561 "CustomProperties": null 2562 }, 2563 { 2564 "Title": "Allowed Origins", 2565 "Description": "A list of origins a cross-domain request can be executed from. If the special * value is present in the list, all origins will be allowed. An origin may contain a wildcard (*) to replace 0 or more characters (i.e.: http://*.domain.com). Usage of wildcards implies a small performance penality. Only one wildcard can be used per origin.", 2566 "Examples": [ 2567 "https://example.com", 2568 "https://*.example.com", 2569 "https://*.foo.example.com" 2570 ], 2571 "Name": "serve.api.cors.allowed_origins", 2572 "Default": [ 2573 "*" 2574 ], 2575 "Type": [], 2576 "TypeHint": 8, 2577 "Format": "", 2578 "Pattern": null, 2579 "Enum": null, 2580 "Constant": null, 2581 "ReadOnly": false, 2582 "MinLength": -1, 2583 "MaxLength": -1, 2584 "Required": false, 2585 "Minimum": null, 2586 "Maximum": null, 2587 "MultipleOf": null, 2588 "CustomProperties": null 2589 }, 2590 { 2591 "Title": "", 2592 "Description": "", 2593 "Examples": null, 2594 "Name": "serve.api.cors.allowed_origins.#", 2595 "Default": null, 2596 "Type": "", 2597 "TypeHint": 1, 2598 "Format": "", 2599 "Pattern": null, 2600 "Enum": null, 2601 "Constant": null, 2602 "ReadOnly": false, 2603 "MinLength": 1, 2604 "MaxLength": -1, 2605 "Required": false, 2606 "Minimum": null, 2607 "Maximum": null, 2608 "MultipleOf": null, 2609 "CustomProperties": null 2610 }, 2611 { 2612 "Title": "Enable Debugging", 2613 "Description": "Set to true to debug server side CORS issues.", 2614 "Examples": null, 2615 "Name": "serve.api.cors.debug", 2616 "Default": false, 2617 "Type": false, 2618 "TypeHint": 4, 2619 "Format": "", 2620 "Pattern": null, 2621 "Enum": null, 2622 "Constant": null, 2623 "ReadOnly": false, 2624 "MinLength": -1, 2625 "MaxLength": -1, 2626 "Required": false, 2627 "Minimum": null, 2628 "Maximum": null, 2629 "MultipleOf": null, 2630 "CustomProperties": null 2631 }, 2632 { 2633 "Title": "Enable CORS", 2634 "Description": "If set to true, CORS will be enabled and preflight-requests (OPTION) will be answered.", 2635 "Examples": null, 2636 "Name": "serve.api.cors.enabled", 2637 "Default": false, 2638 "Type": false, 2639 "TypeHint": 4, 2640 "Format": "", 2641 "Pattern": null, 2642 "Enum": null, 2643 "Constant": null, 2644 "ReadOnly": false, 2645 "MinLength": -1, 2646 "MaxLength": -1, 2647 "Required": false, 2648 "Minimum": null, 2649 "Maximum": null, 2650 "MultipleOf": null, 2651 "CustomProperties": null 2652 }, 2653 { 2654 "Title": "Allowed Response HTTP Headers", 2655 "Description": "Indicates which headers are safe to expose to the API of a CORS API specification", 2656 "Examples": null, 2657 "Name": "serve.api.cors.exposed_headers", 2658 "Default": [ 2659 "Content-Type" 2660 ], 2661 "Type": [], 2662 "TypeHint": 8, 2663 "Format": "", 2664 "Pattern": null, 2665 "Enum": null, 2666 "Constant": null, 2667 "ReadOnly": false, 2668 "MinLength": 1, 2669 "MaxLength": -1, 2670 "Required": false, 2671 "Minimum": null, 2672 "Maximum": null, 2673 "MultipleOf": null, 2674 "CustomProperties": null 2675 }, 2676 { 2677 "Title": "", 2678 "Description": "", 2679 "Examples": null, 2680 "Name": "serve.api.cors.exposed_headers.#", 2681 "Default": null, 2682 "Type": "", 2683 "TypeHint": 1, 2684 "Format": "", 2685 "Pattern": null, 2686 "Enum": null, 2687 "Constant": null, 2688 "ReadOnly": false, 2689 "MinLength": -1, 2690 "MaxLength": -1, 2691 "Required": false, 2692 "Minimum": null, 2693 "Maximum": null, 2694 "MultipleOf": null, 2695 "CustomProperties": null 2696 }, 2697 { 2698 "Title": "Maximum Age", 2699 "Description": "Indicates how long (in seconds) the results of a preflight request can be cached. The default is 0 which stands for no max age.", 2700 "Examples": null, 2701 "Name": "serve.api.cors.max_age", 2702 "Default": 0, 2703 "Type": 0, 2704 "TypeHint": 2, 2705 "Format": "", 2706 "Pattern": null, 2707 "Enum": null, 2708 "Constant": null, 2709 "ReadOnly": false, 2710 "MinLength": -1, 2711 "MaxLength": -1, 2712 "Required": false, 2713 "Minimum": null, 2714 "Maximum": null, 2715 "MultipleOf": null, 2716 "CustomProperties": null 2717 }, 2718 { 2719 "Title": "Host", 2720 "Description": "The network interface to listen on.", 2721 "Examples": [ 2722 "localhost", 2723 "127.0.0.1" 2724 ], 2725 "Name": "serve.api.host", 2726 "Default": "", 2727 "Type": "", 2728 "TypeHint": 1, 2729 "Format": "", 2730 "Pattern": null, 2731 "Enum": null, 2732 "Constant": null, 2733 "ReadOnly": false, 2734 "MinLength": -1, 2735 "MaxLength": -1, 2736 "Required": false, 2737 "Minimum": null, 2738 "Maximum": null, 2739 "MultipleOf": null, 2740 "CustomProperties": null 2741 }, 2742 { 2743 "Title": "Port", 2744 "Description": "The port to listen on.", 2745 "Examples": null, 2746 "Name": "serve.api.port", 2747 "Default": 4456, 2748 "Type": 0, 2749 "TypeHint": 2, 2750 "Format": "", 2751 "Pattern": null, 2752 "Enum": null, 2753 "Constant": null, 2754 "ReadOnly": false, 2755 "MinLength": -1, 2756 "MaxLength": -1, 2757 "Required": false, 2758 "Minimum": null, 2759 "Maximum": null, 2760 "MultipleOf": null, 2761 "CustomProperties": null 2762 }, 2763 { 2764 "Title": "HTTPS", 2765 "Description": "Configure HTTP over TLS (HTTPS). All options can also be set using environment variables by replacing dots (`.`) with underscores (`_`) and uppercasing the key. For example, `some.prefix.tls.key.path` becomes `export SOME_PREFIX_TLS_KEY_PATH`. If all keys are left undefined, TLS will be disabled.", 2766 "Examples": null, 2767 "Name": "serve.api.tls", 2768 "Default": null, 2769 "Type": {}, 2770 "TypeHint": 5, 2771 "Format": "", 2772 "Pattern": null, 2773 "Enum": null, 2774 "Constant": null, 2775 "ReadOnly": false, 2776 "MinLength": -1, 2777 "MaxLength": -1, 2778 "Required": false, 2779 "Minimum": null, 2780 "Maximum": null, 2781 "MultipleOf": null, 2782 "CustomProperties": null 2783 }, 2784 { 2785 "Title": "", 2786 "Description": "", 2787 "Examples": null, 2788 "Name": "serve.api.tls.cert", 2789 "Default": null, 2790 "Type": {}, 2791 "TypeHint": 5, 2792 "Format": "", 2793 "Pattern": null, 2794 "Enum": null, 2795 "Constant": null, 2796 "ReadOnly": false, 2797 "MinLength": -1, 2798 "MaxLength": -1, 2799 "Required": false, 2800 "Minimum": null, 2801 "Maximum": null, 2802 "MultipleOf": null, 2803 "CustomProperties": null 2804 }, 2805 { 2806 "Title": "Base64 Encoded Inline", 2807 "Description": "The base64 string of the PEM-encoded file content. Can be generated using for example `base64 -i path/to/file.pem`.", 2808 "Examples": [ 2809 "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tXG5NSUlEWlRDQ0FrMmdBd0lCQWdJRVY1eE90REFOQmdr..." 2810 ], 2811 "Name": "serve.api.tls.cert.base64", 2812 "Default": null, 2813 "Type": "", 2814 "TypeHint": 1, 2815 "Format": "", 2816 "Pattern": null, 2817 "Enum": null, 2818 "Constant": null, 2819 "ReadOnly": false, 2820 "MinLength": -1, 2821 "MaxLength": -1, 2822 "Required": false, 2823 "Minimum": null, 2824 "Maximum": null, 2825 "MultipleOf": null, 2826 "CustomProperties": null 2827 }, 2828 { 2829 "Title": "Path to PEM-encoded Fle", 2830 "Description": "", 2831 "Examples": [ 2832 "path/to/file.pem" 2833 ], 2834 "Name": "serve.api.tls.cert.path", 2835 "Default": null, 2836 "Type": "", 2837 "TypeHint": 1, 2838 "Format": "", 2839 "Pattern": null, 2840 "Enum": null, 2841 "Constant": null, 2842 "ReadOnly": false, 2843 "MinLength": -1, 2844 "MaxLength": -1, 2845 "Required": false, 2846 "Minimum": null, 2847 "Maximum": null, 2848 "MultipleOf": null, 2849 "CustomProperties": null 2850 }, 2851 { 2852 "Title": "", 2853 "Description": "", 2854 "Examples": null, 2855 "Name": "serve.api.tls.key", 2856 "Default": null, 2857 "Type": {}, 2858 "TypeHint": 5, 2859 "Format": "", 2860 "Pattern": null, 2861 "Enum": null, 2862 "Constant": null, 2863 "ReadOnly": false, 2864 "MinLength": -1, 2865 "MaxLength": -1, 2866 "Required": false, 2867 "Minimum": null, 2868 "Maximum": null, 2869 "MultipleOf": null, 2870 "CustomProperties": null 2871 }, 2872 { 2873 "Title": "Base64 Encoded Inline", 2874 "Description": "The base64 string of the PEM-encoded file content. Can be generated using for example `base64 -i path/to/file.pem`.", 2875 "Examples": [ 2876 "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tXG5NSUlEWlRDQ0FrMmdBd0lCQWdJRVY1eE90REFOQmdr..." 2877 ], 2878 "Name": "serve.api.tls.key.base64", 2879 "Default": null, 2880 "Type": "", 2881 "TypeHint": 1, 2882 "Format": "", 2883 "Pattern": null, 2884 "Enum": null, 2885 "Constant": null, 2886 "ReadOnly": false, 2887 "MinLength": -1, 2888 "MaxLength": -1, 2889 "Required": false, 2890 "Minimum": null, 2891 "Maximum": null, 2892 "MultipleOf": null, 2893 "CustomProperties": null 2894 }, 2895 { 2896 "Title": "Path to PEM-encoded Fle", 2897 "Description": "", 2898 "Examples": [ 2899 "path/to/file.pem" 2900 ], 2901 "Name": "serve.api.tls.key.path", 2902 "Default": null, 2903 "Type": "", 2904 "TypeHint": 1, 2905 "Format": "", 2906 "Pattern": null, 2907 "Enum": null, 2908 "Constant": null, 2909 "ReadOnly": false, 2910 "MinLength": -1, 2911 "MaxLength": -1, 2912 "Required": false, 2913 "Minimum": null, 2914 "Maximum": null, 2915 "MultipleOf": null, 2916 "CustomProperties": null 2917 }, 2918 { 2919 "Title": "HTTP Reverse Proxy", 2920 "Description": "", 2921 "Examples": null, 2922 "Name": "serve.proxy", 2923 "Default": null, 2924 "Type": {}, 2925 "TypeHint": 5, 2926 "Format": "", 2927 "Pattern": null, 2928 "Enum": null, 2929 "Constant": null, 2930 "ReadOnly": false, 2931 "MinLength": -1, 2932 "MaxLength": -1, 2933 "Required": false, 2934 "Minimum": null, 2935 "Maximum": null, 2936 "MultipleOf": null, 2937 "CustomProperties": null 2938 }, 2939 { 2940 "Title": "Cross Origin Resource Sharing (CORS)", 2941 "Description": "Configure [Cross Origin Resource Sharing (CORS)](http://www.w3.org/TR/cors/) using the following options.", 2942 "Examples": null, 2943 "Name": "serve.proxy.cors", 2944 "Default": null, 2945 "Type": {}, 2946 "TypeHint": 5, 2947 "Format": "", 2948 "Pattern": null, 2949 "Enum": null, 2950 "Constant": null, 2951 "ReadOnly": false, 2952 "MinLength": -1, 2953 "MaxLength": -1, 2954 "Required": false, 2955 "Minimum": null, 2956 "Maximum": null, 2957 "MultipleOf": null, 2958 "CustomProperties": null 2959 }, 2960 { 2961 "Title": "Allow HTTP Credentials", 2962 "Description": "Indicates whether the request can include user credentials like cookies, HTTP authentication or client side SSL certificates.", 2963 "Examples": null, 2964 "Name": "serve.proxy.cors.allow_credentials", 2965 "Default": false, 2966 "Type": false, 2967 "TypeHint": 4, 2968 "Format": "", 2969 "Pattern": null, 2970 "Enum": null, 2971 "Constant": null, 2972 "ReadOnly": false, 2973 "MinLength": -1, 2974 "MaxLength": -1, 2975 "Required": false, 2976 "Minimum": null, 2977 "Maximum": null, 2978 "MultipleOf": null, 2979 "CustomProperties": null 2980 }, 2981 { 2982 "Title": "Allowed Request HTTP Headers", 2983 "Description": "A list of non simple headers the client is allowed to use with cross-domain requests.", 2984 "Examples": null, 2985 "Name": "serve.proxy.cors.allowed_headers", 2986 "Default": [ 2987 "Authorization", 2988 "Content-Type" 2989 ], 2990 "Type": [], 2991 "TypeHint": 8, 2992 "Format": "", 2993 "Pattern": null, 2994 "Enum": null, 2995 "Constant": null, 2996 "ReadOnly": false, 2997 "MinLength": 1, 2998 "MaxLength": -1, 2999 "Required": false, 3000 "Minimum": null, 3001 "Maximum": null, 3002 "MultipleOf": null, 3003 "CustomProperties": null 3004 }, 3005 { 3006 "Title": "", 3007 "Description": "", 3008 "Examples": null, 3009 "Name": "serve.proxy.cors.allowed_headers.#", 3010 "Default": null, 3011 "Type": "", 3012 "TypeHint": 1, 3013 "Format": "", 3014 "Pattern": null, 3015 "Enum": null, 3016 "Constant": null, 3017 "ReadOnly": false, 3018 "MinLength": -1, 3019 "MaxLength": -1, 3020 "Required": false, 3021 "Minimum": null, 3022 "Maximum": null, 3023 "MultipleOf": null, 3024 "CustomProperties": null 3025 }, 3026 { 3027 "Title": "Allowed HTTP Methods", 3028 "Description": "A list of methods the client is allowed to use with cross-domain requests.", 3029 "Examples": null, 3030 "Name": "serve.proxy.cors.allowed_methods", 3031 "Default": [ 3032 "GET", 3033 "POST", 3034 "PUT", 3035 "PATCH", 3036 "DELETE" 3037 ], 3038 "Type": [], 3039 "TypeHint": 8, 3040 "Format": "", 3041 "Pattern": null, 3042 "Enum": null, 3043 "Constant": null, 3044 "ReadOnly": false, 3045 "MinLength": -1, 3046 "MaxLength": -1, 3047 "Required": false, 3048 "Minimum": null, 3049 "Maximum": null, 3050 "MultipleOf": null, 3051 "CustomProperties": null 3052 }, 3053 { 3054 "Title": "", 3055 "Description": "", 3056 "Examples": null, 3057 "Name": "serve.proxy.cors.allowed_methods.#", 3058 "Default": null, 3059 "Type": "", 3060 "TypeHint": 1, 3061 "Format": "", 3062 "Pattern": null, 3063 "Enum": [ 3064 "GET", 3065 "HEAD", 3066 "POST", 3067 "PUT", 3068 "DELETE", 3069 "CONNECT", 3070 "TRACE", 3071 "PATCH" 3072 ], 3073 "Constant": null, 3074 "ReadOnly": false, 3075 "MinLength": -1, 3076 "MaxLength": -1, 3077 "Required": false, 3078 "Minimum": null, 3079 "Maximum": null, 3080 "MultipleOf": null, 3081 "CustomProperties": null 3082 }, 3083 { 3084 "Title": "Allowed Origins", 3085 "Description": "A list of origins a cross-domain request can be executed from. If the special * value is present in the list, all origins will be allowed. An origin may contain a wildcard (*) to replace 0 or more characters (i.e.: http://*.domain.com). Usage of wildcards implies a small performance penality. Only one wildcard can be used per origin.", 3086 "Examples": [ 3087 "https://example.com", 3088 "https://*.example.com", 3089 "https://*.foo.example.com" 3090 ], 3091 "Name": "serve.proxy.cors.allowed_origins", 3092 "Default": [ 3093 "*" 3094 ], 3095 "Type": [], 3096 "TypeHint": 8, 3097 "Format": "", 3098 "Pattern": null, 3099 "Enum": null, 3100 "Constant": null, 3101 "ReadOnly": false, 3102 "MinLength": -1, 3103 "MaxLength": -1, 3104 "Required": false, 3105 "Minimum": null, 3106 "Maximum": null, 3107 "MultipleOf": null, 3108 "CustomProperties": null 3109 }, 3110 { 3111 "Title": "", 3112 "Description": "", 3113 "Examples": null, 3114 "Name": "serve.proxy.cors.allowed_origins.#", 3115 "Default": null, 3116 "Type": "", 3117 "TypeHint": 1, 3118 "Format": "", 3119 "Pattern": null, 3120 "Enum": null, 3121 "Constant": null, 3122 "ReadOnly": false, 3123 "MinLength": 1, 3124 "MaxLength": -1, 3125 "Required": false, 3126 "Minimum": null, 3127 "Maximum": null, 3128 "MultipleOf": null, 3129 "CustomProperties": null 3130 }, 3131 { 3132 "Title": "Enable Debugging", 3133 "Description": "Set to true to debug server side CORS issues.", 3134 "Examples": null, 3135 "Name": "serve.proxy.cors.debug", 3136 "Default": false, 3137 "Type": false, 3138 "TypeHint": 4, 3139 "Format": "", 3140 "Pattern": null, 3141 "Enum": null, 3142 "Constant": null, 3143 "ReadOnly": false, 3144 "MinLength": -1, 3145 "MaxLength": -1, 3146 "Required": false, 3147 "Minimum": null, 3148 "Maximum": null, 3149 "MultipleOf": null, 3150 "CustomProperties": null 3151 }, 3152 { 3153 "Title": "Enable CORS", 3154 "Description": "If set to true, CORS will be enabled and preflight-requests (OPTION) will be answered.", 3155 "Examples": null, 3156 "Name": "serve.proxy.cors.enabled", 3157 "Default": false, 3158 "Type": false, 3159 "TypeHint": 4, 3160 "Format": "", 3161 "Pattern": null, 3162 "Enum": null, 3163 "Constant": null, 3164 "ReadOnly": false, 3165 "MinLength": -1, 3166 "MaxLength": -1, 3167 "Required": false, 3168 "Minimum": null, 3169 "Maximum": null, 3170 "MultipleOf": null, 3171 "CustomProperties": null 3172 }, 3173 { 3174 "Title": "Allowed Response HTTP Headers", 3175 "Description": "Indicates which headers are safe to expose to the API of a CORS API specification", 3176 "Examples": null, 3177 "Name": "serve.proxy.cors.exposed_headers", 3178 "Default": [ 3179 "Content-Type" 3180 ], 3181 "Type": [], 3182 "TypeHint": 8, 3183 "Format": "", 3184 "Pattern": null, 3185 "Enum": null, 3186 "Constant": null, 3187 "ReadOnly": false, 3188 "MinLength": 1, 3189 "MaxLength": -1, 3190 "Required": false, 3191 "Minimum": null, 3192 "Maximum": null, 3193 "MultipleOf": null, 3194 "CustomProperties": null 3195 }, 3196 { 3197 "Title": "", 3198 "Description": "", 3199 "Examples": null, 3200 "Name": "serve.proxy.cors.exposed_headers.#", 3201 "Default": null, 3202 "Type": "", 3203 "TypeHint": 1, 3204 "Format": "", 3205 "Pattern": null, 3206 "Enum": null, 3207 "Constant": null, 3208 "ReadOnly": false, 3209 "MinLength": -1, 3210 "MaxLength": -1, 3211 "Required": false, 3212 "Minimum": null, 3213 "Maximum": null, 3214 "MultipleOf": null, 3215 "CustomProperties": null 3216 }, 3217 { 3218 "Title": "Maximum Age", 3219 "Description": "Indicates how long (in seconds) the results of a preflight request can be cached. The default is 0 which stands for no max age.", 3220 "Examples": null, 3221 "Name": "serve.proxy.cors.max_age", 3222 "Default": 0, 3223 "Type": 0, 3224 "TypeHint": 2, 3225 "Format": "", 3226 "Pattern": null, 3227 "Enum": null, 3228 "Constant": null, 3229 "ReadOnly": false, 3230 "MinLength": -1, 3231 "MaxLength": -1, 3232 "Required": false, 3233 "Minimum": null, 3234 "Maximum": null, 3235 "MultipleOf": null, 3236 "CustomProperties": null 3237 }, 3238 { 3239 "Title": "Host", 3240 "Description": "The network interface to listen on. Leave empty to listen on all interfaces.", 3241 "Examples": [ 3242 "localhost", 3243 "127.0.0.1" 3244 ], 3245 "Name": "serve.proxy.host", 3246 "Default": "", 3247 "Type": "", 3248 "TypeHint": 1, 3249 "Format": "", 3250 "Pattern": null, 3251 "Enum": null, 3252 "Constant": null, 3253 "ReadOnly": false, 3254 "MinLength": -1, 3255 "MaxLength": -1, 3256 "Required": false, 3257 "Minimum": null, 3258 "Maximum": null, 3259 "MultipleOf": null, 3260 "CustomProperties": null 3261 }, 3262 { 3263 "Title": "Port", 3264 "Description": "The port to listen on.", 3265 "Examples": null, 3266 "Name": "serve.proxy.port", 3267 "Default": 4455, 3268 "Type": 0, 3269 "TypeHint": 2, 3270 "Format": "", 3271 "Pattern": null, 3272 "Enum": null, 3273 "Constant": null, 3274 "ReadOnly": false, 3275 "MinLength": -1, 3276 "MaxLength": -1, 3277 "Required": false, 3278 "Minimum": null, 3279 "Maximum": null, 3280 "MultipleOf": null, 3281 "CustomProperties": null 3282 }, 3283 { 3284 "Title": "HTTP Timeouts", 3285 "Description": "Control the reverse proxy's HTTP timeouts.", 3286 "Examples": null, 3287 "Name": "serve.proxy.timeout", 3288 "Default": null, 3289 "Type": {}, 3290 "TypeHint": 5, 3291 "Format": "", 3292 "Pattern": null, 3293 "Enum": null, 3294 "Constant": null, 3295 "ReadOnly": false, 3296 "MinLength": -1, 3297 "MaxLength": -1, 3298 "Required": false, 3299 "Minimum": null, 3300 "Maximum": null, 3301 "MultipleOf": null, 3302 "CustomProperties": null 3303 }, 3304 { 3305 "Title": "HTTP Idle Timeout", 3306 "Description": " The maximum amount of time to wait for any action of a request session, reading data or writing the response.", 3307 "Examples": [ 3308 "5s", 3309 "5m", 3310 "5h" 3311 ], 3312 "Name": "serve.proxy.timeout.idle", 3313 "Default": "120s", 3314 "Type": "", 3315 "TypeHint": 1, 3316 "Format": "", 3317 "Pattern": {}, 3318 "Enum": null, 3319 "Constant": null, 3320 "ReadOnly": false, 3321 "MinLength": -1, 3322 "MaxLength": -1, 3323 "Required": false, 3324 "Minimum": null, 3325 "Maximum": null, 3326 "MultipleOf": null, 3327 "CustomProperties": null 3328 }, 3329 { 3330 "Title": "HTTP Read Timeout", 3331 "Description": "The maximum duration for reading the entire request, including the body.", 3332 "Examples": [ 3333 "5s", 3334 "5m", 3335 "5h" 3336 ], 3337 "Name": "serve.proxy.timeout.read", 3338 "Default": "5s", 3339 "Type": "", 3340 "TypeHint": 1, 3341 "Format": "", 3342 "Pattern": {}, 3343 "Enum": null, 3344 "Constant": null, 3345 "ReadOnly": false, 3346 "MinLength": -1, 3347 "MaxLength": -1, 3348 "Required": false, 3349 "Minimum": null, 3350 "Maximum": null, 3351 "MultipleOf": null, 3352 "CustomProperties": null 3353 }, 3354 { 3355 "Title": "HTTP Write Timeout", 3356 "Description": "The maximum duration before timing out writes of the response. Increase this parameter to prevent unexpected closing a client connection if an upstream request is responding slowly.", 3357 "Examples": [ 3358 "5s", 3359 "5m", 3360 "5h" 3361 ], 3362 "Name": "serve.proxy.timeout.write", 3363 "Default": "120s", 3364 "Type": "", 3365 "TypeHint": 1, 3366 "Format": "", 3367 "Pattern": {}, 3368 "Enum": null, 3369 "Constant": null, 3370 "ReadOnly": false, 3371 "MinLength": -1, 3372 "MaxLength": -1, 3373 "Required": false, 3374 "Minimum": null, 3375 "Maximum": null, 3376 "MultipleOf": null, 3377 "CustomProperties": null 3378 }, 3379 { 3380 "Title": "HTTPS", 3381 "Description": "Configure HTTP over TLS (HTTPS). All options can also be set using environment variables by replacing dots (`.`) with underscores (`_`) and uppercasing the key. For example, `some.prefix.tls.key.path` becomes `export SOME_PREFIX_TLS_KEY_PATH`. If all keys are left undefined, TLS will be disabled.", 3382 "Examples": null, 3383 "Name": "serve.proxy.tls", 3384 "Default": null, 3385 "Type": {}, 3386 "TypeHint": 5, 3387 "Format": "", 3388 "Pattern": null, 3389 "Enum": null, 3390 "Constant": null, 3391 "ReadOnly": false, 3392 "MinLength": -1, 3393 "MaxLength": -1, 3394 "Required": false, 3395 "Minimum": null, 3396 "Maximum": null, 3397 "MultipleOf": null, 3398 "CustomProperties": null 3399 }, 3400 { 3401 "Title": "", 3402 "Description": "", 3403 "Examples": null, 3404 "Name": "serve.proxy.tls.cert", 3405 "Default": null, 3406 "Type": {}, 3407 "TypeHint": 5, 3408 "Format": "", 3409 "Pattern": null, 3410 "Enum": null, 3411 "Constant": null, 3412 "ReadOnly": false, 3413 "MinLength": -1, 3414 "MaxLength": -1, 3415 "Required": false, 3416 "Minimum": null, 3417 "Maximum": null, 3418 "MultipleOf": null, 3419 "CustomProperties": null 3420 }, 3421 { 3422 "Title": "Base64 Encoded Inline", 3423 "Description": "The base64 string of the PEM-encoded file content. Can be generated using for example `base64 -i path/to/file.pem`.", 3424 "Examples": [ 3425 "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tXG5NSUlEWlRDQ0FrMmdBd0lCQWdJRVY1eE90REFOQmdr..." 3426 ], 3427 "Name": "serve.proxy.tls.cert.base64", 3428 "Default": null, 3429 "Type": "", 3430 "TypeHint": 1, 3431 "Format": "", 3432 "Pattern": null, 3433 "Enum": null, 3434 "Constant": null, 3435 "ReadOnly": false, 3436 "MinLength": -1, 3437 "MaxLength": -1, 3438 "Required": false, 3439 "Minimum": null, 3440 "Maximum": null, 3441 "MultipleOf": null, 3442 "CustomProperties": null 3443 }, 3444 { 3445 "Title": "Path to PEM-encoded Fle", 3446 "Description": "", 3447 "Examples": [ 3448 "path/to/file.pem" 3449 ], 3450 "Name": "serve.proxy.tls.cert.path", 3451 "Default": null, 3452 "Type": "", 3453 "TypeHint": 1, 3454 "Format": "", 3455 "Pattern": null, 3456 "Enum": null, 3457 "Constant": null, 3458 "ReadOnly": false, 3459 "MinLength": -1, 3460 "MaxLength": -1, 3461 "Required": false, 3462 "Minimum": null, 3463 "Maximum": null, 3464 "MultipleOf": null, 3465 "CustomProperties": null 3466 }, 3467 { 3468 "Title": "", 3469 "Description": "", 3470 "Examples": null, 3471 "Name": "serve.proxy.tls.key", 3472 "Default": null, 3473 "Type": {}, 3474 "TypeHint": 5, 3475 "Format": "", 3476 "Pattern": null, 3477 "Enum": null, 3478 "Constant": null, 3479 "ReadOnly": false, 3480 "MinLength": -1, 3481 "MaxLength": -1, 3482 "Required": false, 3483 "Minimum": null, 3484 "Maximum": null, 3485 "MultipleOf": null, 3486 "CustomProperties": null 3487 }, 3488 { 3489 "Title": "Base64 Encoded Inline", 3490 "Description": "The base64 string of the PEM-encoded file content. Can be generated using for example `base64 -i path/to/file.pem`.", 3491 "Examples": [ 3492 "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tXG5NSUlEWlRDQ0FrMmdBd0lCQWdJRVY1eE90REFOQmdr..." 3493 ], 3494 "Name": "serve.proxy.tls.key.base64", 3495 "Default": null, 3496 "Type": "", 3497 "TypeHint": 1, 3498 "Format": "", 3499 "Pattern": null, 3500 "Enum": null, 3501 "Constant": null, 3502 "ReadOnly": false, 3503 "MinLength": -1, 3504 "MaxLength": -1, 3505 "Required": false, 3506 "Minimum": null, 3507 "Maximum": null, 3508 "MultipleOf": null, 3509 "CustomProperties": null 3510 }, 3511 { 3512 "Title": "Path to PEM-encoded Fle", 3513 "Description": "", 3514 "Examples": [ 3515 "path/to/file.pem" 3516 ], 3517 "Name": "serve.proxy.tls.key.path", 3518 "Default": null, 3519 "Type": "", 3520 "TypeHint": 1, 3521 "Format": "", 3522 "Pattern": null, 3523 "Enum": null, 3524 "Constant": null, 3525 "ReadOnly": false, 3526 "MinLength": -1, 3527 "MaxLength": -1, 3528 "Required": false, 3529 "Minimum": null, 3530 "Maximum": null, 3531 "MultipleOf": null, 3532 "CustomProperties": null 3533 } 3534 ]