on_return_url Event

Fires when the user is redirected to the embedded web server.

Syntax

class OAuthReturnURLEventParams(object):
  @property
  def url_path() -> str: ...
  @property
  def query_string() -> str: ...
  @property
  def response_headers() -> str: ...
  @response_headers.setter
  def response_headers(value) -> None: ...
  @property
  def response_body() -> str: ...
  @response_body.setter
  def response_body(value) -> None: ...

# In class OAuth:
@property
def on_return_url() -> Callable[[OAuthReturnURLEventParams], None]: ...
@on_return_url.setter
def on_return_url(event_hook: Callable[[OAuthReturnURLEventParams], None]) -> None: ...

Remarks

When client_profile is set to cfApplication and the embedded web server is used (default), this event will fire when the user is redirected from authorization server back to the local embedded web server. The event provides an opportunity to set the ResponseHeaders and ResponseBody and provide a custom response that the user will see in their browser.

URLPath and QueryString are informational parameters that show the values sent by the authorization server.