This article describes how to make an OpenID Connect (OIDC) app visible in the Okta Dashboard and the different login flows available.
- OpenID Connect Application of type Web
- OpenID Connect Application of type SPA
For an OpenID Connect / OAuth application to appear as an app in the Okta Dashboard, the application's General Settings will need to be configured as follows (see below for additional options):
- (Optional) Implicit (hybrid) > Allow ID Token with implicit grant type enabled.
- This must be completed to use the Okta Simplified option discussed below.
- Login initiated by set to Either Okta or App.
- When the Login initiated by is chosen as Either Okta or App, these two login options and the "Initiate login URI" setting will now be available for the application:
- Redirect to app to initiate login.
- For this, Okta will redirect to an app endpoint, which is expected to start an authorized redirect back to Okta. Since the user is on the Okta dashboard when this happens, Okta typically responds with code/token to callback and expects the app to move forward with its regular flow.
- This flow can be chosen for a SPA or a Web application type. When the end-users click an application on the Okta dashboard, they are redirected to the initiate_login_uri of the client application with the query parameter 'iss' ('iss' would be okta org). The application is expected to construct an authorization request and redirect the end-user back to Okta.
- This login flow conforms to Section 4 of the OpenID Connect specification.
- Send ID Token directly to app (Okta Simplified).
- This flow is available only for SPA. On choosing this option, one can also choose 'scopes'. When the end-user clicks on the application tile at the Okta dashboard, Okta mints an id_token and makes a POST request to the 'initiate_login_uri' with the id_token in the body of the POST request. Okta will send the token directly to an app endpoint, which would be expected to consume it and use it.
- NOTE: Must have the Grant Type Implicit (hybrid) > Allow ID Token with implicit grant type enabled to use this option.
- Redirect to app to initiate login.
- When the Login initiated by is chosen as Either Okta or App, these two login options and the "Initiate login URI" setting will now be available for the application:
- Initiate login URI must be set to the appropriate URL for the application (details about what this route needs to do to complete user login outlined above).
- Application visibility with Display application icon to users checked.
NOTE:
- Native OIDC applications will not appear on the end-user dashboard and cannot be configured to appear. To have an application tile appear on the end-user's dashboard for a Native OIDC integration, to set up a Bookmark application that redirects users to the specified application.
- The configured
initiate_login_uriis the URL that Okta redirects to when the end-user clicks on the application at the Okta dashboard. Only users assigned to the application will see the bookmark.
