/authorize's "prompt" parameter not documented

I’m working with OIDC Silent Authentication, and the tutorial describes using the “prompt” parameter on the /authorize API: https://auth0.com/docs/api-auth/tutorials/silent-authentication

However I can’t find out any more about this parameter - it’s not mentioned in the reference documentation, as far as I can tell:


I’d like to know what happens if you set it to “true” or don’t send it. Can this be documented?

Welcome Back, Davidread!

The prompt parameter is documented in here - https://auth0.com/docs/api/authentication?_ga=2.138500725.753008429.1585727371-1633451998.1585727371#authorize-application

The possible values for prompt are

  1. prompt=none
  2. promp=login
  3. No prompt parameter sent

1 & 3 behave the same way. If there is a valid auth0 session, the user gets SSOed in as described here - https://auth0.com/docs/api-auth/tutorials/silent-authentication#successful-authentication-response and if no valid auth0 session force an error response is provided as described here - https://auth0.com/docs/api-auth/tutorials/silent-authentication#error-response

Regarding 2, the user is forced to login irrespective of whether a valid auth0 session exists or not.

2 Likes

Thanks a lot for sharing that knowledge @sandeep.neerarambham!

This topic was automatically closed 15 days after the last reply. New replies are no longer allowed.