├── Auth0 Authentication API.postman_collection.json ├── Auth0 Management API v2.postman_collection.json └── README.md /Auth0 Authentication API.postman_collection.json: -------------------------------------------------------------------------------- 1 | { 2 | "info": { 3 | "_postman_id": "5bbbf61e-9d74-4a20-be50-a0ed9c10c548", 4 | "name": "Auth0 Authentication API", 5 | "description": "The Authentication API exposes all of the identity functionality of Auth0 as well as all of the supported identity protocols such as OpenID Connect, OAuth, and SAML. Generally speaking you will consume this API through one of our SDKs like Auth0.js or libraries such as the Lock widget. However, if you are building all of your authentication UI manually you will likely interact with this API directly.", 6 | "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" 7 | }, 8 | "item": [ 9 | { 10 | "name": "DB Connections", 11 | "item": [ 12 | { 13 | "name": "Signup using a username/password", 14 | "request": { 15 | "method": "POST", 16 | "header": [], 17 | "body": { 18 | "mode": "urlencoded", 19 | "urlencoded": [ 20 | { 21 | "key": "client_id", 22 | "value": null, 23 | "type": "text" 24 | }, 25 | { 26 | "key": "email", 27 | "value": null, 28 | "type": "text" 29 | }, 30 | { 31 | "key": "password", 32 | "value": null, 33 | "type": "text" 34 | }, 35 | { 36 | "key": "connection", 37 | "value": null, 38 | "type": "text" 39 | } 40 | ] 41 | }, 42 | "url": { 43 | "raw": "https://{{auth0_domain}}/dbconnections/signup", 44 | "protocol": "https", 45 | "host": [ 46 | "{{auth0_domain}}" 47 | ], 48 | "path": [ 49 | "dbconnections", 50 | "signup" 51 | ] 52 | }, 53 | "description": "Given the user credentials, the connection specified and the Auth0 account information, it will create a new user. You can then authenticate with this user using the /oauth/ro endpoint. This endpoint only works for database connections." 54 | }, 55 | "response": [] 56 | }, 57 | { 58 | "name": "Ask to change a password for a given user", 59 | "request": { 60 | "method": "POST", 61 | "header": [], 62 | "body": { 63 | "mode": "urlencoded", 64 | "urlencoded": [ 65 | { 66 | "key": "client_id", 67 | "value": null, 68 | "type": "text" 69 | }, 70 | { 71 | "key": "email", 72 | "value": null, 73 | "type": "text" 74 | }, 75 | { 76 | "key": "password", 77 | "value": null, 78 | "type": "text" 79 | }, 80 | { 81 | "key": "connection", 82 | "value": null, 83 | "type": "text" 84 | } 85 | ] 86 | }, 87 | "url": { 88 | "raw": "https://{{auth0_domain}}/dbconnections/change_password", 89 | "protocol": "https", 90 | "host": [ 91 | "{{auth0_domain}}" 92 | ], 93 | "path": [ 94 | "dbconnections", 95 | "change_password" 96 | ] 97 | }, 98 | "description": "Given the user email address and the connection specified, Auth0 will send a change password email.\n\n* If password was provided, once the user clicks on the confirm password change link, the new password specified in this POST will be set to this user.\n* If password was NOT provided, once the user clicks on the password change link they will be redirected to a page asking them for a new password.\n\nThis endpoint only works for database connections." 99 | }, 100 | "response": [] 101 | } 102 | ] 103 | }, 104 | { 105 | "name": "Get Access Token", 106 | "item": [ 107 | { 108 | "name": "Authorization Code", 109 | "request": { 110 | "method": "POST", 111 | "header": [], 112 | "body": { 113 | "mode": "urlencoded", 114 | "urlencoded": [ 115 | { 116 | "key": "grant_type", 117 | "value": "authorization_code", 118 | "type": "text" 119 | }, 120 | { 121 | "key": "client_id", 122 | "value": "", 123 | "type": "text" 124 | }, 125 | { 126 | "key": "client_secret", 127 | "value": "", 128 | "type": "text" 129 | }, 130 | { 131 | "key": "code", 132 | "value": "", 133 | "type": "text" 134 | }, 135 | { 136 | "key": "redirect_uri", 137 | "value": "", 138 | "type": "text" 139 | } 140 | ] 141 | }, 142 | "url": { 143 | "raw": "https://{{auth0_domain}}/oauth/token", 144 | "protocol": "https", 145 | "host": [ 146 | "{{auth0_domain}}" 147 | ], 148 | "path": [ 149 | "oauth", 150 | "token" 151 | ] 152 | }, 153 | "description": "This is the OAuth 2.0 grant that regular web apps utilize in order to access an API. Use this endpoint to exchange an Authorization Code for an Access Token." 154 | }, 155 | "response": [] 156 | }, 157 | { 158 | "name": "Authorization Code (PKCE)", 159 | "request": { 160 | "method": "POST", 161 | "header": [], 162 | "body": { 163 | "mode": "urlencoded", 164 | "urlencoded": [ 165 | { 166 | "key": "grant_type", 167 | "value": "authorization_code", 168 | "type": "text" 169 | }, 170 | { 171 | "key": "client_id", 172 | "value": "", 173 | "type": "text" 174 | }, 175 | { 176 | "key": "code", 177 | "value": "", 178 | "type": "text" 179 | }, 180 | { 181 | "key": "code_verifier", 182 | "value": "", 183 | "type": "text" 184 | }, 185 | { 186 | "key": "redirect_uri", 187 | "value": "", 188 | "type": "text" 189 | } 190 | ] 191 | }, 192 | "url": { 193 | "raw": "https://{{auth0_domain}}/oauth/token", 194 | "protocol": "https", 195 | "host": [ 196 | "{{auth0_domain}}" 197 | ], 198 | "path": [ 199 | "oauth", 200 | "token" 201 | ] 202 | }, 203 | "description": "This is the OAuth 2.0 grant that mobile apps utilize in order to access an API. Use this endpoint to exchange an Authorization Code for an Access Token." 204 | }, 205 | "response": [] 206 | }, 207 | { 208 | "name": "Client Credentials", 209 | "request": { 210 | "method": "POST", 211 | "header": [], 212 | "body": { 213 | "mode": "urlencoded", 214 | "urlencoded": [ 215 | { 216 | "key": "grant_type", 217 | "value": "client_credentials", 218 | "type": "text" 219 | }, 220 | { 221 | "key": "client_id", 222 | "value": "", 223 | "type": "text" 224 | }, 225 | { 226 | "key": "client_secret", 227 | "value": "", 228 | "type": "text" 229 | }, 230 | { 231 | "key": "audience", 232 | "value": "", 233 | "type": "text" 234 | } 235 | ] 236 | }, 237 | "url": { 238 | "raw": "https://{{auth0_domain}}/oauth/token", 239 | "protocol": "https", 240 | "host": [ 241 | "{{auth0_domain}}" 242 | ], 243 | "path": [ 244 | "oauth", 245 | "token" 246 | ] 247 | }, 248 | "description": "This is the OAuth 2.0 grant that server processes utilize in order to access an API. Use this endpoint to directly request an `access_token` by using the Client Credentials (a Client Id and a Client Secret)." 249 | }, 250 | "response": [] 251 | }, 252 | { 253 | "name": "Resource Owner Password", 254 | "request": { 255 | "method": "POST", 256 | "header": [], 257 | "body": { 258 | "mode": "urlencoded", 259 | "urlencoded": [ 260 | { 261 | "key": "grant_type", 262 | "value": "password", 263 | "type": "text" 264 | }, 265 | { 266 | "key": "client_id", 267 | "value": "", 268 | "type": "text" 269 | }, 270 | { 271 | "key": "client_secret", 272 | "value": "", 273 | "description": "Required for confidential clients.", 274 | "type": "text", 275 | "disabled": true 276 | }, 277 | { 278 | "key": "audience", 279 | "value": "", 280 | "type": "text" 281 | }, 282 | { 283 | "key": "username", 284 | "value": "", 285 | "type": "text" 286 | }, 287 | { 288 | "key": "password", 289 | "value": "", 290 | "type": "text" 291 | }, 292 | { 293 | "key": "scope", 294 | "value": "", 295 | "type": "text" 296 | } 297 | ] 298 | }, 299 | "url": { 300 | "raw": "https://{{auth0_domain}}/oauth/token", 301 | "protocol": "https", 302 | "host": [ 303 | "{{auth0_domain}}" 304 | ], 305 | "path": [ 306 | "oauth", 307 | "token" 308 | ] 309 | }, 310 | "description": "This is the OAuth 2.0 grant that highly trusted apps utilize in order to access an API. In this flow the end-user is asked to fill in credentials (username/password) typically using an interactive form. This information is later on sent to the Client and the Authorization Server. It is therefore imperative that the Client is absolutely trusted with this information." 311 | }, 312 | "response": [] 313 | }, 314 | { 315 | "name": "Resource Owner Password (with realm)", 316 | "request": { 317 | "method": "POST", 318 | "header": [], 319 | "body": { 320 | "mode": "urlencoded", 321 | "urlencoded": [ 322 | { 323 | "key": "grant_type", 324 | "value": "http://auth0.com/oauth/grant-type/password-realm", 325 | "type": "text" 326 | }, 327 | { 328 | "key": "client_id", 329 | "value": "", 330 | "type": "text" 331 | }, 332 | { 333 | "key": "client_secret", 334 | "value": "", 335 | "description": "Required for confidential clients.", 336 | "type": "text", 337 | "disabled": true 338 | }, 339 | { 340 | "key": "audience", 341 | "value": "", 342 | "type": "text" 343 | }, 344 | { 345 | "key": "username", 346 | "value": "", 347 | "type": "text" 348 | }, 349 | { 350 | "key": "password", 351 | "value": "", 352 | "type": "text" 353 | }, 354 | { 355 | "key": "realm", 356 | "value": "", 357 | "description": "The connection to use.", 358 | "type": "text" 359 | }, 360 | { 361 | "key": "scope", 362 | "value": "", 363 | "type": "text" 364 | } 365 | ] 366 | }, 367 | "url": { 368 | "raw": "https://{{auth0_domain}}/oauth/token", 369 | "protocol": "https", 370 | "host": [ 371 | "{{auth0_domain}}" 372 | ], 373 | "path": [ 374 | "oauth", 375 | "token" 376 | ] 377 | }, 378 | "description": "This is the OAuth 2.0 grant that highly trusted apps utilize in order to access an API. In this flow the end-user is asked to fill in credentials (username/password) typically using an interactive form. This information is later on sent to the Client and the Authorization Server. It is therefore imperative that the Client is absolutely trusted with this information.\nWith this extension to the basic Resource Owner Password flow you can provide a `realm` value indicating the connection to use." 379 | }, 380 | "response": [] 381 | }, 382 | { 383 | "name": "Refresh Token", 384 | "request": { 385 | "method": "POST", 386 | "header": [ 387 | { 388 | "key": "Content-Type", 389 | "value": "application/x-www-form-urlencoded" 390 | } 391 | ], 392 | "body": { 393 | "mode": "urlencoded", 394 | "urlencoded": [ 395 | { 396 | "key": "grant_type", 397 | "value": "refresh_token", 398 | "type": "text" 399 | }, 400 | { 401 | "key": "client_id", 402 | "value": "", 403 | "type": "text" 404 | }, 405 | { 406 | "key": "client_secret", 407 | "value": "", 408 | "description": "Required for confidential clients.", 409 | "type": "text", 410 | "disabled": true 411 | }, 412 | { 413 | "key": "refresh_token", 414 | "value": "", 415 | "type": "text" 416 | }, 417 | { 418 | "key": "scope", 419 | "value": "", 420 | "description": "Optional. You can specify a scope that is equal or less than the one requested in the original authorize request.", 421 | "type": "text", 422 | "disabled": true 423 | } 424 | ] 425 | }, 426 | "url": { 427 | "raw": "https://{{auth0_domain}}/oauth/token", 428 | "protocol": "https", 429 | "host": [ 430 | "{{auth0_domain}}" 431 | ], 432 | "path": [ 433 | "oauth", 434 | "token" 435 | ] 436 | }, 437 | "description": "This is the OAuth2 refresh token flow, used to obtain a refreshed access token (and id token if applicable) using the refresh token you got during authorization." 438 | }, 439 | "response": [] 440 | } 441 | ] 442 | }, 443 | { 444 | "name": "Passwordless", 445 | "item": [ 446 | { 447 | "name": "Start Passwordless flow sending an email", 448 | "request": { 449 | "method": "POST", 450 | "header": [], 451 | "body": { 452 | "mode": "urlencoded", 453 | "urlencoded": [ 454 | { 455 | "key": "client_id", 456 | "value": null, 457 | "type": "text" 458 | }, 459 | { 460 | "key": "connection", 461 | "value": "email", 462 | "type": "text" 463 | }, 464 | { 465 | "key": "email", 466 | "value": null, 467 | "type": "text" 468 | }, 469 | { 470 | "key": "send", 471 | "value": "link", 472 | "type": "text" 473 | } 474 | ] 475 | }, 476 | "url": { 477 | "raw": "https://{{auth0_domain}}/passwordless/start", 478 | "protocol": "https", 479 | "host": [ 480 | "{{auth0_domain}}" 481 | ], 482 | "path": [ 483 | "passwordless", 484 | "start" 485 | ] 486 | }, 487 | "description": "Given the user email address, it will send an email with:\n\n* A link (default, send:\"link\"). You can then authenticate with this user opening the link and he will be automatically logged in to the application. Optionally, you can append/override parameters to the link (like scope, redirect_uri, protocol, response_type, etc.) using authParams object.\n* A verification code (send:\"code\"). You can then authenticate with this user using the /oauth/ro endpoint specifying email as username and code as password." 488 | }, 489 | "response": [] 490 | }, 491 | { 492 | "name": "Start Passwordless flow sending an SMS message", 493 | "request": { 494 | "method": "POST", 495 | "header": [], 496 | "body": { 497 | "mode": "urlencoded", 498 | "urlencoded": [ 499 | { 500 | "key": "client_id", 501 | "value": null, 502 | "type": "text" 503 | }, 504 | { 505 | "key": "connection", 506 | "value": "sms", 507 | "type": "text" 508 | }, 509 | { 510 | "key": "phone_number", 511 | "value": null, 512 | "type": "text" 513 | } 514 | ] 515 | }, 516 | "url": { 517 | "raw": "https://{{auth0_domain}}/passwordless/start", 518 | "protocol": "https", 519 | "host": [ 520 | "{{auth0_domain}}" 521 | ], 522 | "path": [ 523 | "passwordless", 524 | "start" 525 | ] 526 | }, 527 | "description": "Given the user phone_number, it will send a SMS message with a verification code. You can then authenticate with this user using the /oauth/ro endpoint specifying phone_number as username and code as password:" 528 | }, 529 | "response": [] 530 | } 531 | ] 532 | }, 533 | { 534 | "name": "SAML", 535 | "item": [ 536 | { 537 | "name": "Accepts a SAML request to initiate a login", 538 | "request": { 539 | "method": "GET", 540 | "header": [], 541 | "body": { 542 | "mode": "raw", 543 | "raw": "" 544 | }, 545 | "url": { 546 | "raw": "https://{{auth0_domain}}/samlp/:client_id?", 547 | "protocol": "https", 548 | "host": [ 549 | "{{auth0_domain}}" 550 | ], 551 | "path": [ 552 | "samlp", 553 | ":client_id" 554 | ], 555 | "query": [ 556 | { 557 | "key": "connection", 558 | "value": "", 559 | "disabled": true 560 | } 561 | ], 562 | "variable": [ 563 | { 564 | "key": "client_id", 565 | "value": null 566 | } 567 | ] 568 | }, 569 | "description": "Optionally, accepts a connection parameter to login with a specific provider. If no connection is specified, the Auth0 Login Page will be shown." 570 | }, 571 | "response": [] 572 | }, 573 | { 574 | "name": "Returns the SAML 2.0 metadata", 575 | "request": { 576 | "method": "GET", 577 | "header": [], 578 | "body": { 579 | "mode": "raw", 580 | "raw": "" 581 | }, 582 | "url": { 583 | "raw": "https://{{auth0_domain}}/samlp/metadata/:client_id", 584 | "protocol": "https", 585 | "host": [ 586 | "{{auth0_domain}}" 587 | ], 588 | "path": [ 589 | "samlp", 590 | "metadata", 591 | ":client_id" 592 | ], 593 | "variable": [ 594 | { 595 | "key": "client_id", 596 | "value": null 597 | } 598 | ] 599 | } 600 | }, 601 | "response": [] 602 | } 603 | ] 604 | }, 605 | { 606 | "name": "User Profile", 607 | "item": [ 608 | { 609 | "name": "Returns a user profile based on the Auth0 access token", 610 | "request": { 611 | "method": "GET", 612 | "header": [ 613 | { 614 | "key": "Authorization", 615 | "value": "Bearer YOUR_TOKEN_HERE" 616 | } 617 | ], 618 | "body": { 619 | "mode": "raw", 620 | "raw": "" 621 | }, 622 | "url": { 623 | "raw": "https://{{auth0_domain}}/userinfo", 624 | "protocol": "https", 625 | "host": [ 626 | "{{auth0_domain}}" 627 | ], 628 | "path": [ 629 | "userinfo" 630 | ] 631 | }, 632 | "description": "Returns the user information based on the Auth0 access token (obtained during login)." 633 | }, 634 | "response": [] 635 | } 636 | ] 637 | }, 638 | { 639 | "name": "WS-Fed", 640 | "item": [ 641 | { 642 | "name": "Accepts a WS-Fed request to initiate a login", 643 | "request": { 644 | "method": "GET", 645 | "header": [], 646 | "body": { 647 | "mode": "raw", 648 | "raw": "" 649 | }, 650 | "url": { 651 | "raw": "https://{{auth0_domain}}/wsfed/:client_id?", 652 | "protocol": "https", 653 | "host": [ 654 | "{{auth0_domain}}" 655 | ], 656 | "path": [ 657 | "wsfed", 658 | ":client_id" 659 | ], 660 | "query": [ 661 | { 662 | "key": "whr", 663 | "value": "", 664 | "description": "The realm (connection) [optional]", 665 | "disabled": true 666 | }, 667 | { 668 | "key": "wctx", 669 | "value": "", 670 | "description": "Your application context (state)", 671 | "disabled": true 672 | }, 673 | { 674 | "key": "wreply", 675 | "value": "", 676 | "description": "The callback URL (where to send the response)", 677 | "disabled": true 678 | }, 679 | { 680 | "key": "wtrealm", 681 | "value": "", 682 | "description": "Can be used instead of the client id", 683 | "disabled": true 684 | } 685 | ], 686 | "variable": [ 687 | { 688 | "key": "client_id", 689 | "value": null 690 | } 691 | ] 692 | }, 693 | "description": "The client id parameter is optional. You can use wtrealm as well." 694 | }, 695 | "response": [] 696 | }, 697 | { 698 | "name": "Requests a logout using WS-Fed", 699 | "request": { 700 | "method": "GET", 701 | "header": [], 702 | "body": { 703 | "mode": "raw", 704 | "raw": "" 705 | }, 706 | "url": { 707 | "raw": "https://{{auth0_domain}}/wsfed/:client_id?wa=wsignout1.0", 708 | "protocol": "https", 709 | "host": [ 710 | "{{auth0_domain}}" 711 | ], 712 | "path": [ 713 | "wsfed", 714 | ":client_id" 715 | ], 716 | "query": [ 717 | { 718 | "key": "wa", 719 | "value": "wsignout1.0" 720 | }, 721 | { 722 | "key": "wreply", 723 | "value": "", 724 | "description": "The callback URL (where to send the response)", 725 | "disabled": true 726 | } 727 | ], 728 | "variable": [ 729 | { 730 | "key": "client_id", 731 | "value": null 732 | } 733 | ] 734 | } 735 | }, 736 | "response": [] 737 | }, 738 | { 739 | "name": "Returns the WS-Federation Metadata", 740 | "request": { 741 | "method": "GET", 742 | "header": [], 743 | "body": { 744 | "mode": "raw", 745 | "raw": "" 746 | }, 747 | "url": { 748 | "raw": "https://{{auth0_domain}}/wsfed/FederationMetadata/2007-06/FederationMetadata.xml", 749 | "protocol": "https", 750 | "host": [ 751 | "{{auth0_domain}}" 752 | ], 753 | "path": [ 754 | "wsfed", 755 | "FederationMetadata", 756 | "2007-06", 757 | "FederationMetadata.xml" 758 | ] 759 | } 760 | }, 761 | "response": [] 762 | } 763 | ], 764 | "description": "The WS-Fed protocol is used for Microsoft applications (e.g.: Office365, Dynamics CRM, etc.). All the parameters of the SAML assertion can be modified through rules." 765 | }, 766 | { 767 | "name": "Deprecated", 768 | "item": [ 769 | { 770 | "name": "Authenticate", 771 | "item": [ 772 | { 773 | "name": "Login using a social provider's access token", 774 | "request": { 775 | "method": "POST", 776 | "header": [], 777 | "body": { 778 | "mode": "urlencoded", 779 | "urlencoded": [ 780 | { 781 | "key": "client_id", 782 | "value": null, 783 | "type": "text" 784 | }, 785 | { 786 | "key": "access_token", 787 | "value": null, 788 | "description": "The social provider's Access Token.", 789 | "type": "text" 790 | }, 791 | { 792 | "key": "connection", 793 | "value": null, 794 | "type": "text" 795 | }, 796 | { 797 | "key": "scope", 798 | "value": "openid", 799 | "type": "text" 800 | } 801 | ] 802 | }, 803 | "url": { 804 | "raw": "https://{{auth0_domain}}/oauth/access_token", 805 | "protocol": "https", 806 | "host": [ 807 | "{{auth0_domain}}" 808 | ], 809 | "path": [ 810 | "oauth", 811 | "access_token" 812 | ] 813 | }, 814 | "description": "Given the social provider's access_token and the connection specified, it will do the authentication on the provider and return a JSON with the access_token and id_token. Currently, this endpoint only works for Facebook, Google, Twitter and Weibo. **This endpoint has been deprecated**." 815 | }, 816 | "response": [] 817 | }, 818 | { 819 | "name": "Login using username and password", 820 | "request": { 821 | "method": "POST", 822 | "header": [], 823 | "body": { 824 | "mode": "urlencoded", 825 | "urlencoded": [ 826 | { 827 | "key": "grant_type", 828 | "value": "password", 829 | "type": "text" 830 | }, 831 | { 832 | "key": "client_id", 833 | "value": null, 834 | "type": "text" 835 | }, 836 | { 837 | "key": "username", 838 | "value": null, 839 | "type": "text" 840 | }, 841 | { 842 | "key": "password", 843 | "value": null, 844 | "type": "text" 845 | }, 846 | { 847 | "key": "connection", 848 | "value": null, 849 | "type": "text" 850 | }, 851 | { 852 | "key": "scope", 853 | "value": "openid", 854 | "type": "text" 855 | }, 856 | { 857 | "key": "device", 858 | "value": null, 859 | "type": "text" 860 | } 861 | ] 862 | }, 863 | "url": { 864 | "raw": "https://{{auth0_domain}}/oauth/ro", 865 | "protocol": "https", 866 | "host": [ 867 | "{{auth0_domain}}" 868 | ], 869 | "path": [ 870 | "oauth", 871 | "ro" 872 | ] 873 | }, 874 | "description": "Given the user credentials and the connection specified, it will do the authentication on the provider and return a JSON with the access_token and id_token. This endpoint only works for database connections, passwordless connections, Active Directory/LDAP, Windows Azure AD and ADFS.\n\n**This endpoint is being deprecated.** Please use the [Resource Owner Password flow](https://auth0.com/docs/api/authentication#resource-owner-password) instead." 875 | }, 876 | "response": [] 877 | }, 878 | { 879 | "name": "[Deprecated] Return a user profile based on the user's JWT", 880 | "request": { 881 | "method": "POST", 882 | "header": [], 883 | "body": { 884 | "mode": "urlencoded", 885 | "urlencoded": [ 886 | { 887 | "key": "id_token", 888 | "value": null, 889 | "type": "text" 890 | } 891 | ] 892 | }, 893 | "url": { 894 | "raw": "https://{{auth0_domain}}/tokeninfo", 895 | "protocol": "https", 896 | "host": [ 897 | "{{auth0_domain}}" 898 | ], 899 | "path": [ 900 | "tokeninfo" 901 | ] 902 | }, 903 | "description": "Validates a JSON Web Token (signature and expiration) and returns the user information associated with the user id (sub property) of the token." 904 | }, 905 | "response": [] 906 | } 907 | ], 908 | "_postman_isSubFolder": true 909 | }, 910 | { 911 | "name": "Delegated Authentication", 912 | "item": [ 913 | { 914 | "name": "Obtain a delegation token (from an id_token)", 915 | "request": { 916 | "method": "POST", 917 | "header": [], 918 | "body": { 919 | "mode": "urlencoded", 920 | "urlencoded": [ 921 | { 922 | "key": "client_id", 923 | "value": null, 924 | "type": "text" 925 | }, 926 | { 927 | "key": "grant_type", 928 | "value": "urn:ietf:params:oauth:grant-type:jwt-bearer", 929 | "type": "text" 930 | }, 931 | { 932 | "key": "id_token", 933 | "value": null, 934 | "type": "text" 935 | }, 936 | { 937 | "key": "target", 938 | "value": null, 939 | "type": "text" 940 | }, 941 | { 942 | "key": "scope", 943 | "value": null, 944 | "type": "text" 945 | }, 946 | { 947 | "key": "api_type", 948 | "value": null, 949 | "type": "text" 950 | } 951 | ] 952 | }, 953 | "url": { 954 | "raw": "https://{{auth0_domain}}/delegation", 955 | "protocol": "https", 956 | "host": [ 957 | "{{auth0_domain}}" 958 | ], 959 | "path": [ 960 | "delegation" 961 | ] 962 | }, 963 | "description": "Given an existing token, this endpoint will generate a new token signed with the target client secret. This is used to flow the identity of the user from the application to an API or across different APIs that are protected with different secrets. **This endpoint has been deprecated**." 964 | }, 965 | "response": [] 966 | }, 967 | { 968 | "name": "Obtain a delegation token (from a refresh_token)", 969 | "request": { 970 | "method": "POST", 971 | "header": [], 972 | "body": { 973 | "mode": "urlencoded", 974 | "urlencoded": [ 975 | { 976 | "key": "client_id", 977 | "value": null, 978 | "type": "text" 979 | }, 980 | { 981 | "key": "grant_type", 982 | "value": "urn:ietf:params:oauth:grant-type:jwt-bearer", 983 | "type": "text" 984 | }, 985 | { 986 | "key": "refresh_token", 987 | "value": null, 988 | "type": "text" 989 | }, 990 | { 991 | "key": "scope", 992 | "value": null, 993 | "type": "text" 994 | } 995 | ] 996 | }, 997 | "url": { 998 | "raw": "https://{{auth0_domain}}/delegation", 999 | "protocol": "https", 1000 | "host": [ 1001 | "{{auth0_domain}}" 1002 | ], 1003 | "path": [ 1004 | "delegation" 1005 | ] 1006 | }, 1007 | "description": "Given an refrersh token, this endpoint will generate a refreshed id_token and access_token. **This endpoint has been deprecated**, please use the [OAuth2 conformant Refresh Token flow](https://auth0.com/docs/tokens/refresh-token/current)." 1008 | }, 1009 | "response": [] 1010 | } 1011 | ], 1012 | "_postman_isSubFolder": true 1013 | }, 1014 | { 1015 | "name": "Link Accounts", 1016 | "item": [ 1017 | { 1018 | "name": "Unlink an account", 1019 | "request": { 1020 | "method": "POST", 1021 | "header": [], 1022 | "body": { 1023 | "mode": "urlencoded", 1024 | "urlencoded": [ 1025 | { 1026 | "key": "access_token", 1027 | "value": null, 1028 | "type": "text" 1029 | }, 1030 | { 1031 | "key": "user_id", 1032 | "value": null, 1033 | "type": "text" 1034 | } 1035 | ] 1036 | }, 1037 | "url": { 1038 | "raw": "https://{{auth0_domain}}/unlink", 1039 | "protocol": "https", 1040 | "host": [ 1041 | "{{auth0_domain}}" 1042 | ], 1043 | "path": [ 1044 | "unlink" 1045 | ] 1046 | }, 1047 | "description": "**This endpoint is deprecated**. The `DELETE /api/v2/users/{id}/identities/{provider}/{user_id}` (from Management API v2) should be used instead." 1048 | }, 1049 | "response": [] 1050 | } 1051 | ], 1052 | "_postman_isSubFolder": true 1053 | }, 1054 | { 1055 | "name": "Passwordless", 1056 | "item": [ 1057 | { 1058 | "name": "Login using a phone number and verification code", 1059 | "request": { 1060 | "method": "POST", 1061 | "header": [], 1062 | "body": { 1063 | "mode": "urlencoded", 1064 | "urlencoded": [ 1065 | { 1066 | "key": "client_id", 1067 | "value": null, 1068 | "type": "text" 1069 | }, 1070 | { 1071 | "key": "connection", 1072 | "value": "sms", 1073 | "type": "text" 1074 | }, 1075 | { 1076 | "key": "grant_type", 1077 | "value": "password", 1078 | "type": "text" 1079 | }, 1080 | { 1081 | "key": "username", 1082 | "value": null, 1083 | "type": "text" 1084 | }, 1085 | { 1086 | "key": "password", 1087 | "value": null, 1088 | "type": "text" 1089 | }, 1090 | { 1091 | "key": "scope", 1092 | "value": "openid", 1093 | "type": "text" 1094 | } 1095 | ] 1096 | }, 1097 | "url": { 1098 | "raw": "https://{{auth0_domain}}/oauth/ro", 1099 | "protocol": "https", 1100 | "host": [ 1101 | "{{auth0_domain}}" 1102 | ], 1103 | "path": [ 1104 | "oauth", 1105 | "ro" 1106 | ] 1107 | }, 1108 | "description": "Given the user credentials and the connection specified, it will do the authentication on the provider and return a JSON with the access_token and id_token. This endpoint only works for database connections, passwordless connections, Active Directory/LDAP, Windows Azure AD and ADFS.\n**This endpoint is deprecated**." 1109 | }, 1110 | "response": [] 1111 | } 1112 | ], 1113 | "_postman_isSubFolder": true 1114 | } 1115 | ], 1116 | "description": "These endpoints are deprecated and might not be available depending on the tenant's creation date and configuration in the **Migrations** section of the [tenant Advanced settings](https://manage.auth0.com/#/tenant/advanced).\nNewly created tenants don't have access to deprecated endpoints, so some or all of the legacy features can't be turned on in the **Migrations** section." 1117 | } 1118 | ] 1119 | } -------------------------------------------------------------------------------- /Auth0 Management API v2.postman_collection.json: -------------------------------------------------------------------------------- 1 | { 2 | "info": { 3 | "_postman_id": "9754013f-989f-48cb-9ac7-1d6d63fe9dfb", 4 | "name": "Auth0 Management API", 5 | "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" 6 | }, 7 | "item": [ 8 | { 9 | "name": "Blacklists", 10 | "item": [ 11 | { 12 | "name": "Get all blacklisted tokens", 13 | "request": { 14 | "method": "GET", 15 | "header": [ 16 | { 17 | "key": "Authorization", 18 | "value": "Bearer {{auth0_token}}" 19 | } 20 | ], 21 | "body": { 22 | "mode": "raw", 23 | "raw": "" 24 | }, 25 | "url": { 26 | "raw": "https://{{auth0_domain}}/api/v2/blacklists/tokens", 27 | "protocol": "https", 28 | "host": [ 29 | "{{auth0_domain}}" 30 | ], 31 | "path": [ 32 | "api", 33 | "v2", 34 | "blacklists", 35 | "tokens" 36 | ] 37 | }, 38 | "description": "Retrieves the jti and aud of all tokens in the blacklist." 39 | }, 40 | "response": [] 41 | }, 42 | { 43 | "name": "Blacklist a token", 44 | "request": { 45 | "method": "POST", 46 | "header": [ 47 | { 48 | "key": "Authorization", 49 | "value": "Bearer {{auth0_token}}" 50 | }, 51 | { 52 | "key": "Content-Type", 53 | "value": "application/json" 54 | } 55 | ], 56 | "body": { 57 | "mode": "raw", 58 | "raw": "{\r\n \"aud\": \"\",\r\n \"jti\": \"\"\r\n}" 59 | }, 60 | "url": { 61 | "raw": "https://{{auth0_domain}}/api/v2/blacklists/tokens", 62 | "protocol": "https", 63 | "host": [ 64 | "{{auth0_domain}}" 65 | ], 66 | "path": [ 67 | "api", 68 | "v2", 69 | "blacklists", 70 | "tokens" 71 | ] 72 | }, 73 | "description": "Adds the token identified by the jti to a blacklist for the tenant." 74 | }, 75 | "response": [] 76 | } 77 | ], 78 | "description": "Blacklists" 79 | }, 80 | { 81 | "name": "Client Grants", 82 | "item": [ 83 | { 84 | "name": "Get all client grants", 85 | "request": { 86 | "method": "GET", 87 | "header": [ 88 | { 89 | "key": "Authorization", 90 | "value": "Bearer {{auth0_token}}" 91 | } 92 | ], 93 | "body": { 94 | "mode": "raw", 95 | "raw": "" 96 | }, 97 | "url": { 98 | "raw": "https://{{auth0_domain}}/api/v2/client-grants", 99 | "protocol": "https", 100 | "host": [ 101 | "{{auth0_domain}}" 102 | ], 103 | "path": [ 104 | "api", 105 | "v2", 106 | "client-grants" 107 | ] 108 | } 109 | }, 110 | "response": [] 111 | }, 112 | { 113 | "name": "Create a client grant", 114 | "request": { 115 | "method": "POST", 116 | "header": [ 117 | { 118 | "key": "Authorization", 119 | "value": "Bearer {{auth0_token}}" 120 | }, 121 | { 122 | "key": "Content-Type", 123 | "value": "application/json" 124 | } 125 | ], 126 | "body": { 127 | "mode": "raw", 128 | "raw": "{\r\n \"client_id\": \"\",\r\n \"audience\": \"\",\r\n \"scope\": [\r\n \"\"\r\n ]\r\n}" 129 | }, 130 | "url": { 131 | "raw": "https://{{auth0_domain}}/api/v2/client-grants", 132 | "protocol": "https", 133 | "host": [ 134 | "{{auth0_domain}}" 135 | ], 136 | "path": [ 137 | "api", 138 | "v2", 139 | "client-grants" 140 | ] 141 | } 142 | }, 143 | "response": [] 144 | }, 145 | { 146 | "name": "Delete a client grant", 147 | "request": { 148 | "method": "DELETE", 149 | "header": [ 150 | { 151 | "key": "Authorization", 152 | "value": "Bearer {{auth0_token}}" 153 | } 154 | ], 155 | "body": { 156 | "mode": "raw", 157 | "raw": "" 158 | }, 159 | "url": { 160 | "raw": "https://{{auth0_domain}}/api/v2/client-grants/:id", 161 | "protocol": "https", 162 | "host": [ 163 | "{{auth0_domain}}" 164 | ], 165 | "path": [ 166 | "api", 167 | "v2", 168 | "client-grants", 169 | ":id" 170 | ], 171 | "variable": [ 172 | { 173 | "key": "id" 174 | } 175 | ] 176 | } 177 | }, 178 | "response": [] 179 | }, 180 | { 181 | "name": "Update a client grant", 182 | "request": { 183 | "method": "PATCH", 184 | "header": [ 185 | { 186 | "key": "Authorization", 187 | "value": "Bearer {{auth0_token}}" 188 | }, 189 | { 190 | "key": "Content-Type", 191 | "value": "application/json" 192 | } 193 | ], 194 | "body": { 195 | "mode": "raw", 196 | "raw": "{\r\n \"scope\": [\r\n \"\"\r\n ]\r\n}" 197 | }, 198 | "url": { 199 | "raw": "https://{{auth0_domain}}/api/v2/client-grants/:id", 200 | "protocol": "https", 201 | "host": [ 202 | "{{auth0_domain}}" 203 | ], 204 | "path": [ 205 | "api", 206 | "v2", 207 | "client-grants", 208 | ":id" 209 | ], 210 | "variable": [ 211 | { 212 | "key": "id" 213 | } 214 | ] 215 | } 216 | }, 217 | "response": [] 218 | } 219 | ], 220 | "description": "Client Grants" 221 | }, 222 | { 223 | "name": "Clients", 224 | "item": [ 225 | { 226 | "name": "Get all clients", 227 | "request": { 228 | "method": "GET", 229 | "header": [ 230 | { 231 | "key": "Authorization", 232 | "value": "Bearer {{auth0_token}}" 233 | } 234 | ], 235 | "body": { 236 | "mode": "raw", 237 | "raw": "" 238 | }, 239 | "url": { 240 | "raw": "https://{{auth0_domain}}/api/v2/clients", 241 | "protocol": "https", 242 | "host": [ 243 | "{{auth0_domain}}" 244 | ], 245 | "path": [ 246 | "api", 247 | "v2", 248 | "clients" 249 | ] 250 | }, 251 | "description": "Retrieves a list of all client applications. Accepts a list of fields to include or exclude.
Important: The client_secret and encryption_key attributes can only be retrieved with the read:client_keys scope." 252 | }, 253 | "response": [] 254 | }, 255 | { 256 | "name": "Create a client", 257 | "request": { 258 | "method": "POST", 259 | "header": [ 260 | { 261 | "key": "Authorization", 262 | "value": "Bearer {{auth0_token}}" 263 | }, 264 | { 265 | "key": "Content-Type", 266 | "value": "application/json" 267 | } 268 | ], 269 | "body": { 270 | "mode": "raw", 271 | "raw": "{\r\n \"name\": \"\",\r\n \"client_secret\": \"\",\r\n \"logo_uri\": \"\",\r\n \"callbacks\": [\r\n \"\"\r\n ],\r\n \"allowed_origins\": [\r\n \"\"\r\n ],\r\n \"client_aliases\": [\r\n \"\"\r\n ],\r\n \"allowed_clients\": [\r\n \"\"\r\n ],\r\n \"allowed_logout_urls\": [\r\n \"\"\r\n ],\r\n \"token_endpoint_auth_method\": \"\",\r\n \"app_type\": \"\",\r\n \"is_first_party\": true,\r\n \"jwt_configuration\": {\r\n \"lifetime_in_seconds\": 0,\r\n \"secret_encoded\": true,\r\n \"scopes\": {},\r\n \"alg\": \"\"\r\n },\r\n \"encryption_key\": {\r\n \"pub\": \"\",\r\n \"cert\": \"\"\r\n },\r\n \"sso\": true,\r\n \"custom_login_page_on\": true,\r\n \"custom_login_page\": \"\",\r\n \"custom_login_page_preview\": \"\",\r\n \"form_template\": \"\",\r\n \"is_heroku_app\": true,\r\n \"addons\": {\r\n \"aws\": {},\r\n \"azure_blob\": {},\r\n \"azure_sb\": {},\r\n \"rms\": {},\r\n \"mscrm\": {},\r\n \"slack\": {},\r\n \"box\": {},\r\n \"cloudbees\": {},\r\n \"concur\": {},\r\n \"dropbox\": {},\r\n \"echosign\": {},\r\n \"egnyte\": {},\r\n \"firebase\": {},\r\n \"newrelic\": {},\r\n \"office365\": {},\r\n \"salesforce\": {},\r\n \"salesforce_api\": {},\r\n \"salesforce_sandbox_api\": {},\r\n \"samlp\": {},\r\n \"layer\": {},\r\n \"sap_api\": {},\r\n \"sharepoint\": {},\r\n \"springcm\": {},\r\n \"wams\": {},\r\n \"wsfed\": {},\r\n \"zendesk\": {},\r\n \"zoom\": {}\r\n },\r\n \"resource_servers\": [\r\n {\r\n \"identifier\": \"\",\r\n \"scopes\": [\r\n \"\"\r\n ]\r\n }\r\n ],\r\n \"client_metadata\": {},\r\n \"mobile\": {\r\n \"android\": {},\r\n \"ios\": {}\r\n }\r\n}" 272 | }, 273 | "url": { 274 | "raw": "https://{{auth0_domain}}/api/v2/clients", 275 | "protocol": "https", 276 | "host": [ 277 | "{{auth0_domain}}" 278 | ], 279 | "path": [ 280 | "api", 281 | "v2", 282 | "clients" 283 | ] 284 | }, 285 | "description": "Creates a new client application. The samples on the right show every attribute that can be used." 286 | }, 287 | "response": [] 288 | }, 289 | { 290 | "name": "Get a client", 291 | "request": { 292 | "method": "GET", 293 | "header": [ 294 | { 295 | "key": "Authorization", 296 | "value": "Bearer {{auth0_token}}" 297 | } 298 | ], 299 | "body": { 300 | "mode": "raw", 301 | "raw": "" 302 | }, 303 | "url": { 304 | "raw": "https://{{auth0_domain}}/api/v2/clients/:id", 305 | "protocol": "https", 306 | "host": [ 307 | "{{auth0_domain}}" 308 | ], 309 | "path": [ 310 | "api", 311 | "v2", 312 | "clients", 313 | ":id" 314 | ], 315 | "variable": [ 316 | { 317 | "key": "id" 318 | } 319 | ] 320 | }, 321 | "description": "Retrieves a client by its id.
Important: The client_secret,encryption_key and signing_keys attributes can only be retrieved with the read:client_keys scope." 322 | }, 323 | "response": [] 324 | }, 325 | { 326 | "name": "Delete a client", 327 | "request": { 328 | "method": "DELETE", 329 | "header": [ 330 | { 331 | "key": "Authorization", 332 | "value": "Bearer {{auth0_token}}" 333 | } 334 | ], 335 | "body": { 336 | "mode": "raw", 337 | "raw": "" 338 | }, 339 | "url": { 340 | "raw": "https://{{auth0_domain}}/api/v2/clients/:id", 341 | "protocol": "https", 342 | "host": [ 343 | "{{auth0_domain}}" 344 | ], 345 | "path": [ 346 | "api", 347 | "v2", 348 | "clients", 349 | ":id" 350 | ], 351 | "variable": [ 352 | { 353 | "key": "id" 354 | } 355 | ] 356 | }, 357 | "description": "Deletes a client and all its related assets (like rules, connections, etc) given its id." 358 | }, 359 | "response": [] 360 | }, 361 | { 362 | "name": "Update a client", 363 | "request": { 364 | "method": "PATCH", 365 | "header": [ 366 | { 367 | "key": "Authorization", 368 | "value": "Bearer {{auth0_token}}" 369 | }, 370 | { 371 | "key": "Content-Type", 372 | "value": "application/json" 373 | } 374 | ], 375 | "body": { 376 | "mode": "raw", 377 | "raw": "{\r\n \"name\": \"\",\r\n \"client_secret\": \"\",\r\n \"logo_uri\": \"\",\r\n \"callbacks\": [\r\n \"\"\r\n ],\r\n \"allowed_origins\": [\r\n \"\"\r\n ],\r\n \"client_aliases\": [\r\n \"\"\r\n ],\r\n \"allowed_clients\": [\r\n \"\"\r\n ],\r\n \"allowed_logout_urls\": [\r\n \"\"\r\n ],\r\n \"jwt_configuration\": {\r\n \"lifetime_in_seconds\": 0,\r\n \"secret_encoded\": true,\r\n \"scopes\": {},\r\n \"alg\": \"\"\r\n },\r\n \"encryption_key\": {\r\n \"pub\": \"\",\r\n \"cert\": \"\",\r\n \"subject\": \"\"\r\n },\r\n \"sso\": true,\r\n \"custom_login_page_on\": true,\r\n \"token_endpoint_auth_method\": \"\",\r\n \"app_type\": \"\",\r\n \"is_first_party\": true,\r\n \"custom_login_page\": \"\",\r\n \"custom_login_page_preview\": \"\",\r\n \"form_template\": \"\",\r\n \"addons\": {\r\n \"aws\": {},\r\n \"azure_blob\": {},\r\n \"azure_sb\": {},\r\n \"rms\": {},\r\n \"mscrm\": {},\r\n \"slack\": {},\r\n \"box\": {},\r\n \"cloudbees\": {},\r\n \"concur\": {},\r\n \"dropbox\": {},\r\n \"echosign\": {},\r\n \"egnyte\": {},\r\n \"firebase\": {},\r\n \"newrelic\": {},\r\n \"office365\": {},\r\n \"salesforce\": {},\r\n \"salesforce_api\": {},\r\n \"salesforce_sandbox_api\": {},\r\n \"samlp\": {},\r\n \"layer\": {},\r\n \"sap_api\": {},\r\n \"sharepoint\": {},\r\n \"springcm\": {},\r\n \"wams\": {},\r\n \"wsfed\": {},\r\n \"zendesk\": {},\r\n \"zoom\": {}\r\n },\r\n \"resource_servers\": [\r\n {\r\n \"identifier\": \"\",\r\n \"scopes\": [\r\n \"\"\r\n ]\r\n }\r\n ],\r\n \"client_metadata\": {},\r\n \"mobile\": {\r\n \"android\": {},\r\n \"ios\": {}\r\n }\r\n}" 378 | }, 379 | "url": { 380 | "raw": "https://{{auth0_domain}}/api/v2/clients/:id", 381 | "protocol": "https", 382 | "host": [ 383 | "{{auth0_domain}}" 384 | ], 385 | "path": [ 386 | "api", 387 | "v2", 388 | "clients", 389 | ":id" 390 | ], 391 | "variable": [ 392 | { 393 | "key": "id" 394 | } 395 | ] 396 | }, 397 | "description": "Important: The client_secret and encryption_key attributes can only be updated with the update:client_keys scope." 398 | }, 399 | "response": [] 400 | } 401 | ], 402 | "description": "Clients" 403 | }, 404 | { 405 | "name": "Connections", 406 | "item": [ 407 | { 408 | "name": "Get all connections", 409 | "request": { 410 | "method": "GET", 411 | "header": [ 412 | { 413 | "key": "Authorization", 414 | "value": "Bearer {{auth0_token}}" 415 | } 416 | ], 417 | "body": { 418 | "mode": "raw", 419 | "raw": "" 420 | }, 421 | "url": { 422 | "raw": "https://{{auth0_domain}}/api/v2/connections", 423 | "protocol": "https", 424 | "host": [ 425 | "{{auth0_domain}}" 426 | ], 427 | "path": [ 428 | "api", 429 | "v2", 430 | "connections" 431 | ] 432 | }, 433 | "description": "Retrieves every connection matching the specified strategy. All connections are retrieved if no strategy is being specified. Accepts a list of fields to include or exclude in the resulting list of connection objects." 434 | }, 435 | "response": [] 436 | }, 437 | { 438 | "name": "Create a connection", 439 | "request": { 440 | "method": "POST", 441 | "header": [ 442 | { 443 | "key": "Authorization", 444 | "value": "Bearer {{auth0_token}}" 445 | }, 446 | { 447 | "key": "Content-Type", 448 | "value": "application/json" 449 | } 450 | ], 451 | "body": { 452 | "mode": "raw", 453 | "raw": "{\r\n \"name\": \"\",\r\n \"strategy\": \"\",\r\n \"options\": {\r\n \"validation\": {},\r\n \"passwordPolicy\": \"\",\r\n \"password_history\": {},\r\n \"password_no_personal_info\": {},\r\n \"password_dictionary\": {}\r\n },\r\n \"enabled_clients\": [\r\n \"\"\r\n ]\r\n}" 454 | }, 455 | "url": { 456 | "raw": "https://{{auth0_domain}}/api/v2/connections", 457 | "protocol": "https", 458 | "host": [ 459 | "{{auth0_domain}}" 460 | ], 461 | "path": [ 462 | "api", 463 | "v2", 464 | "connections" 465 | ] 466 | }, 467 | "description": "Creates a new connection according to the JSON object received in body.
The samples on the right show all available attributes. Mandatory attributes are name and strategy.
Valid Strategy names are: ad, adfs, amazon, dropbox, bitbucket, aol, auth0-adldap, auth0-oidc, auth0, baidu, bitly, box, custom, dwolla, email, evernote-sandbox, evernote, exact, facebook, fitbit, flickr, github, google-apps, google-oauth2, google-openid, instagram, ip, linkedin, miicard, oauth1, oauth2, office365, paypal, pingfederate, planningcenter, renren, salesforce-community, salesforce-sandbox, salesforce, samlp, sharepoint, shopify, sms, soundcloud, thecity-sandbox, thecity, thirtysevensignals, twitter, untappd, vkontakte, waad, weibo, windowslive, wordpress, yahoo, yammer, yandex" 468 | }, 469 | "response": [] 470 | }, 471 | { 472 | "name": "Get a connection", 473 | "request": { 474 | "method": "GET", 475 | "header": [ 476 | { 477 | "key": "Authorization", 478 | "value": "Bearer {{auth0_token}}" 479 | } 480 | ], 481 | "body": { 482 | "mode": "raw", 483 | "raw": "" 484 | }, 485 | "url": { 486 | "raw": "https://{{auth0_domain}}/api/v2/connections/:id", 487 | "protocol": "https", 488 | "host": [ 489 | "{{auth0_domain}}" 490 | ], 491 | "path": [ 492 | "api", 493 | "v2", 494 | "connections", 495 | ":id" 496 | ], 497 | "variable": [ 498 | { 499 | "key": "id" 500 | } 501 | ] 502 | }, 503 | "description": "Retrieves a connection by its id." 504 | }, 505 | "response": [] 506 | }, 507 | { 508 | "name": "Delete a connection", 509 | "request": { 510 | "method": "DELETE", 511 | "header": [ 512 | { 513 | "key": "Authorization", 514 | "value": "Bearer {{auth0_token}}" 515 | } 516 | ], 517 | "body": { 518 | "mode": "raw", 519 | "raw": "" 520 | }, 521 | "url": { 522 | "raw": "https://{{auth0_domain}}/api/v2/connections/:id", 523 | "protocol": "https", 524 | "host": [ 525 | "{{auth0_domain}}" 526 | ], 527 | "path": [ 528 | "api", 529 | "v2", 530 | "connections", 531 | ":id" 532 | ], 533 | "variable": [ 534 | { 535 | "key": "id" 536 | } 537 | ] 538 | }, 539 | "description": "Deletes a connection and all its users." 540 | }, 541 | "response": [] 542 | }, 543 | { 544 | "name": "Update a connection", 545 | "request": { 546 | "method": "PATCH", 547 | "header": [ 548 | { 549 | "key": "Authorization", 550 | "value": "Bearer {{auth0_token}}" 551 | }, 552 | { 553 | "key": "Content-Type", 554 | "value": "application/json" 555 | } 556 | ], 557 | "body": { 558 | "mode": "raw", 559 | "raw": "{\r\n \"options\": {\r\n \"validation\": {},\r\n \"passwordPolicy\": \"\",\r\n \"password_history\": {},\r\n \"password_no_personal_info\": {},\r\n \"password_dictionary\": {}\r\n },\r\n \"enabled_clients\": [\r\n \"\"\r\n ]\r\n}" 560 | }, 561 | "url": { 562 | "raw": "https://{{auth0_domain}}/api/v2/connections/:id", 563 | "protocol": "https", 564 | "host": [ 565 | "{{auth0_domain}}" 566 | ], 567 | "path": [ 568 | "api", 569 | "v2", 570 | "connections", 571 | ":id" 572 | ], 573 | "variable": [ 574 | { 575 | "key": "id" 576 | } 577 | ] 578 | }, 579 | "description": "Note: if you use the options parameter, the whole options object will be overridden, ensure all parameters are present" 580 | }, 581 | "response": [] 582 | }, 583 | { 584 | "name": "Delete a connection user", 585 | "request": { 586 | "method": "DELETE", 587 | "header": [ 588 | { 589 | "key": "Authorization", 590 | "value": "Bearer {{auth0_token}}" 591 | } 592 | ], 593 | "body": { 594 | "mode": "raw", 595 | "raw": "" 596 | }, 597 | "url": { 598 | "raw": "https://{{auth0_domain}}/api/v2/connections/:id/users", 599 | "protocol": "https", 600 | "host": [ 601 | "{{auth0_domain}}" 602 | ], 603 | "path": [ 604 | "api", 605 | "v2", 606 | "connections", 607 | ":id", 608 | "users" 609 | ], 610 | "variable": [ 611 | { 612 | "key": "id" 613 | } 614 | ] 615 | }, 616 | "description": "Deletes a specified connection user by its email (currently only database connections are supported and you cannot delete all users from specific connection)." 617 | }, 618 | "response": [] 619 | } 620 | ], 621 | "description": "Connections" 622 | }, 623 | { 624 | "name": "Device Credentials", 625 | "item": [ 626 | { 627 | "name": "List device credentials", 628 | "request": { 629 | "method": "GET", 630 | "header": [ 631 | { 632 | "key": "Authorization", 633 | "value": "Bearer {{auth0_token}}" 634 | } 635 | ], 636 | "body": { 637 | "mode": "raw", 638 | "raw": "" 639 | }, 640 | "url": { 641 | "raw": "https://{{auth0_domain}}/api/v2/device-credentials", 642 | "protocol": "https", 643 | "host": [ 644 | "{{auth0_domain}}" 645 | ], 646 | "path": [ 647 | "api", 648 | "v2", 649 | "device-credentials" 650 | ] 651 | }, 652 | "description": "You can use the device-credentials endpoint using Basic authentication with username and password from a database connection
The Authorization header should be Authorization: Basic base64(\"{db_conn_name}\\{user}:{password}\")\n" 653 | }, 654 | "response": [] 655 | }, 656 | { 657 | "name": "Create a device public key", 658 | "request": { 659 | "method": "POST", 660 | "header": [ 661 | { 662 | "key": "Authorization", 663 | "value": "Bearer {{auth0_token}}" 664 | }, 665 | { 666 | "key": "Content-Type", 667 | "value": "application/json" 668 | } 669 | ], 670 | "body": { 671 | "mode": "raw", 672 | "raw": "{\r\n \"device_name\": \"\",\r\n \"type\": \"\",\r\n \"value\": \"\",\r\n \"device_id\": \"\",\r\n \"client_id\": \"\"\r\n}" 673 | }, 674 | "url": { 675 | "raw": "https://{{auth0_domain}}/api/v2/device-credentials", 676 | "protocol": "https", 677 | "host": [ 678 | "{{auth0_domain}}" 679 | ], 680 | "path": [ 681 | "api", 682 | "v2", 683 | "device-credentials" 684 | ] 685 | }, 686 | "description": "You can use the device-credentials endpoint using Basic authentication with username and password from a database connection
The Authorization header should be Authorization: Basic base64(\"{db_conn_name}\\{user}:{password}\")\n" 687 | }, 688 | "response": [] 689 | }, 690 | { 691 | "name": "Delete a device credential", 692 | "request": { 693 | "method": "DELETE", 694 | "header": [ 695 | { 696 | "key": "Authorization", 697 | "value": "Bearer {{auth0_token}}" 698 | } 699 | ], 700 | "body": { 701 | "mode": "raw", 702 | "raw": "" 703 | }, 704 | "url": { 705 | "raw": "https://{{auth0_domain}}/api/v2/device-credentials/:id", 706 | "protocol": "https", 707 | "host": [ 708 | "{{auth0_domain}}" 709 | ], 710 | "path": [ 711 | "api", 712 | "v2", 713 | "device-credentials", 714 | ":id" 715 | ], 716 | "variable": [ 717 | { 718 | "key": "id" 719 | } 720 | ] 721 | }, 722 | "description": "You can use the device-credentials endpoint using Basic authentication with username and password from a database connection
The Authorization header should be Authorization: Basic base64(\"{db_conn_name}\\{user}:{password}\")\n" 723 | }, 724 | "response": [] 725 | } 726 | ], 727 | "description": "Device Credentials" 728 | }, 729 | { 730 | "name": "Emails", 731 | "item": [ 732 | { 733 | "name": "Get the email provider", 734 | "request": { 735 | "method": "GET", 736 | "header": [ 737 | { 738 | "key": "Authorization", 739 | "value": "Bearer {{auth0_token}}" 740 | } 741 | ], 742 | "body": { 743 | "mode": "raw", 744 | "raw": "" 745 | }, 746 | "url": { 747 | "raw": "https://{{auth0_domain}}/api/v2/emails/provider", 748 | "protocol": "https", 749 | "host": [ 750 | "{{auth0_domain}}" 751 | ], 752 | "path": [ 753 | "api", 754 | "v2", 755 | "emails", 756 | "provider" 757 | ] 758 | } 759 | }, 760 | "response": [] 761 | }, 762 | { 763 | "name": "Delete the email provider", 764 | "request": { 765 | "method": "DELETE", 766 | "header": [ 767 | { 768 | "key": "Authorization", 769 | "value": "Bearer {{auth0_token}}" 770 | } 771 | ], 772 | "body": { 773 | "mode": "raw", 774 | "raw": "" 775 | }, 776 | "url": { 777 | "raw": "https://{{auth0_domain}}/api/v2/emails/provider", 778 | "protocol": "https", 779 | "host": [ 780 | "{{auth0_domain}}" 781 | ], 782 | "path": [ 783 | "api", 784 | "v2", 785 | "emails", 786 | "provider" 787 | ] 788 | }, 789 | "description": "USE WITH CAUTION" 790 | }, 791 | "response": [] 792 | }, 793 | { 794 | "name": "Configure the email provider", 795 | "request": { 796 | "method": "POST", 797 | "header": [ 798 | { 799 | "key": "Authorization", 800 | "value": "Bearer {{auth0_token}}" 801 | }, 802 | { 803 | "key": "Content-Type", 804 | "value": "application/json" 805 | } 806 | ], 807 | "body": { 808 | "mode": "raw", 809 | "raw": "{\r\n \"name\": \"\",\r\n \"enabled\": true,\r\n \"default_from_address\": \"\",\r\n \"credentials\": {\r\n \"api_key\": \"\"\r\n },\r\n \"settings\": {}\r\n}" 810 | }, 811 | "url": { 812 | "raw": "https://{{auth0_domain}}/api/v2/emails/provider", 813 | "protocol": "https", 814 | "host": [ 815 | "{{auth0_domain}}" 816 | ], 817 | "path": [ 818 | "api", 819 | "v2", 820 | "emails", 821 | "provider" 822 | ] 823 | } 824 | }, 825 | "response": [] 826 | }, 827 | { 828 | "name": "Update the email provider", 829 | "request": { 830 | "method": "PATCH", 831 | "header": [ 832 | { 833 | "key": "Authorization", 834 | "value": "Bearer {{auth0_token}}" 835 | }, 836 | { 837 | "key": "Content-Type", 838 | "value": "application/json" 839 | } 840 | ], 841 | "body": { 842 | "mode": "raw", 843 | "raw": "{\r\n \"name\": \"\",\r\n \"enabled\": true,\r\n \"default_from_address\": \"\",\r\n \"credentials\": {\r\n \"api_key\": \"\"\r\n },\r\n \"settings\": {}\r\n}" 844 | }, 845 | "url": { 846 | "raw": "https://{{auth0_domain}}/api/v2/emails/provider", 847 | "protocol": "https", 848 | "host": [ 849 | "{{auth0_domain}}" 850 | ], 851 | "path": [ 852 | "api", 853 | "v2", 854 | "emails", 855 | "provider" 856 | ] 857 | } 858 | }, 859 | "response": [] 860 | } 861 | ], 862 | "description": "Emails" 863 | }, 864 | { 865 | "name": "Guardian", 866 | "item": [ 867 | { 868 | "name": "Get a list of factors and statuses", 869 | "request": { 870 | "method": "GET", 871 | "header": [ 872 | { 873 | "key": "Authorization", 874 | "value": "Bearer {{auth0_token}}" 875 | } 876 | ], 877 | "body": { 878 | "mode": "raw", 879 | "raw": "" 880 | }, 881 | "url": { 882 | "raw": "https://{{auth0_domain}}/api/v2/guardian/factors", 883 | "protocol": "https", 884 | "host": [ 885 | "{{auth0_domain}}" 886 | ], 887 | "path": [ 888 | "api", 889 | "v2", 890 | "guardian", 891 | "factors" 892 | ] 893 | }, 894 | "description": "Retrieves all factors. Useful to check factor enablement and trial status." 895 | }, 896 | "response": [] 897 | }, 898 | { 899 | "name": "Get a Guardian enrollment", 900 | "request": { 901 | "method": "GET", 902 | "header": [ 903 | { 904 | "key": "Authorization", 905 | "value": "Bearer {{auth0_token}}" 906 | } 907 | ], 908 | "body": { 909 | "mode": "raw", 910 | "raw": "" 911 | }, 912 | "url": { 913 | "raw": "https://{{auth0_domain}}/api/v2/guardian/enrollments/:id", 914 | "protocol": "https", 915 | "host": [ 916 | "{{auth0_domain}}" 917 | ], 918 | "path": [ 919 | "api", 920 | "v2", 921 | "guardian", 922 | "enrollments", 923 | ":id" 924 | ], 925 | "variable": [ 926 | { 927 | "key": "id" 928 | } 929 | ] 930 | }, 931 | "description": "Retrieves an enrollment. Useful to check its type and related metadata." 932 | }, 933 | "response": [] 934 | }, 935 | { 936 | "name": "Delete a Guardian enrollment", 937 | "request": { 938 | "method": "DELETE", 939 | "header": [ 940 | { 941 | "key": "Authorization", 942 | "value": "Bearer {{auth0_token}}" 943 | } 944 | ], 945 | "body": { 946 | "mode": "raw", 947 | "raw": "" 948 | }, 949 | "url": { 950 | "raw": "https://{{auth0_domain}}/api/v2/guardian/enrollments/:id", 951 | "protocol": "https", 952 | "host": [ 953 | "{{auth0_domain}}" 954 | ], 955 | "path": [ 956 | "api", 957 | "v2", 958 | "guardian", 959 | "enrollments", 960 | ":id" 961 | ], 962 | "variable": [ 963 | { 964 | "key": "id" 965 | } 966 | ] 967 | }, 968 | "description": "Deletes an enrollment. Useful when you want to force re-enroll." 969 | }, 970 | "response": [] 971 | }, 972 | { 973 | "name": "Get enrollment and verification templates", 974 | "request": { 975 | "method": "GET", 976 | "header": [ 977 | { 978 | "key": "Authorization", 979 | "value": "Bearer {{auth0_token}}" 980 | } 981 | ], 982 | "body": { 983 | "mode": "raw", 984 | "raw": "" 985 | }, 986 | "url": { 987 | "raw": "https://{{auth0_domain}}/api/v2/guardian/factors/sms/templates", 988 | "protocol": "https", 989 | "host": [ 990 | "{{auth0_domain}}" 991 | ], 992 | "path": [ 993 | "api", 994 | "v2", 995 | "guardian", 996 | "factors", 997 | "sms", 998 | "templates" 999 | ] 1000 | }, 1001 | "description": "Retrieve both templates. Useful to check if a different template than default were set." 1002 | }, 1003 | "response": [] 1004 | }, 1005 | { 1006 | "name": "Update enrollment and verification SMS templates.", 1007 | "request": { 1008 | "method": "PUT", 1009 | "header": [ 1010 | { 1011 | "key": "Authorization", 1012 | "value": "Bearer {{auth0_token}}" 1013 | }, 1014 | { 1015 | "key": "Content-Type", 1016 | "value": "application/json" 1017 | } 1018 | ], 1019 | "body": { 1020 | "mode": "raw", 1021 | "raw": "{\r\n \"enrollment_message\": \"\",\r\n \"verification_message\": \"\"\r\n}" 1022 | }, 1023 | "url": { 1024 | "raw": "https://{{auth0_domain}}/api/v2/guardian/factors/sms/templates", 1025 | "protocol": "https", 1026 | "host": [ 1027 | "{{auth0_domain}}" 1028 | ], 1029 | "path": [ 1030 | "api", 1031 | "v2", 1032 | "guardian", 1033 | "factors", 1034 | "sms", 1035 | "templates" 1036 | ] 1037 | }, 1038 | "description": "Useful to send custom messages on sms enrollment and verification" 1039 | }, 1040 | "response": [] 1041 | }, 1042 | { 1043 | "name": "Get Guardian factor provider", 1044 | "request": { 1045 | "method": "GET", 1046 | "header": [ 1047 | { 1048 | "key": "Authorization", 1049 | "value": "Bearer {{auth0_token}}" 1050 | } 1051 | ], 1052 | "body": { 1053 | "mode": "raw", 1054 | "raw": "" 1055 | }, 1056 | "url": { 1057 | "raw": "https://{{auth0_domain}}/api/v2/guardian/factors/:factor_name/providers/:name", 1058 | "protocol": "https", 1059 | "host": [ 1060 | "{{auth0_domain}}" 1061 | ], 1062 | "path": [ 1063 | "api", 1064 | "v2", 1065 | "guardian", 1066 | "factors", 1067 | ":factor_name", 1068 | "providers", 1069 | ":name" 1070 | ], 1071 | "variable": [ 1072 | { 1073 | "key": "factor_name" 1074 | }, 1075 | { 1076 | "key": "name" 1077 | } 1078 | ] 1079 | }, 1080 | "description": "Returns provider configuration" 1081 | }, 1082 | "response": [] 1083 | }, 1084 | { 1085 | "name": "Update Guardian Factor", 1086 | "request": { 1087 | "method": "PUT", 1088 | "header": [ 1089 | { 1090 | "key": "Authorization", 1091 | "value": "Bearer {{auth0_token}}" 1092 | }, 1093 | { 1094 | "key": "Content-Type", 1095 | "value": "application/json" 1096 | } 1097 | ], 1098 | "body": { 1099 | "mode": "raw", 1100 | "raw": "{\r\n \"enabled\": true\r\n}" 1101 | }, 1102 | "url": { 1103 | "raw": "https://{{auth0_domain}}/api/v2/guardian/factors/:name", 1104 | "protocol": "https", 1105 | "host": [ 1106 | "{{auth0_domain}}" 1107 | ], 1108 | "path": [ 1109 | "api", 1110 | "v2", 1111 | "guardian", 1112 | "factors", 1113 | ":name" 1114 | ], 1115 | "variable": [ 1116 | { 1117 | "key": "name" 1118 | } 1119 | ] 1120 | }, 1121 | "description": "Useful to enable / disable factor" 1122 | }, 1123 | "response": [] 1124 | }, 1125 | { 1126 | "name": "Update Guardian's Twilio SMS factor provider", 1127 | "request": { 1128 | "method": "PUT", 1129 | "header": [ 1130 | { 1131 | "key": "Authorization", 1132 | "value": "Bearer {{auth0_token}}" 1133 | }, 1134 | { 1135 | "key": "Content-Type", 1136 | "value": "application/json" 1137 | } 1138 | ], 1139 | "body": { 1140 | "mode": "raw", 1141 | "raw": "{\r\n \"from\": \"\",\r\n \"messaging_service_sid\": \"\",\r\n \"auth_token\": \"\",\r\n \"sid\": \"\"\r\n}" 1142 | }, 1143 | "url": { 1144 | "raw": "https://{{auth0_domain}}/api/v2/guardian/factors/sms/providers/twilio", 1145 | "protocol": "https", 1146 | "host": [ 1147 | "{{auth0_domain}}" 1148 | ], 1149 | "path": [ 1150 | "api", 1151 | "v2", 1152 | "guardian", 1153 | "factors", 1154 | "sms", 1155 | "providers", 1156 | "twilio" 1157 | ] 1158 | }, 1159 | "description": "Useful to configure SMS provider" 1160 | }, 1161 | "response": [] 1162 | } 1163 | ], 1164 | "description": "Guardian" 1165 | }, 1166 | { 1167 | "name": "Jobs", 1168 | "item": [ 1169 | { 1170 | "name": "Get a job", 1171 | "request": { 1172 | "method": "GET", 1173 | "header": [ 1174 | { 1175 | "key": "Authorization", 1176 | "value": "Bearer {{auth0_token}}" 1177 | } 1178 | ], 1179 | "body": { 1180 | "mode": "raw", 1181 | "raw": "" 1182 | }, 1183 | "url": { 1184 | "raw": "https://{{auth0_domain}}/api/v2/jobs/:id", 1185 | "protocol": "https", 1186 | "host": [ 1187 | "{{auth0_domain}}" 1188 | ], 1189 | "path": [ 1190 | "api", 1191 | "v2", 1192 | "jobs", 1193 | ":id" 1194 | ], 1195 | "variable": [ 1196 | { 1197 | "key": "id" 1198 | } 1199 | ] 1200 | }, 1201 | "description": "Retrieves a job. Useful to check its status." 1202 | }, 1203 | "response": [] 1204 | }, 1205 | { 1206 | "name": "Get failed job error details", 1207 | "request": { 1208 | "method": "GET", 1209 | "header": [ 1210 | { 1211 | "key": "Authorization", 1212 | "value": "Bearer {{auth0_token}}" 1213 | } 1214 | ], 1215 | "body": { 1216 | "mode": "raw", 1217 | "raw": "" 1218 | }, 1219 | "url": { 1220 | "raw": "https://{{auth0_domain}}/api/v2/jobs/:id/errors", 1221 | "protocol": "https", 1222 | "host": [ 1223 | "{{auth0_domain}}" 1224 | ], 1225 | "path": [ 1226 | "api", 1227 | "v2", 1228 | "jobs", 1229 | ":id", 1230 | "errors" 1231 | ], 1232 | "variable": [ 1233 | { 1234 | "key": "id" 1235 | } 1236 | ] 1237 | } 1238 | }, 1239 | "response": [] 1240 | }, 1241 | { 1242 | "name": "Import users", 1243 | "request": { 1244 | "method": "POST", 1245 | "header": [ 1246 | { 1247 | "key": "Authorization", 1248 | "value": "Bearer {{auth0_token}}" 1249 | }, 1250 | { 1251 | "key": "Content-Type", 1252 | "value": "application/json" 1253 | } 1254 | ], 1255 | "body": { 1256 | "mode": "raw", 1257 | "raw": "" 1258 | }, 1259 | "url": { 1260 | "raw": "https://{{auth0_domain}}/api/v2/jobs/users-imports", 1261 | "protocol": "https", 1262 | "host": [ 1263 | "{{auth0_domain}}" 1264 | ], 1265 | "path": [ 1266 | "api", 1267 | "v2", 1268 | "jobs", 1269 | "users-imports" 1270 | ] 1271 | }, 1272 | "description": "Imports users to a connection from a file using a long running job. Important: The documentation for the file format is here." 1273 | }, 1274 | "response": [] 1275 | }, 1276 | { 1277 | "name": "Send a \"verify email address\" email", 1278 | "request": { 1279 | "method": "POST", 1280 | "header": [ 1281 | { 1282 | "key": "Authorization", 1283 | "value": "Bearer {{auth0_token}}" 1284 | }, 1285 | { 1286 | "key": "Content-Type", 1287 | "value": "application/json" 1288 | } 1289 | ], 1290 | "body": { 1291 | "mode": "raw", 1292 | "raw": "{\r\n \"user_id\": \"\"\r\n}" 1293 | }, 1294 | "url": { 1295 | "raw": "https://{{auth0_domain}}/api/v2/jobs/verification-email", 1296 | "protocol": "https", 1297 | "host": [ 1298 | "{{auth0_domain}}" 1299 | ], 1300 | "path": [ 1301 | "api", 1302 | "v2", 1303 | "jobs", 1304 | "verification-email" 1305 | ] 1306 | }, 1307 | "description": "Send an email to the specified user that asks them to click a link to verify their email address." 1308 | }, 1309 | "response": [] 1310 | } 1311 | ], 1312 | "description": "Jobs" 1313 | }, 1314 | { 1315 | "name": "Logs", 1316 | "item": [ 1317 | { 1318 | "name": "Search log events", 1319 | "request": { 1320 | "method": "GET", 1321 | "header": [ 1322 | { 1323 | "key": "Authorization", 1324 | "value": "Bearer {{auth0_token}}" 1325 | } 1326 | ], 1327 | "body": { 1328 | "mode": "raw", 1329 | "raw": "" 1330 | }, 1331 | "url": { 1332 | "raw": "https://{{auth0_domain}}/api/v2/logs", 1333 | "protocol": "https", 1334 | "host": [ 1335 | "{{auth0_domain}}" 1336 | ], 1337 | "path": [ 1338 | "api", 1339 | "v2", 1340 | "logs" 1341 | ] 1342 | }, 1343 | "description": "Retrieves log entries that match the specified search criteria (or list all entries if no criteria is used).
You can search with a criteria using the q parameter or you can search by a specific log ID (search by checkpoint):

The search by criteria can use the following parameters:
The search by checkpoint use the following parameters:
\n
Event acronym mapping
\n
List of fields that can be used in fields and sort
" 1344 | }, 1345 | "response": [] 1346 | }, 1347 | { 1348 | "name": "Get a log event by id", 1349 | "request": { 1350 | "method": "GET", 1351 | "header": [ 1352 | { 1353 | "key": "Authorization", 1354 | "value": "Bearer {{auth0_token}}" 1355 | } 1356 | ], 1357 | "body": { 1358 | "mode": "raw", 1359 | "raw": "" 1360 | }, 1361 | "url": { 1362 | "raw": "https://{{auth0_domain}}/api/v2/logs/:id", 1363 | "protocol": "https", 1364 | "host": [ 1365 | "{{auth0_domain}}" 1366 | ], 1367 | "path": [ 1368 | "api", 1369 | "v2", 1370 | "logs", 1371 | ":id" 1372 | ], 1373 | "variable": [ 1374 | { 1375 | "key": "id" 1376 | } 1377 | ] 1378 | }, 1379 | "description": "Retrieves the data related to the log entry identified by id. This returns a single log entry representation as specified in the schema." 1380 | }, 1381 | "response": [] 1382 | } 1383 | ], 1384 | "description": "Logs" 1385 | }, 1386 | { 1387 | "name": "Resource Servers", 1388 | "item": [ 1389 | { 1390 | "name": "Get a resource server by its id", 1391 | "request": { 1392 | "method": "GET", 1393 | "header": [ 1394 | { 1395 | "key": "Authorization", 1396 | "value": "Bearer {{auth0_token}}" 1397 | } 1398 | ], 1399 | "body": { 1400 | "mode": "raw", 1401 | "raw": "" 1402 | }, 1403 | "url": { 1404 | "raw": "https://{{auth0_domain}}/api/v2/resource-servers/:id", 1405 | "protocol": "https", 1406 | "host": [ 1407 | "{{auth0_domain}}" 1408 | ], 1409 | "path": [ 1410 | "api", 1411 | "v2", 1412 | "resource-servers", 1413 | ":id" 1414 | ], 1415 | "variable": [ 1416 | { 1417 | "key": "id" 1418 | } 1419 | ] 1420 | } 1421 | }, 1422 | "response": [] 1423 | }, 1424 | { 1425 | "name": "Delete a resource server", 1426 | "request": { 1427 | "method": "DELETE", 1428 | "header": [ 1429 | { 1430 | "key": "Authorization", 1431 | "value": "Bearer {{auth0_token}}" 1432 | } 1433 | ], 1434 | "body": { 1435 | "mode": "raw", 1436 | "raw": "" 1437 | }, 1438 | "url": { 1439 | "raw": "https://{{auth0_domain}}/api/v2/resource-servers/:id", 1440 | "protocol": "https", 1441 | "host": [ 1442 | "{{auth0_domain}}" 1443 | ], 1444 | "path": [ 1445 | "api", 1446 | "v2", 1447 | "resource-servers", 1448 | ":id" 1449 | ], 1450 | "variable": [ 1451 | { 1452 | "key": "id" 1453 | } 1454 | ] 1455 | } 1456 | }, 1457 | "response": [] 1458 | }, 1459 | { 1460 | "name": "Update a resource server", 1461 | "request": { 1462 | "method": "PATCH", 1463 | "header": [ 1464 | { 1465 | "key": "Authorization", 1466 | "value": "Bearer {{auth0_token}}" 1467 | }, 1468 | { 1469 | "key": "Content-Type", 1470 | "value": "application/json" 1471 | } 1472 | ], 1473 | "body": { 1474 | "mode": "raw", 1475 | "raw": "{\r\n \"name\": \"\",\r\n \"scopes\": [\r\n {\r\n \"value\": \"\",\r\n \"description\": \"\"\r\n }\r\n ],\r\n \"signing_alg\": \"\",\r\n \"signing_secret\": \"\",\r\n \"token_lifetime\": 0\r\n}" 1476 | }, 1477 | "url": { 1478 | "raw": "https://{{auth0_domain}}/api/v2/resource-servers/:id", 1479 | "protocol": "https", 1480 | "host": [ 1481 | "{{auth0_domain}}" 1482 | ], 1483 | "path": [ 1484 | "api", 1485 | "v2", 1486 | "resource-servers", 1487 | ":id" 1488 | ], 1489 | "variable": [ 1490 | { 1491 | "key": "id" 1492 | } 1493 | ] 1494 | } 1495 | }, 1496 | "response": [] 1497 | }, 1498 | { 1499 | "name": "Create a resource server", 1500 | "request": { 1501 | "method": "POST", 1502 | "header": [ 1503 | { 1504 | "key": "Authorization", 1505 | "value": "Bearer {{auth0_token}}" 1506 | }, 1507 | { 1508 | "key": "Content-Type", 1509 | "value": "application/json" 1510 | } 1511 | ], 1512 | "body": { 1513 | "mode": "raw", 1514 | "raw": "{\r\n \"name\": \"\",\r\n \"identifier\": \"\",\r\n \"scopes\": [\r\n {\r\n \"value\": \"\",\r\n \"description\": \"\"\r\n }\r\n ],\r\n \"signing_alg\": \"\",\r\n \"signing_secret\": \"\",\r\n \"token_lifetime\": 0\r\n}" 1515 | }, 1516 | "url": { 1517 | "raw": "https://{{auth0_domain}}/api/v2/resource-servers", 1518 | "protocol": "https", 1519 | "host": [ 1520 | "{{auth0_domain}}" 1521 | ], 1522 | "path": [ 1523 | "api", 1524 | "v2", 1525 | "resource-servers" 1526 | ] 1527 | } 1528 | }, 1529 | "response": [] 1530 | } 1531 | ], 1532 | "description": "Resource Servers" 1533 | }, 1534 | { 1535 | "name": "Rules", 1536 | "item": [ 1537 | { 1538 | "name": "Get all rules", 1539 | "request": { 1540 | "method": "GET", 1541 | "header": [ 1542 | { 1543 | "key": "Authorization", 1544 | "value": "Bearer {{auth0_token}}" 1545 | } 1546 | ], 1547 | "body": { 1548 | "mode": "raw", 1549 | "raw": "" 1550 | }, 1551 | "url": { 1552 | "raw": "https://{{auth0_domain}}/api/v2/rules", 1553 | "protocol": "https", 1554 | "host": [ 1555 | "{{auth0_domain}}" 1556 | ], 1557 | "path": [ 1558 | "api", 1559 | "v2", 1560 | "rules" 1561 | ] 1562 | }, 1563 | "description": "Retrieves a list of all rules. Accepts a list of fields to include or exclude.
The enabled parameter can be specified to get enabled or disabled rules. The rule's stage of executing could be set to the following values login_success, login_failure or pre_authorize" 1564 | }, 1565 | "response": [] 1566 | }, 1567 | { 1568 | "name": "Create a rule", 1569 | "request": { 1570 | "method": "POST", 1571 | "header": [ 1572 | { 1573 | "key": "Authorization", 1574 | "value": "Bearer {{auth0_token}}" 1575 | }, 1576 | { 1577 | "key": "Content-Type", 1578 | "value": "application/json" 1579 | } 1580 | ], 1581 | "body": { 1582 | "mode": "raw", 1583 | "raw": "{\r\n \"name\": \"\",\r\n \"script\": \"\",\r\n \"order\": {},\r\n \"enabled\": true,\r\n \"stage\": \"\"\r\n}" 1584 | }, 1585 | "url": { 1586 | "raw": "https://{{auth0_domain}}/api/v2/rules", 1587 | "protocol": "https", 1588 | "host": [ 1589 | "{{auth0_domain}}" 1590 | ], 1591 | "path": [ 1592 | "api", 1593 | "v2", 1594 | "rules" 1595 | ] 1596 | }, 1597 | "description": "Creates a new rule according to the JSON object received in body.
The samples on the right show you every attribute that could be used. Mandatory attributes are name and scriptNote: Changing a rule's stage of execution from the default login_success can change the rule's function signature to have user omitted." 1598 | }, 1599 | "response": [] 1600 | }, 1601 | { 1602 | "name": "Get a rule", 1603 | "request": { 1604 | "method": "GET", 1605 | "header": [ 1606 | { 1607 | "key": "Authorization", 1608 | "value": "Bearer {{auth0_token}}" 1609 | } 1610 | ], 1611 | "body": { 1612 | "mode": "raw", 1613 | "raw": "" 1614 | }, 1615 | "url": { 1616 | "raw": "https://{{auth0_domain}}/api/v2/rules/:id", 1617 | "protocol": "https", 1618 | "host": [ 1619 | "{{auth0_domain}}" 1620 | ], 1621 | "path": [ 1622 | "api", 1623 | "v2", 1624 | "rules", 1625 | ":id" 1626 | ], 1627 | "variable": [ 1628 | { 1629 | "key": "id" 1630 | } 1631 | ] 1632 | }, 1633 | "description": "Retrieves a rule by its ID. Accepts a list of fields to include or exclude in the result." 1634 | }, 1635 | "response": [] 1636 | }, 1637 | { 1638 | "name": "Delete a rule", 1639 | "request": { 1640 | "method": "DELETE", 1641 | "header": [ 1642 | { 1643 | "key": "Authorization", 1644 | "value": "Bearer {{auth0_token}}" 1645 | } 1646 | ], 1647 | "body": { 1648 | "mode": "raw", 1649 | "raw": "" 1650 | }, 1651 | "url": { 1652 | "raw": "https://{{auth0_domain}}/api/v2/rules/:id", 1653 | "protocol": "https", 1654 | "host": [ 1655 | "{{auth0_domain}}" 1656 | ], 1657 | "path": [ 1658 | "api", 1659 | "v2", 1660 | "rules", 1661 | ":id" 1662 | ], 1663 | "variable": [ 1664 | { 1665 | "key": "id" 1666 | } 1667 | ] 1668 | } 1669 | }, 1670 | "response": [] 1671 | }, 1672 | { 1673 | "name": "Update a rule", 1674 | "request": { 1675 | "method": "PATCH", 1676 | "header": [ 1677 | { 1678 | "key": "Authorization", 1679 | "value": "Bearer {{auth0_token}}" 1680 | }, 1681 | { 1682 | "key": "Content-Type", 1683 | "value": "application/json" 1684 | } 1685 | ], 1686 | "body": { 1687 | "mode": "raw", 1688 | "raw": "{\r\n \"script\": \"\",\r\n \"name\": \"\",\r\n \"order\": {},\r\n \"enabled\": true\r\n}" 1689 | }, 1690 | "url": { 1691 | "raw": "https://{{auth0_domain}}/api/v2/rules/:id", 1692 | "protocol": "https", 1693 | "host": [ 1694 | "{{auth0_domain}}" 1695 | ], 1696 | "path": [ 1697 | "api", 1698 | "v2", 1699 | "rules", 1700 | ":id" 1701 | ], 1702 | "variable": [ 1703 | { 1704 | "key": "id" 1705 | } 1706 | ] 1707 | } 1708 | }, 1709 | "response": [] 1710 | } 1711 | ], 1712 | "description": "Rules" 1713 | }, 1714 | { 1715 | "name": "Stats", 1716 | "item": [ 1717 | { 1718 | "name": "Get active users count", 1719 | "request": { 1720 | "method": "GET", 1721 | "header": [ 1722 | { 1723 | "key": "Authorization", 1724 | "value": "Bearer {{auth0_token}}" 1725 | } 1726 | ], 1727 | "body": { 1728 | "mode": "raw", 1729 | "raw": "" 1730 | }, 1731 | "url": { 1732 | "raw": "https://{{auth0_domain}}/api/v2/stats/active-users", 1733 | "protocol": "https", 1734 | "host": [ 1735 | "{{auth0_domain}}" 1736 | ], 1737 | "path": [ 1738 | "api", 1739 | "v2", 1740 | "stats", 1741 | "active-users" 1742 | ] 1743 | }, 1744 | "description": "Gets the active users count (logged in during the last 30 days)." 1745 | }, 1746 | "response": [] 1747 | }, 1748 | { 1749 | "name": "Get daily stats", 1750 | "request": { 1751 | "method": "GET", 1752 | "header": [ 1753 | { 1754 | "key": "Authorization", 1755 | "value": "Bearer {{auth0_token}}" 1756 | } 1757 | ], 1758 | "body": { 1759 | "mode": "raw", 1760 | "raw": "" 1761 | }, 1762 | "url": { 1763 | "raw": "https://{{auth0_domain}}/api/v2/stats/daily", 1764 | "protocol": "https", 1765 | "host": [ 1766 | "{{auth0_domain}}" 1767 | ], 1768 | "path": [ 1769 | "api", 1770 | "v2", 1771 | "stats", 1772 | "daily" 1773 | ] 1774 | }, 1775 | "description": "Gets the daily stats for a particular period." 1776 | }, 1777 | "response": [] 1778 | } 1779 | ], 1780 | "description": "Stats" 1781 | }, 1782 | { 1783 | "name": "Tenants", 1784 | "item": [ 1785 | { 1786 | "name": "Get tenant settings", 1787 | "request": { 1788 | "method": "GET", 1789 | "header": [ 1790 | { 1791 | "key": "Authorization", 1792 | "value": "Bearer {{auth0_token}}" 1793 | } 1794 | ], 1795 | "body": { 1796 | "mode": "raw", 1797 | "raw": "" 1798 | }, 1799 | "url": { 1800 | "raw": "https://{{auth0_domain}}/api/v2/tenants/settings", 1801 | "protocol": "https", 1802 | "host": [ 1803 | "{{auth0_domain}}" 1804 | ], 1805 | "path": [ 1806 | "api", 1807 | "v2", 1808 | "tenants", 1809 | "settings" 1810 | ] 1811 | } 1812 | }, 1813 | "response": [] 1814 | }, 1815 | { 1816 | "name": "Update tenant settings", 1817 | "request": { 1818 | "method": "PATCH", 1819 | "header": [ 1820 | { 1821 | "key": "Authorization", 1822 | "value": "Bearer {{auth0_token}}" 1823 | }, 1824 | { 1825 | "key": "Content-Type", 1826 | "value": "application/json" 1827 | } 1828 | ], 1829 | "body": { 1830 | "mode": "raw", 1831 | "raw": "{\r\n \"change_password\": {\r\n \"enabled\": true,\r\n \"html\": \"\"\r\n },\r\n \"guardian_mfa_page\": {\r\n \"enabled\": true,\r\n \"html\": \"\"\r\n },\r\n \"error_page\": {\r\n \"html\": \"\",\r\n \"show_log_link\": true,\r\n \"url\": \"\"\r\n },\r\n \"flags\": {\r\n \"change_pwd_flow_v1\": true,\r\n \"enable_client_connections\": true,\r\n \"enable_apis_section\": true,\r\n \"enable_pipeline2\": true\r\n },\r\n \"friendly_name\": \"\",\r\n \"picture_url\": \"\",\r\n \"support_email\": \"\",\r\n \"support_url\": \"\",\r\n \"allowed_logout_urls\": [\r\n \"\"\r\n ],\r\n \"session_lifetime\": 0\r\n}" 1832 | }, 1833 | "url": { 1834 | "raw": "https://{{auth0_domain}}/api/v2/tenants/settings", 1835 | "protocol": "https", 1836 | "host": [ 1837 | "{{auth0_domain}}" 1838 | ], 1839 | "path": [ 1840 | "api", 1841 | "v2", 1842 | "tenants", 1843 | "settings" 1844 | ] 1845 | } 1846 | }, 1847 | "response": [] 1848 | } 1849 | ], 1850 | "description": "Tenants" 1851 | }, 1852 | { 1853 | "name": "Tickets", 1854 | "item": [ 1855 | { 1856 | "name": "Create an email verification ticket", 1857 | "request": { 1858 | "method": "POST", 1859 | "header": [ 1860 | { 1861 | "key": "Authorization", 1862 | "value": "Bearer {{auth0_token}}" 1863 | }, 1864 | { 1865 | "key": "Content-Type", 1866 | "value": "application/json" 1867 | } 1868 | ], 1869 | "body": { 1870 | "mode": "raw", 1871 | "raw": "{\r\n \"result_url\": \"\",\r\n \"user_id\": \"\"\r\n}" 1872 | }, 1873 | "url": { 1874 | "raw": "https://{{auth0_domain}}/api/v2/tickets/email-verification", 1875 | "protocol": "https", 1876 | "host": [ 1877 | "{{auth0_domain}}" 1878 | ], 1879 | "path": [ 1880 | "api", 1881 | "v2", 1882 | "tickets", 1883 | "email-verification" 1884 | ] 1885 | } 1886 | }, 1887 | "response": [] 1888 | }, 1889 | { 1890 | "name": "Create a password change ticket", 1891 | "request": { 1892 | "method": "POST", 1893 | "header": [ 1894 | { 1895 | "key": "Authorization", 1896 | "value": "Bearer {{auth0_token}}" 1897 | }, 1898 | { 1899 | "key": "Content-Type", 1900 | "value": "application/json" 1901 | } 1902 | ], 1903 | "body": { 1904 | "mode": "raw", 1905 | "raw": "{\r\n \"result_url\": \"\",\r\n \"user_id\": \"\",\r\n \"new_password\": \"\",\r\n \"connection_id\": \"\",\r\n \"email\": \"\",\r\n \"ttl_sec\": 0\r\n}" 1906 | }, 1907 | "url": { 1908 | "raw": "https://{{auth0_domain}}/api/v2/tickets/password-change", 1909 | "protocol": "https", 1910 | "host": [ 1911 | "{{auth0_domain}}" 1912 | ], 1913 | "path": [ 1914 | "api", 1915 | "v2", 1916 | "tickets", 1917 | "password-change" 1918 | ] 1919 | } 1920 | }, 1921 | "response": [] 1922 | } 1923 | ], 1924 | "description": "Tickets" 1925 | }, 1926 | { 1927 | "name": "User Blocks", 1928 | "item": [ 1929 | { 1930 | "name": "Get blocks by identifier", 1931 | "request": { 1932 | "method": "GET", 1933 | "header": [ 1934 | { 1935 | "key": "Authorization", 1936 | "value": "Bearer {{auth0_token}}" 1937 | } 1938 | ], 1939 | "body": { 1940 | "mode": "raw", 1941 | "raw": "" 1942 | }, 1943 | "url": { 1944 | "raw": "https://{{auth0_domain}}/api/v2/user-blocks", 1945 | "protocol": "https", 1946 | "host": [ 1947 | "{{auth0_domain}}" 1948 | ], 1949 | "path": [ 1950 | "api", 1951 | "v2", 1952 | "user-blocks" 1953 | ] 1954 | } 1955 | }, 1956 | "response": [] 1957 | }, 1958 | { 1959 | "name": "Unblock by identifier", 1960 | "request": { 1961 | "method": "DELETE", 1962 | "header": [ 1963 | { 1964 | "key": "Authorization", 1965 | "value": "Bearer {{auth0_token}}" 1966 | } 1967 | ], 1968 | "body": { 1969 | "mode": "raw", 1970 | "raw": "" 1971 | }, 1972 | "url": { 1973 | "raw": "https://{{auth0_domain}}/api/v2/user-blocks", 1974 | "protocol": "https", 1975 | "host": [ 1976 | "{{auth0_domain}}" 1977 | ], 1978 | "path": [ 1979 | "api", 1980 | "v2", 1981 | "user-blocks" 1982 | ] 1983 | } 1984 | }, 1985 | "response": [] 1986 | }, 1987 | { 1988 | "name": "Get a user's blocks", 1989 | "request": { 1990 | "method": "GET", 1991 | "header": [ 1992 | { 1993 | "key": "Authorization", 1994 | "value": "Bearer {{auth0_token}}" 1995 | } 1996 | ], 1997 | "body": { 1998 | "mode": "raw", 1999 | "raw": "" 2000 | }, 2001 | "url": { 2002 | "raw": "https://{{auth0_domain}}/api/v2/user-blocks/:id", 2003 | "protocol": "https", 2004 | "host": [ 2005 | "{{auth0_domain}}" 2006 | ], 2007 | "path": [ 2008 | "api", 2009 | "v2", 2010 | "user-blocks", 2011 | ":id" 2012 | ], 2013 | "variable": [ 2014 | { 2015 | "key": "id" 2016 | } 2017 | ] 2018 | } 2019 | }, 2020 | "response": [] 2021 | }, 2022 | { 2023 | "name": "Unblock a user", 2024 | "request": { 2025 | "method": "DELETE", 2026 | "header": [ 2027 | { 2028 | "key": "Authorization", 2029 | "value": "Bearer {{auth0_token}}" 2030 | } 2031 | ], 2032 | "body": { 2033 | "mode": "raw", 2034 | "raw": "" 2035 | }, 2036 | "url": { 2037 | "raw": "https://{{auth0_domain}}/api/v2/user-blocks/:id", 2038 | "protocol": "https", 2039 | "host": [ 2040 | "{{auth0_domain}}" 2041 | ], 2042 | "path": [ 2043 | "api", 2044 | "v2", 2045 | "user-blocks", 2046 | ":id" 2047 | ], 2048 | "variable": [ 2049 | { 2050 | "key": "id" 2051 | } 2052 | ] 2053 | } 2054 | }, 2055 | "response": [] 2056 | } 2057 | ], 2058 | "description": "User Blocks" 2059 | }, 2060 | { 2061 | "name": "Users", 2062 | "item": [ 2063 | { 2064 | "name": "List or search users", 2065 | "request": { 2066 | "method": "GET", 2067 | "header": [ 2068 | { 2069 | "key": "Authorization", 2070 | "value": "Bearer {{auth0_token}}" 2071 | } 2072 | ], 2073 | "body": { 2074 | "mode": "raw", 2075 | "raw": "" 2076 | }, 2077 | "url": { 2078 | "raw": "https://{{auth0_domain}}/api/v2/users", 2079 | "protocol": "https", 2080 | "host": [ 2081 | "{{auth0_domain}}" 2082 | ], 2083 | "path": [ 2084 | "api", 2085 | "v2", 2086 | "users" 2087 | ] 2088 | } 2089 | }, 2090 | "response": [] 2091 | }, 2092 | { 2093 | "name": "Create a user", 2094 | "request": { 2095 | "method": "POST", 2096 | "header": [ 2097 | { 2098 | "key": "Authorization", 2099 | "value": "Bearer {{auth0_token}}" 2100 | }, 2101 | { 2102 | "key": "Content-Type", 2103 | "value": "application/json" 2104 | } 2105 | ], 2106 | "body": { 2107 | "mode": "raw", 2108 | "raw": "{\r\n \"connection\": \"\",\r\n \"email\": \"\",\r\n \"username\": \"\",\r\n \"password\": \"\",\r\n \"phone_number\": \"\",\r\n \"user_metadata\": {},\r\n \"email_verified\": true,\r\n \"app_metadata\": {}\r\n}" 2109 | }, 2110 | "url": { 2111 | "raw": "https://{{auth0_domain}}/api/v2/users", 2112 | "protocol": "https", 2113 | "host": [ 2114 | "{{auth0_domain}}" 2115 | ], 2116 | "path": [ 2117 | "api", 2118 | "v2", 2119 | "users" 2120 | ] 2121 | }, 2122 | "description": "Creates a new user according to the JSON object received in body.
The samples on the right show you every attribute that could be used. The attribute connection is always mandatory but depending on the type of connection you are using there could be others too. For instance, Auth0 DB Connections require email and password." 2123 | }, 2124 | "response": [] 2125 | }, 2126 | { 2127 | "name": "Get a user", 2128 | "request": { 2129 | "method": "GET", 2130 | "header": [ 2131 | { 2132 | "key": "Authorization", 2133 | "value": "Bearer {{auth0_token}}" 2134 | } 2135 | ], 2136 | "body": { 2137 | "mode": "raw", 2138 | "raw": "" 2139 | }, 2140 | "url": { 2141 | "raw": "https://{{auth0_domain}}/api/v2/users/:id", 2142 | "protocol": "https", 2143 | "host": [ 2144 | "{{auth0_domain}}" 2145 | ], 2146 | "path": [ 2147 | "api", 2148 | "v2", 2149 | "users", 2150 | ":id" 2151 | ], 2152 | "variable": [ 2153 | { 2154 | "key": "id" 2155 | } 2156 | ] 2157 | } 2158 | }, 2159 | "response": [] 2160 | }, 2161 | { 2162 | "name": "Delete a user", 2163 | "request": { 2164 | "method": "DELETE", 2165 | "header": [ 2166 | { 2167 | "key": "Authorization", 2168 | "value": "Bearer {{auth0_token}}" 2169 | } 2170 | ], 2171 | "body": { 2172 | "mode": "raw", 2173 | "raw": "" 2174 | }, 2175 | "url": { 2176 | "raw": "https://{{auth0_domain}}/api/v2/users/:id", 2177 | "protocol": "https", 2178 | "host": [ 2179 | "{{auth0_domain}}" 2180 | ], 2181 | "path": [ 2182 | "api", 2183 | "v2", 2184 | "users", 2185 | ":id" 2186 | ], 2187 | "variable": [ 2188 | { 2189 | "key": "id" 2190 | } 2191 | ] 2192 | } 2193 | }, 2194 | "response": [] 2195 | }, 2196 | { 2197 | "name": "Update a user", 2198 | "request": { 2199 | "method": "PATCH", 2200 | "header": [ 2201 | { 2202 | "key": "Authorization", 2203 | "value": "Bearer {{auth0_token}}" 2204 | }, 2205 | { 2206 | "key": "Content-Type", 2207 | "value": "application/json" 2208 | } 2209 | ], 2210 | "body": { 2211 | "mode": "raw", 2212 | "raw": "{\r\n \"blocked\": true,\r\n \"email_verified\": true,\r\n \"email\": \"\",\r\n \"verify_email\": true,\r\n \"phone_number\": \"\",\r\n \"phone_verified\": true,\r\n \"verify_phone_number\": true,\r\n \"password\": \"\",\r\n \"verify_password\": true,\r\n \"user_metadata\": {},\r\n \"app_metadata\": {},\r\n \"connection\": \"\",\r\n \"username\": \"\",\r\n \"client_id\": \"\"\r\n}" 2213 | }, 2214 | "url": { 2215 | "raw": "https://{{auth0_domain}}/api/v2/users/:id", 2216 | "protocol": "https", 2217 | "host": [ 2218 | "{{auth0_domain}}" 2219 | ], 2220 | "path": [ 2221 | "api", 2222 | "v2", 2223 | "users", 2224 | ":id" 2225 | ], 2226 | "variable": [ 2227 | { 2228 | "key": "id" 2229 | } 2230 | ] 2231 | }, 2232 | "description": "Updates a user with the object's properties received in the request's body (the object should be a JSON object).
These are the attributes that can be updated at the root level:Some considerations:
Updating a field (non-metadata property)
To mark the email address of a user as verified, the body to send should be:
{ \"email_verified\": true }
Updating a user metadata root property
Let's asume that our test user has the following user_metadata:
{ \"user_metadata\" : { \"profileCode\": 1479 } }
To add the field addresses the body to send should be:
{ \"user_metadata\" : { \"addresses\": {\"work_address\": \"100 Industrial Way\"} }}
The modified object ends up with the following user_metadata property:
{\n  \"user_metadata\": {\n    \"profileCode\": 1479,\n    \"addresses\": { \"work_address\": \"100 Industrial Way\" }\n  }\n}
Updating an inner user metadata property
Starting from previous user metadata, if we want to add the field \"home_address\": \"742 Evergreen Terrace\" in addresses we should send the whole addresses object (since this object is on the first level, it will be merged in, but it's own properties won't). The body to send should be:\n
{\n  \"user_metadata\": {\n    \"addresses\": {\n      \"work_address\": \"100 Industrial Way\",\n      \"home_address\": \"742 Evergreen Terrace\"\n    }\n  }\n}
The modified object ends up with the following user_metadata property:
{\n  \"user_metadata\": {\n    \"profileCode\": 1479,\n    \"addresses\": {\n      \"work_address\": \"100 Industrial Way\",\n      \"home_address\": \"742 Evergreen Terrace\"\n    }\n  }\n}
" 2233 | }, 2234 | "response": [] 2235 | }, 2236 | { 2237 | "name": "Get user's log events", 2238 | "request": { 2239 | "method": "GET", 2240 | "header": [ 2241 | { 2242 | "key": "Authorization", 2243 | "value": "Bearer {{auth0_token}}" 2244 | } 2245 | ], 2246 | "body": { 2247 | "mode": "raw", 2248 | "raw": "" 2249 | }, 2250 | "url": { 2251 | "raw": "https://{{auth0_domain}}/api/v2/users/:user_id/logs", 2252 | "protocol": "https", 2253 | "host": [ 2254 | "{{auth0_domain}}" 2255 | ], 2256 | "path": [ 2257 | "api", 2258 | "v2", 2259 | "users", 2260 | ":user_id", 2261 | "logs" 2262 | ], 2263 | "variable": [ 2264 | { 2265 | "key": "user_id" 2266 | } 2267 | ] 2268 | }, 2269 | "description": "Retrieve every log event for a specific user id
Event acronym mapping
\n
List of fields that can be used in fields and sort
" 2270 | }, 2271 | "response": [] 2272 | }, 2273 | { 2274 | "name": "Get a list of Guardian enrollments", 2275 | "request": { 2276 | "method": "GET", 2277 | "header": [ 2278 | { 2279 | "key": "Authorization", 2280 | "value": "Bearer {{auth0_token}}" 2281 | } 2282 | ], 2283 | "body": { 2284 | "mode": "raw", 2285 | "raw": "" 2286 | }, 2287 | "url": { 2288 | "raw": "https://{{auth0_domain}}/api/v2/users/:id/enrollments", 2289 | "protocol": "https", 2290 | "host": [ 2291 | "{{auth0_domain}}" 2292 | ], 2293 | "path": [ 2294 | "api", 2295 | "v2", 2296 | "users", 2297 | ":id", 2298 | "enrollments" 2299 | ], 2300 | "variable": [ 2301 | { 2302 | "key": "id" 2303 | } 2304 | ] 2305 | }, 2306 | "description": "Retrieves all Guardian enrollments." 2307 | }, 2308 | "response": [] 2309 | }, 2310 | { 2311 | "name": "Delete a user's multifactor provider", 2312 | "request": { 2313 | "method": "DELETE", 2314 | "header": [ 2315 | { 2316 | "key": "Authorization", 2317 | "value": "Bearer {{auth0_token}}" 2318 | } 2319 | ], 2320 | "body": { 2321 | "mode": "raw", 2322 | "raw": "" 2323 | }, 2324 | "url": { 2325 | "raw": "https://{{auth0_domain}}/api/v2/users/:id/multifactor/:provider", 2326 | "protocol": "https", 2327 | "host": [ 2328 | "{{auth0_domain}}" 2329 | ], 2330 | "path": [ 2331 | "api", 2332 | "v2", 2333 | "users", 2334 | ":id", 2335 | "multifactor", 2336 | ":provider" 2337 | ], 2338 | "variable": [ 2339 | { 2340 | "key": "id" 2341 | }, 2342 | { 2343 | "key": "provider" 2344 | } 2345 | ] 2346 | } 2347 | }, 2348 | "response": [] 2349 | }, 2350 | { 2351 | "name": "Unlink a user identity", 2352 | "request": { 2353 | "method": "DELETE", 2354 | "header": [ 2355 | { 2356 | "key": "Authorization", 2357 | "value": "Bearer {{auth0_token}}" 2358 | } 2359 | ], 2360 | "body": { 2361 | "mode": "raw", 2362 | "raw": "" 2363 | }, 2364 | "url": { 2365 | "raw": "https://{{auth0_domain}}/api/v2/users/:id/identities/:provider/:user_id", 2366 | "protocol": "https", 2367 | "host": [ 2368 | "{{auth0_domain}}" 2369 | ], 2370 | "path": [ 2371 | "api", 2372 | "v2", 2373 | "users", 2374 | ":id", 2375 | "identities", 2376 | ":provider", 2377 | ":user_id" 2378 | ], 2379 | "variable": [ 2380 | { 2381 | "key": "id" 2382 | }, 2383 | { 2384 | "key": "provider" 2385 | }, 2386 | { 2387 | "key": "user_id" 2388 | } 2389 | ] 2390 | }, 2391 | "description": "Unlinks an identity from the target user, and it becomes a separated user again.\n" 2392 | }, 2393 | "response": [] 2394 | }, 2395 | { 2396 | "name": "Removes the current recovery token, generates and returns a new one", 2397 | "request": { 2398 | "method": "POST", 2399 | "header": [ 2400 | { 2401 | "key": "Authorization", 2402 | "value": "Bearer {{auth0_token}}" 2403 | }, 2404 | { 2405 | "key": "Content-Type", 2406 | "value": "application/json" 2407 | } 2408 | ], 2409 | "body": { 2410 | "mode": "raw", 2411 | "raw": "" 2412 | }, 2413 | "url": { 2414 | "raw": "https://{{auth0_domain}}/api/v2/users/:id/recovery-code-regeneration", 2415 | "protocol": "https", 2416 | "host": [ 2417 | "{{auth0_domain}}" 2418 | ], 2419 | "path": [ 2420 | "api", 2421 | "v2", 2422 | "users", 2423 | ":id", 2424 | "recovery-code-regeneration" 2425 | ], 2426 | "variable": [ 2427 | { 2428 | "key": "id" 2429 | } 2430 | ] 2431 | } 2432 | }, 2433 | "response": [] 2434 | }, 2435 | { 2436 | "name": "Link a user account", 2437 | "request": { 2438 | "method": "POST", 2439 | "header": [ 2440 | { 2441 | "key": "Authorization", 2442 | "value": "Bearer {{auth0_token}}" 2443 | }, 2444 | { 2445 | "key": "Content-Type", 2446 | "value": "application/json" 2447 | } 2448 | ], 2449 | "body": { 2450 | "mode": "raw", 2451 | "raw": "{\r\n \"provider\": \"\",\r\n \"connection_id\": \"\",\r\n \"user_id\": \"\",\r\n \"link_with\": \"\"\r\n}" 2452 | }, 2453 | "url": { 2454 | "raw": "https://{{auth0_domain}}/api/v2/users/:id/identities", 2455 | "protocol": "https", 2456 | "host": [ 2457 | "{{auth0_domain}}" 2458 | ], 2459 | "path": [ 2460 | "api", 2461 | "v2", 2462 | "users", 2463 | ":id", 2464 | "identities" 2465 | ], 2466 | "variable": [ 2467 | { 2468 | "key": "id" 2469 | } 2470 | ] 2471 | }, 2472 | "description": "Links the account specified in the body (secondary account) to the account specified by the id param of the URL (primary account).
There are two ways of invoking the endpoint:
On successful linking, the endpoint returns the new array of the primary account identities." 2473 | }, 2474 | "response": [] 2475 | } 2476 | ], 2477 | "description": "Users" 2478 | }, 2479 | { 2480 | "name": "Users By Email", 2481 | "item": [ 2482 | { 2483 | "name": "Search users by email", 2484 | "request": { 2485 | "method": "GET", 2486 | "header": [ 2487 | { 2488 | "key": "Authorization", 2489 | "value": "Bearer {{auth0_token}}" 2490 | } 2491 | ], 2492 | "body": { 2493 | "mode": "raw", 2494 | "raw": "" 2495 | }, 2496 | "url": { 2497 | "raw": "https://{{auth0_domain}}/api/v2/users-by-email?email=", 2498 | "protocol": "https", 2499 | "host": [ 2500 | "{{auth0_domain}}" 2501 | ], 2502 | "path": [ 2503 | "api", 2504 | "v2", 2505 | "users-by-email" 2506 | ], 2507 | "query": [ 2508 | { 2509 | "key": "email", 2510 | "value": "", 2511 | "description": "Email address to search for" 2512 | } 2513 | ] 2514 | }, 2515 | "description": "If Auth0 is the identify provider (idP), the email address associated with a user is saved in lower case, regardless of how you initially provided it. For example, if you register a user as **JohnSmith@example.com**, Auth0 saves the user's email as **johnsmith@example.com**.\n\nIn cases where Auth0 is not the idP, the `email` is stored based on the rules of idP, so make sure the search is made using the correct capitalization.\n\nWhen using this endpoint, make sure that you are searching for users via email addresses using the correct case." 2516 | }, 2517 | "response": [] 2518 | } 2519 | ] 2520 | } 2521 | ] 2522 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # postman-collections 2 | Postman collections for Auth0 public APIs 3 | 4 | This repository tracks the [Postman](https://www.getpostman.com/) collections for [Auth0's public APIs](https://auth0.com/docs/api/info): 5 | 6 | - [Authentication API](https://auth0.com/docs/api/authentication) 7 | - [Management API v2](https://auth0.com/docs/api/management/v2) 8 | 9 | Note: The collection for **Management API v2** is generated automatically from (internal) OpenAPI definitions, so there shouldn't be PRs with individual modifications as they would be lost on the next automatic update. If you see something wrong or missing, please create an issue instead to keep track of it. 10 | --------------------------------------------------------------------------------