This endpoint may be limited by an effective new user policy. Scanning the QR code adds the user's account to the app so that they receive and respond to Duo Push login requests. It creates the user in Duo and returns a code (as a QR code) that Duo Mobile can scan with its built-in camera. The /enroll endpoint provides a programmatic way to enroll new users with Duo two-factor authentication. On failure, the response is the standard error JSON. On success, the response body is Content-Type image/png, containing the logo. The /logo endpoint provides a programmatic way to retrieve your stored logo. ![]() This endpoint is also suitable for use with Duo's v2 Web SDK to verify integration information before initializing frame authentication. The /check endpoint can be called to verify that the Auth API integration and secret keys are valid, and that the signature is being generated properly. ![]() This endpoint is also suitable for use with Duo's v2 Web SDK to verify that Duo's service is responding before initializing frame authentication. Unlike the other endpoints, this one does not have to be signed with the Authorization header. The /ping endpoint acts as a "liveness check" that can be called to verify that Duo is up before trying to call other Auth API endpoints. API Clientsĭuo Security has demonstration clients available on GitHub to call the Duo API methods. Adding Duo requires some understanding of your application's language and authentication process. Review the API Details to see how to construct your first API request. See Duo Knowledge Base article 7546 for additional guidance. If your organization requires IP-based rules, please review Duo Knowledge Base article 1337.Įffective June 30, 2023, Duo no longer supports TLS 1.0 or 1.1 connections or insecure TLS/SSL cipher suites. This application communicates with Duo's service on SSL TCP port 443.įirewall configurations that restrict outbound access to Duo's service with rules using destination IP addresses or IP address ranges aren't recommended, since these may change over time to maintain our service's high availability. See Protecting Applications for more information about protecting applications in Duo and additional application options. ![]() You'll need this information to complete your setup. Click Protect to the far-right to configure the application and get your integration key, secret key, and API hostname. Log in to the Duo Admin Panel and navigate to Applications.Ĭlick Protect an Application and locate the entry for Auth API in the applications list. Please note that all Unix timestamps are in seconds, except where noted. Until the property is documented here its format may change or it may even be entirely removed from our API. For instance, Duo may make available a beta feature involving extra information returned by an API endpoint. New, undocumented properties may also appear at any time. Duo will update our API documentation with changes to property values in a timely fashion, adding new property values or indicating changes to existing property values. Duo may cease to return legacy values for properties as well. ![]() Properties that enumerate choices may gain new values at any time. When Duo deprecates a property, the API continues to accept that property in requests, although it no longer has any effect. Once a given API endpoint is documented to return a given property, a property with that name will always appear (although certain properties may only appear under certain conditions, like if the customer is using a specific edition). About the Auth APIĭuo's Auth API is available in the Duo Premier, Duo Advantage, Duo Essentials, and Duo Free plans.ĭocumented properties will not be removed within a stable version of the API. Check out the Duo Two-Factor Authentication API for Applications Solution Guide for an Auth API tutorial. The Duo Auth API is a low-level, RESTful API for adding strong two-factor authentication to your website or application.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |