WorkOS
portal.generate_link.create
Generate a Portal Link scoped to an Organization.
Remote workos
Other tools also called portal.generate_link.create?
See providers with this name
Input Schema
{
"type": "object",
"properties": {
"intent": {
"enum": [
"sso",
"dsync",
"audit_logs",
"log_streams",
"domain_verification",
"certificate_renewal",
"bring_your_own_key"
],
"type": "string",
"description": "\n The intent of the Admin Portal.\n - `sso` - Launch Admin Portal for creating SSO connections\n - `dsync` - Launch Admin Portal for creating Directory Sync connections\n - `audit_logs` - Launch Admin Portal for viewing Audit Logs\n - `log_streams` - Launch Admin Portal for creating Log Streams\n - `domain_verification` - Launch Admin Portal for Domain Verification\n - `certificate_renewal` - Launch Admin Portal for renewing SAML Certificates\n - `bring_your_own_key` - Launch Admin Portal for configuring Bring Your Own Key"
},
"return_url": {
"type": "string",
"description": "The URL to go to when an admin clicks on your logo in the Admin Portal. If not specified, the return URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used."
},
"success_url": {
"type": "string",
"description": "The URL to redirect the admin to when they finish setup. If not specified, the success URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used."
},
"admin_emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "The email addresses of the IT admins to grant access to the Admin Portal for the given organization. Accepts up to 20 emails."
},
"organization": {
"type": "string",
"description": "An [Organization](/reference/organization) identifier."
},
"intent_options": {
"type": "object",
"required": [
"sso"
],
"properties": {
"sso": {
"type": "object",
"properties": {
"bookmark_slug": {
"type": "string",
"description": "The bookmark slug to use for SSO."
},
"provider_type": {
"type": "string",
"description": "The SSO provider type to configure."
}
}
}
}
}
}
}