Welcome to the Login.gov developer guide

<!DOCTYPE html> <html lang="en"> <head>  <script async src="https://www.googletagmanager.com/gtag/js?id=G-HBYXWFP794"></script> <script> window.dataLayer = window.dataLayer || []; function gtag() { dataLayer.push(arguments); } gtag('js', new Date()); gtag('config', 'G-HBYXWFP794'); </script>  <script async type="text/javascript" src="https://dap.digitalgov.gov/Universal-Federated-Analytics-Min.js?agency=GSA&subagency=TTS" id="_fed_an_ua_tag"></script> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="HandheldFriendly" content="True"> <meta name="MobileOptimized" content="320"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Welcome to the Login.gov developer guide | Login.gov</title> <meta property="og:title" content="Welcome to the Login.gov developer guide | Login.gov"> <meta name="description" content="This developer guide contains everything you鈥檒l need to integrate and deploy your application with Login.gov."> <meta property="og:description" content="This developer guide contains everything you鈥檒l need to integrate and deploy your application with Login.gov."> <meta name="twitter:card" value="summary"> <meta property="og:type" content="article"> <link rel="shortcut icon" type="image/ico" href="/assets/img/favicons/favicon.ico"> <link rel="stylesheet" href="/assets/css/main.css"> </head> <body> <a class="usa-skipnav" href="#main-content">Skip to main content</a> <section class="usa-banner" aria-label="Official government website"> <div class="usa-accordion"> <header class="usa-banner__header"> <div class="usa-banner__inner"> <div class="grid-col-auto"> <img class="usa-banner__header-flag" src="/assets/img/us_flag_small.png" alt="U.S. flag"> </div> <div class="grid-col-fill tablet:grid-col-auto"> <p class="usa-banner__header-text">An official website of the United States government</p> <p class="usa-banner__header-action" aria-hidden="true">Here鈥檚 how you know</p> </div> <button class="usa-accordion__button usa-banner__button" aria-expanded="false" aria-controls="gov-banner"> <span class="usa-banner__button-text">Here鈥檚 how you know</span> </button> </div> </header> <div class="usa-banner__content usa-accordion__content" id="gov-banner"> <div class="grid-container"> <div class="grid-row grid-gap-lg"> <div class="usa-banner__guidance tablet:grid-col-6"> <img src="/assets/img/icon-dot-gov.svg" class="usa-banner__icon usa-media-block__img" alt="Dot gov" role="img"> <div class="usa-media-block__body"> <p> <strong>Official websites use .gov</strong> <br> A <strong>.gov</strong> website belongs to an official government organization in the United States. </p> </div> </div> <div class="usa-banner__guidance tablet:grid-col-6"> <img src="/assets/img/icon-https.svg" class="usa-banner__icon usa-media-block__img" alt="Https" role="img"> <div class="usa-media-block__body"> <p> <strong>Secure .gov websites use HTTPS</strong> <br> A <strong>lock ( <img src="/assets/img/lock.svg" class="usa-banner__lock-image" alt="Https" role="img"> )</strong> or <strong>https://</strong> means you've safely connected to the .gov website. Share sensitive information only on official, secure websites. </p> </div> </div> </div> </div> </div> </div> </section> <div class="usa-overlay"></div> <header class="usa-header usa-header--extended" role="banner"> <div class="usa-navbar"> <h1 class="usa-logo" id="basic-logo"> <a href="/" title="Home" aria-label="Home"> <img src="/assets/img/login-gov-logo.svg" class="usa-logo__img" alt="Login.gov" role="img"> <em class="usa-logo__text">Developers</em> </a> </h1> <section class="desktop:display-block mobile:display-none" aria-label="Search component">  <form accept-charset="UTF-8" action="https://search.usa.gov/search" class="usa-search usa-search--1" id="search_form" method="get" role="search" > <input name="utf8" type="hidden" value="✓" /> <input type="hidden" name="affiliate" id="affiliate" value="developers-login-gov" autocomplete="off" /> <label class="usa-sr-only" for="search-field-header-nav">Search</label> <input type="search" name="query" id="search-field-header-nav" autocomplete="off" class="usa-input" /> <button class="usa-button" type="submit" name="commit" value="Search" data-disable-with="Search"> <span class="usa-search__submit-text">Search</span> </button> </form> </section> <button class="usa-menu-btn">Menu</button> </div> <nav role="navigation" class="usa-nav border-top-none"> <div class="usa-nav__inner"> <button class="usa-nav__close" aria-label="close"> <svg class="usa-icon" aria-hidden="true" focusable="false" role="img"> <use xlink:href="/assets/img/sprite.svg#close"></use> </svg> </button> <div class="usa-nav__secondary desktop:padding-right-2"> <section class="mobile:display-block desktop:display-none" aria-hidden="true">  <form accept-charset="UTF-8" action="https://search.usa.gov/search" class="usa-search usa-search--1" id="search_form" method="get" role="search" > <input name="utf8" type="hidden" value="✓" /> <input type="hidden" name="affiliate" id="affiliate" value="developers-login-gov" autocomplete="off" /> <label class="usa-sr-only" for="search-field-header-nav-mobile">Search</label> <input type="search" name="query" id="search-field-header-nav-mobile" autocomplete="off" class="usa-input" /> <button class="usa-button" type="submit" name="commit" value="Search" data-disable-with="Search"> <span class="usa-search__submit-text">Search</span> </button> </form> </section> </div> <ul class="usa-nav__primary usa-accordion flex-justify"> <a href="https://dashboard.int.identitysandbox.gov/" class="mobile:display-block desktop:display-none usa-button flex-align-self-center" type="button">Go to Portal</a> <li class="usa-nav__primary-item"> <a href="/" class="usa-current"> <span> Get Started </span> </a> <ul class="desktop:display-none usa-sidenav__sublist"> </ul> </li> <li class="usa-nav__primary-item"> <a href="/overview/" class=""> <span> Integration </span> </a> </li> <li class="usa-nav__primary-item"> <a href="/oidc/getting-started/" class=""> <span> OpenID Connect </span> </a> </li> <li class="usa-nav__primary-item"> <a href="/saml/getting-started/" class=""> <span> SAML </span> </a> </li> <li class="usa-nav__primary-item"> <a href="/attributes/" class=""> <span> Attributes </span> </a> </li> <li class="usa-nav__primary-item"> <a href="/user-experience/getting-started/" class=""> <span> User Experience </span> </a> </li> <li class="usa-nav__primary-item"> <a href="/testing/" class=""> <span> Testing </span> </a> </li> <li class="usa-nav__primary-item"> <a href="/production/" class=""> <span> Production </span> </a> </li> <li class="usa-nav__primary-item"> <a href="/security-events/" class=""> <span> Security </span> </a> </li> <li class="usa-nav__primary-item"> <a href="/support/" class=""> <span> Support </span> </a> </li> <div class="desktop:margin-right-neg-2 grid-row flex-fill flex-justify-end"> <a href="https://dashboard.int.identitysandbox.gov/" class="mobile:display-none desktop:display-inline usa-button flex-align-self-center" type="button">Go to Portal</a> </div> </ul> </div> </nav> <div aria-label="hero" class="usa-dark-background usa-section usa-section--dark"> <div class="grid-container"> <div class="grid-row"> <div class="grid-col-9 grid-offset-2"> <h1 class="usa-display">Welcome to the Login.gov developer guide</h1> <div class="usa-intro"><p>This developer guide contains everything you鈥檒l need to integrate and deploy your application with Login.gov.</p> </div> </div> </div> </div> </div> </header> <main id="main-content"> <div class="grid-container"> <div class="desktop:grid-col-9 desktop:grid-offset-2 mobile:grid-col-auto mobile:padding-2"> <h2 class="margin-top-4">How to integrate with Login.gov</h2> <ol class="usa-process-list usa-prose margin-bottom-4"> <li class="usa-process-list__item"> <p> Your integration with Login.gov starts in the <a href="/testing/#using-the-sandbox" class="usa-link">portal</a> where you can register your app. </p> </li> <li class="usa-process-list__item"> <p> Determine your application needs, like the level of proofing and <a href="/attributes/" class="usa-link">user attributes</a> that will be requested. </p> </li> <li class="usa-process-list__item"> <p> Select between <a href="/oidc/getting-started/" class="usa-link">Open ID Connect</a> (OIDC) or <a href="/saml/getting-started/" class="usa-link">SAML</a> implementation protocols. </p> </li> <li class="usa-process-list__item"> <p> Configure your app in the portal and start <a href="/testing/" class="usa-link">testing</a>! We have implementation guides and example apps to get you up and running quickly. </p> </li> <li class="usa-process-list__item"> <p> When you are ready to go live our team will help you <a href="/production/" class="usa-link">promote the application to production</a>. We will check against our production checklist to ensure your application is ready for production from an administrative and technical standpoint. </p> </li> </ol> <hr class="text-primary-light border-solid measure-5 margin-x-0" /> <section class="usa-section usa-prose padding-top-5"> <h2>Integration support for developers</h2> <p class="measure-5 margin-x-0"> If you are with a government agency partner, check our <a class="usa-link" href="/support/#frequently-asked-questions">FAQ</a> page for answers to the most common questions. If you need further technical assistance with an integration, you can <a class="usa-link" href="/support/#contacting-partner-support">contact Partner Support</a>. </p> <p class="measure-5 margin-x-0"> For help signing in or verifying your identity with Login.gov, please visit the <a href="https://login.gov/help/" class="usa-link">Login.gov Help Center</a> or <a href="https://login.gov/contact/" class="usa-link">contact us</a>. </p> </section> </div> </div> </main> <footer class="footer"> <div class="footer-navigation grid-container grid-row"> <div class="footer-navigation__section grid-col-12 margin-y-2 tablet:grid-col-auto"> <img src="/assets/img/logo.svg" alt="Login.gov logo" width="191" height="27" /> </div> <div class="grid-col-fill"></div> <div class="grid-col-12 tablet:grid-col-auto"> <nav aria-label="Footer navigation" class="grid-row grid-gap-2 tablet:grid-gap-6" > <section class="grid-col-6 tablet:grid-col-auto margin-y-2 footer-navigation__section"> <h2>For agencies</h2> <ul> <li> <a href="https://www.login.gov/partners/"> Become a Partner </a> </li> <li> <a href="/"> Developer Guide </a> </li> </ul> </section> <section class="grid-col-6 tablet:grid-col-auto margin-y-2 footer-navigation__section"> <h2>Learn</h2> <ul> <li> <a href="https://www.login.gov/about-us/"> About us </a> </li> <li> <a href="https://www.login.gov/accessibility/"> Accessibility </a> </li> <li> <a href="https://www.login.gov/join/"> Join us </a> </li> <li> <a href="https://www.login.gov/policy/"> Privacy & Security </a> </li> </ul> </section> <section class="grid-col-6 tablet:grid-col-auto margin-y-2 footer-navigation__section"> <h2>Support</h2> <ul> <li> <a href="https://www.login.gov/contact/"> Contact us </a> </li> <li> <a href="https://www.login.gov/help/"> Help Center </a> </li> </ul> </section> </nav> <div class="system-status"> <a class="font-body-2xs" href="https://status.login.gov">Login.gov system status</a> </div> </div> </div> <div class="usa-identifier"> <section class="usa-identifier__section usa-identifier__section--masthead" aria-label="Agency identifier"> <div class="usa-identifier__container"> <div class="usa-identifier__logos"> <a href="https://www.gsa.gov" class="usa-identifier__logo"> <img class="usa-identifier__logo-img" src="/assets/img/gsa-logo.svg" alt="GSA homepage" /> </a> </div> <div class="usa-identifier__identity" aria-label="Agency description"> <p class="usa-identifier__identity-domain">Login.gov</p> <p class="usa-identifier__identity-disclaimer"> An official website of the <a href="https://www.gsa.gov" class="usa-link">General Services Administration</a> </p> </div> </div> </section> <nav class="usa-identifier__section usa-identifier__section--required-links" aria-label="Important links"> <div class="usa-identifier__container"> <ul class="usa-identifier__required-links-list"> <li class="usa-identifier__required-links-item"> <a href="https://www.gsa.gov" class="usa-identifier__required-link"> About GSA </a> </li> <li class="usa-identifier__required-links-item"> <a href="https://www.gsa.gov/website-information/accessibility-aids" class="usa-identifier__required-link"> Accessibility support </a> </li> <li class="usa-identifier__required-links-item"> <a href="https://www.gsa.gov/reference/freedom-of-information-act-foia" class="usa-identifier__required-link usa-link"> FOIA requests </a> </li> <li class="usa-identifier__required-links-item"> <a href="https://www.gsa.gov/reference/civil-rights-programs/the-no-fear-act" class="usa-identifier__required-link usa-link"> No FEAR Act data </a> </li> <li class="usa-identifier__required-links-item"> <a href="https://www.gsaig.gov/" class="usa-identifier__required-link usa-link"> Office of the Inspector General </a> </li> <li class="usa-identifier__required-links-item"> <a href="https://www.gsa.gov/reference/reports/budget-performance" class="usa-identifier__required-link usa-link"> Performance reports </a> </li> <li class="usa-identifier__required-links-item"> <a href="https://www.gsa.gov/website-information/website-policies" class="usa-identifier__required-link usa-link"> Privacy policy </a> </li> </ul> </div> </nav> <section class="usa-identifier__section usa-identifier__section--usagov" aria-label="U.S. governement information and services"> <div class="usa-identifier__container"> <p class="usa-identifier__usagov-description"> Looking for U.S. government information and services? </p> <a href="https://www.usa.gov/" class="usa-link"> Visit USA.gov </a> </div> </section> </div> </footer> <script src="/assets/js/toggle_view.js"></script> <script src="/assets/js/main.js"></script> <script src="/assets/js/anchor.js"></script> <script> anchors.add([ '#main-content h1:not(.usa-accordion__heading)', '#main-content h2:not(.usa-accordion__heading)', '#main-content h3:not(.usa-accordion__heading)', '#main-content h4:not(.usa-accordion__heading)' ].join(', ')); </script> <script src="https://touchpoints.app.cloud.gov/touchpoints/c2c76249.js" async></script> </body> </html>

CINXE.COM

Welcome to the Login.gov developer guide | Login.gov