View Source WorkOS.Portal (WorkOS SDK for Elixir v1.1.0)
Manage Portal in WorkOS.
Summary
Functions
Generates a Portal Link
Functions
@spec generate_link(WorkOS.Client.t(), map()) :: WorkOS.Client.response(WorkOS.Portal.Link.t())
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.