---
descriptions:
  generate_portal_link:
    organization: 'An [Organization](/reference/organization) identifier.'
    intent:
      lowercase: |
        The intent of the Admin Portal.
          - `sso` - Launch Admin Portal for creating SSO connections
          - `dsync` - Launch Admin Portal for creating Directory Sync connections
          - `audit_logs` - Launch Admin Portal for viewing Audit Logs
          - `log_streams` - Launch Admin Portal for creating Log Streams
          - `domain_verification` - Launch Admin Portal for Domain Verification
          - `certificate_renewal` - Launch Admin Portal for renewing SAML Certificates
      titlecase: |
        The intent of the Admin Portal.
          - `SSO` - Launch Admin Portal for creating SSO connections
          - `DSync` - Launch Admin Portal for creating Directory Sync connections
          - `AuditLogs` - Launch Admin Portal for viewing Audit Logs
          - `LogStreams` - Launch Admin Portal for creating Log Streams
          - `DomainVerification` - Launch Admin Portal for Domain Verification
          - `CertificateRenewal` - Launch Admin Portal for renewing SAML Certificates
    return_url: >-
      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: >-
      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.
reference:
  curl:
    - key: generate_portal_link
      id: generate_portal_link
      url: /reference/admin-portal/portal-link/generate
      title: /portal/generate_link
      type: POST
      parameters:
        - key: organization
          type: string
          description: (generate_portal_link.organization)
        - key: intent
          type: enum
          description: (generate_portal_link.intent.lowercase)
        - key: return_url
          optional: true
          type: string
          description: (generate_portal_link.return_url)
        - key: success_url
          optional: true
          type: string
          description: (generate_portal_link.success_url)
      returns:
        - key: anonymous
          type: object
          unwrap: true
          properties:
            - key: link
              type: string
              description: (portal_link.link)
  dotnet:
    - key: GenerateLink
      id: generate_portal_link
      url: /reference/admin-portal/portal-link/generate
      title: portalService.GenerateLink()
      parameters:
        - key: options
          type: GenerateLinkOptions
          expanded: true
          properties:
            - key: Organization
              type: string
              description: (generate_portal_link.organization)
            - key: Intent
              type: Intent
              description: (generate_portal_link.intent.titlecase)
            - key: ReturnURL
              optional: true
              type: string
              description: (generate_portal_link.return_url)
            - key: SuccessURL
              optional: true
              type: string
              description: (generate_portal_link.success_url)
        - (cancellationToken)
      returns:
        - key: Task<string>
          description: (portal_link.link)
  ruby:
    - key: generate_link
      id: generate_portal_link
      url: /reference/admin-portal/portal-link/generate
      title: Portal.generate_link()
      parameters:
        - key: organization
          type: String
          description: (generate_portal_link.organization)
        - key: intent
          type: String
          description: (generate_portal_link.intent.lowercase)
        - key: return_url
          optional: true
          type: String
          description: (generate_portal_link.return_url)
        - key: success_url
          optional: true
          type: String
          description: (generate_portal_link.success_url)
      returns:
        - key: link
          type: String
          description: (portal_link.link)
  js:
    - key: generateLink
      id: generate_portal_link
      url: /reference/admin-portal/portal-link/generate
      title: portal.generateLink()
      parameters:
        - key: options
          type: object
          unwrap: true
          properties:
            - key: organization
              type: string
              description: (generate_portal_link.organization)
            - key: intent
              type: string
              description: (generate_portal_link.intent.lowercase)
            - key: returnUrl
              optional: true
              type: string
              description: (generate_portal_link.return_url)
            - key: successUrl
              optional: true
              type: string
              description: (generate_portal_link.success_url)
      returns:
        - key: anonymous
          type: object
          unwrap: true
          properties:
            - key: link
              type: string
              description: (portal_link.link)
  python:
    - key: generate_link
      id: generate_portal_link
      url: /reference/admin-portal/portal-link/generate
      title: portal.generate_link()
      parameters:
        - key: organization
          type: str
          description: (generate_portal_link.organization)
        - key: intent
          type: PortalLinkIntent
          description: (generate_portal_link.intent.lowercase)
        - key: return_url
          optional: true
          type: str
          description: (generate_portal_link.return_url)
        - key: success_url
          optional: true
          type: str
          description: (generate_portal_link.success_url)
      returns:
        - key: link
          type: str
          description: (portal_link.link)
  go:
    - key: GenerateLink
      id: generate_portal_link
      url: /reference/admin-portal/portal-link/generate
      title: portal.GenerateLink()
      parameters:
        - (ctx)
        - key: opts
          type: portal.GenerateLinkOpts
          expanded: true
          properties:
            - key: Organization
              type: string
              description: (generate_portal_link.organization)
            - key: Intent
              type: portal.GenerateLinkIntent
              description: (generate_portal_link.intent.titlecase)
            - key: ReturnURL
              optional: true
              type: string
              description: (generate_portal_link.return_url)
            - key: SuccessURL
              optional: true
              type: string
              description: (generate_portal_link.success_url)
      returns:
        - key: link
          type: string
          description: (portal_link.link)
        - (err)
  php:
    - key: generateLink
      id: generate_portal_link
      url: /reference/admin-portal/portal-link/generate
      title: $portal->generateLink()
      parameters:
        - key: organization
          type: string
          description: (generate_portal_link.organization)
        - key: intent
          type: string
          description: (generate_portal_link.intent.lowercase)
        - key: return_url
          optional: true
          type: string
          description: (generate_portal_link.return_url)
        - key: success_url
          optional: true
          type: string
          description: (generate_portal_link.success_url)
      returns:
        - key: anonymous
          type: array
          unwrap: true
          properties:
            - key: link
              type: string
              description: (portal_link.link)
  java:
    - key: generate_portal_link
      id: generate_portal_link
      url: /reference/admin-portal/portal-link/generate
      title: portal.generateLink()
      parameters:
        - key: options
          type: GeneratePortalLinkOptions
          expanded: true
          properties:
            - key: organization
              type: String
              description: (generate_portal_link.organization)
            - key: intent
              type: Intent
              description: (generate_portal_link.intent.lowercase)
            - key: returnUrl
              optional: true
              type: String
              description: (generate_portal_link.return_url)
            - key: builder()
              type: GeneratePortalLinkOptionsBuilder
              description: (java.builder)
      returns:
        - key: response
          type: Link
          expanded: true
          properties:
            - key: link
              type: String
              description: (portal_link.link)
originalPath: >-
  .tmp-workos-clone/packages/docs/content/reference/admin-portal/portal-link/generate.mdx
---

## Generate a Portal Link

Generate a Portal Link scoped to an Organization.

<CodeBlock referenceId="generate_portal_link">
  <CodeBlockTab title="Request" file="generate-portal-link-request" />
  <CodeBlockTab title="Response" file="generate-portal-link-response" />
</CodeBlock>