View Source WorkOS.Portal (WorkOS SDK for Elixir v0.4.0)

The Portal module provides resource methods for working with the Admin Portal product

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

Link to this section Summary

Functions

Generate a link to grant access to an organization's Admin Portal

Link to this section Functions

Link to this function

generate_link(params, opts \\ [])

View Source

Generate a link to grant access to an organization's Admin Portal

parameters

Parameters

  • params (map)
    • intent (string) The access scope for the generated Admin Portal link. Valid values are: ["sso", "dsync", "audit_logs", "log_streams"]
    • organization (string) The ID of the organization the Admin Portal link will be generated for.
    • return_url (string) The URL that the end user will be redirected to upon exiting the generated Admin Portal. If none is provided, the default redirect link set in your WorkOS Dashboard will be used.
    • success_url (string) he URL to which WorkOS will redirect users to upon successfully setting up Single Sign On or Directory Sync.

example

Example

WorkOS.Portal.generate_link(%{ intent: "sso", organization: "org_1234" })