View Source WorkOS.Portal (WorkOS SDK for Elixir v1.1.0)

Manage Portal in WorkOS.

@see https://workos.com/docs/reference/admin-portal

Summary

Functions

Link to this function

generate_link(client \\ WorkOS.client(), opts)

View Source

Generates a Portal Link

Parameter options:

  • :organization - An Organization identifier. (required)
  • :intent - The intent of the Admin Portal. (required)
  • :return_url - The URL to which WorkOS should send users when they click on the link to return to your website.
  • :success_url - The URL to which WorkOS will redirect users to upon successfully setting up Single Sign-On or Directory Sync.