/*@jsxRuntime automatic @jsxImportSource react*/
const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];
const {useMDXComponents: _provideComponents} = arguments[0];
function _createMdxContent(props) {
  const _components = Object.assign({
    h1: "h1",
    p: "p",
    div: "div",
    h2: "h2",
    a: "a",
    h3: "h3",
    ul: "ul",
    li: "li",
    strong: "strong",
    code: "code",
    pre: "pre",
    span: "span",
    hr: "hr"
  }, _provideComponents(), props.components), {Marker, PermanentLink, Screenshot, CodeBlock, CodeBlockLineGroup, CodeBlockLine, CodeBlockReplacement, CodeBlockHoverCard, QuickNav, DefinitionList} = _components;
  if (!CodeBlock) _missingMdxReference("CodeBlock", true);
  if (!CodeBlockHoverCard) _missingMdxReference("CodeBlockHoverCard", true);
  if (!CodeBlockLine) _missingMdxReference("CodeBlockLine", true);
  if (!CodeBlockLineGroup) _missingMdxReference("CodeBlockLineGroup", true);
  if (!CodeBlockReplacement) _missingMdxReference("CodeBlockReplacement", true);
  if (!DefinitionList) _missingMdxReference("DefinitionList", false);
  if (!DefinitionList.Details) _missingMdxReference("DefinitionList.Details", true);
  if (!DefinitionList.Item) _missingMdxReference("DefinitionList.Item", true);
  if (!DefinitionList.Root) _missingMdxReference("DefinitionList.Root", true);
  if (!DefinitionList.Term) _missingMdxReference("DefinitionList.Term", true);
  if (!Marker) _missingMdxReference("Marker", true);
  if (!PermanentLink) _missingMdxReference("PermanentLink", true);
  if (!QuickNav) _missingMdxReference("QuickNav", false);
  if (!QuickNav.Heading) _missingMdxReference("QuickNav.Heading", true);
  if (!QuickNav.Item) _missingMdxReference("QuickNav.Item", true);
  if (!QuickNav.Link) _missingMdxReference("QuickNav.Link", true);
  if (!QuickNav.List) _missingMdxReference("QuickNav.List", true);
  if (!QuickNav.Root) _missingMdxReference("QuickNav.Root", true);
  if (!QuickNav.Sub) _missingMdxReference("QuickNav.Sub", true);
  if (!Screenshot) _missingMdxReference("Screenshot", true);
  return _jsxs(_Fragment, {
    children: [_jsx(_components.h1, {
      children: "Introduction"
    }), _jsxs(QuickNav.Root, {
      children: [_jsx(QuickNav.Heading, {}), _jsxs(QuickNav.List, {
        children: [_jsxs(QuickNav.Item, {
          children: [_jsx(QuickNav.Link, {
            href: "/domain-verification/before-getting-started",
            children: "Before getting started"
          }), _jsx(QuickNav.Sub, {
            children: _jsx(QuickNav.List, {
              children: _jsx(QuickNav.Item, {
                children: _jsx(QuickNav.Link, {
                  href: "/domain-verification/before-getting-started/api-object-definitions",
                  children: "API object definitions"
                })
              })
            })
          })]
        }), _jsx(QuickNav.Item, {
          children: _jsxs(QuickNav.Link, {
            href: "/domain-verification/a-setup-link-from-the-workos-dashboard",
            children: [_jsx(Marker, {
              children: "A"
            }), "Setup link from the WorkOS dashboard"]
          })
        }), _jsx(QuickNav.Item, {
          children: _jsxs(QuickNav.Link, {
            href: "/domain-verification/b-integrate-with-your-app",
            children: [_jsx(Marker, {
              children: "B"
            }), "Integrate with your app"]
          })
        }), _jsx(QuickNav.Item, {
          children: _jsx(QuickNav.Link, {
            href: "/domain-verification/admin-portal-domain-verification",
            children: "Admin Portal domain verification"
          })
        })]
      })]
    }), "\n", _jsx(_components.p, {
      children: "Domain Verification allows your customers to claim ownership of a domain. Once they have claimed ownership, features that require a higher level of trust and security can be activated."
    }), "\n", _jsx(_components.p, {
      children: "WorkOS Domain Verification provides a self-serve flow through the Admin Portal in which IT Admins can prove ownership through the creation of DNS TXT records."
    }), "\n", _jsxs(_components.div, {
      tabIndex: "-1",
      "data-section-slug": "/domain-verification/before-getting-started",
      children: [_jsx(PermanentLink, {
        label: "Section titled Before getting started",
        hidden: true,
        href: "/domain-verification/before-getting-started",
        children: _jsx(_components.h2, {
          id: "/domain-verification/before-getting-started",
          children: "Before getting started"
        })
      }), "\n", _jsxs(_components.p, {
        children: ["You’ll need a ", _jsx(_components.a, {
          href: "https://dashboard.workos.com/",
          children: "WorkOS account"
        }), "."]
      }), "\n"]
    }), _jsxs(_components.div, {
      tabIndex: "-1",
      "data-section-slug": "/domain-verification/before-getting-started/api-object-definitions",
      children: [_jsx(PermanentLink, {
        label: "Section titled API object definitions",
        hidden: true,
        href: "/domain-verification/before-getting-started/api-object-definitions",
        children: _jsx(_components.h3, {
          id: "/domain-verification/before-getting-started/api-object-definitions",
          children: "API object definitions"
        })
      }), "\n", _jsxs(DefinitionList.Root, {
        children: [_jsxs(DefinitionList.Item, {
          children: [_jsx(DefinitionList.Term, {
            children: _jsx(_components.a, {
              href: "/reference/organization",
              children: "Organization"
            })
          }), _jsx(DefinitionList.Details, {
            children: "Describes an organization whose users sign in with a SSO Connection, or whose users are synced with a Directory Sync Connection."
          })]
        }), _jsxs(DefinitionList.Item, {
          children: [_jsx(DefinitionList.Term, {
            children: _jsx(_components.a, {
              href: "/reference/organization-domain",
              children: "Organization Domain"
            })
          }), _jsx(DefinitionList.Details, {
            children: "Describes a domain associated to an organization, verified or unverified."
          })]
        }), _jsxs(DefinitionList.Item, {
          children: [_jsx(DefinitionList.Term, {
            children: _jsx(_components.a, {
              href: "/reference/admin-portal/portal-link",
              children: "Portal Link"
            })
          }), _jsx(DefinitionList.Details, {
            children: "A temporary link to initiate an Admin Portal session. Valid for 5 minutes."
          })]
        })]
      }), "\n", _jsxs(_components.p, {
        children: ["All domains belong to an ", _jsx(_components.a, {
          href: "/reference/organization",
          children: "Organization"
        }), ". In order to create and verify a domain through the Admin Portal, an Organization must first be ", _jsx(_components.a, {
          href: "/reference/organization/create",
          children: "created"
        }), "."]
      }), "\n"]
    }), _jsxs(_components.div, {
      tabIndex: "-1",
      "data-section-slug": "/domain-verification/a-setup-link-from-the-workos-dashboard",
      children: [_jsx(PermanentLink, {
        label: "Section titled A. Setup link from the WorkOS dashboard",
        hidden: true,
        href: "/domain-verification/a-setup-link-from-the-workos-dashboard",
        children: _jsxs(_components.h2, {
          id: "/domain-verification/a-setup-link-from-the-workos-dashboard",
          children: [_jsx(Marker, {
            "data-algolia-exclude": true,
            children: "A"
          }), "Setup link from the WorkOS dashboard"]
        })
      }), "\n", _jsxs(_components.ul, {
        children: ["\n", _jsxs(_components.li, {
          children: ["Sign in to your ", _jsx(_components.a, {
            href: "https://dashboard.workos.com/",
            children: "WorksOS dashboard"
          }), " account and create or locale an Organization."]
        }), "\n", _jsxs(_components.li, {
          children: ["Click the “Invite Admin” button, select ", _jsx(_components.strong, {
            children: "Domain Verification"
          }), " then click “Next.\" Enter the email of the IT admin for the organization to automatically send them a setup link, or click \"Copy setup link\"."]
        }), "\n"]
      }), "\n", _jsx(_components.p, {
        children: "If you chose to copy the setup link you can share it over email, Slack or direct message. We also recommend including details on what the link does and how long the link is active."
      }), "\n", _jsx(Screenshot, {
        alt: "A screenshot showing the workOS dashboard admin invite.",
        src: "https://workos.imgix.net/images/c9196bbf-3860-4a9a-be8c-83b503ae4e3d.png?auto=format&fit=clip&q=80"
      }), "\n"]
    }), _jsxs(_components.div, {
      tabIndex: "-1",
      "data-section-slug": "/domain-verification/b-integrate-with-your-app",
      children: [_jsx(PermanentLink, {
        label: "Section titled B. Integrate with your app",
        hidden: true,
        href: "/domain-verification/b-integrate-with-your-app",
        children: _jsxs(_components.h2, {
          id: "/domain-verification/b-integrate-with-your-app",
          children: [_jsx(Marker, {
            "data-algolia-exclude": true,
            children: "B"
          }), "Integrate with your app"]
        })
      }), "\n", _jsx(_components.p, {
        children: "Admin Portal links can also be programmatically generated for the domain verification flow. This can be used to provide a link to the Admin Portal flow directly in your application."
      }), "\n", _jsxs(_components.p, {
        children: ["You'll have to generate the link with the ", _jsx(_components.code, {
          children: "domain_verification"
        }), " intent:"]
      }), "\n", _jsx(CodeBlock, {
        title: "Create Admin Portal Link for Domain Verification",
        file: "create-admin-portal-link",
        children: _jsx(_components.pre, {
          language: "js",
          syntax: "js",
          file: "/home/semaphore/workos/packages/docs/content/domain-verification/_code/create-admin-portal-link.js",
          children: _jsx(_components.code, {
            className: "language-js",
            children: _jsxs(CodeBlockLineGroup, {
              gutter: "numbers",
              children: [_jsxs(CodeBlockLine, {
                children: [_jsx(_components.span, {
                  className: "token keyword module",
                  children: "import"
                }), " ", _jsx(_components.span, {
                  className: "token punctuation",
                  children: "{"
                }), _jsx(_components.span, {
                  className: "token imports",
                  children: " "
                }), _jsx(_components.span, {
                  className: "token maybe-class-name",
                  children: "WorkOS"
                }), _jsx(_components.span, {
                  className: "token imports",
                  children: " "
                }), _jsx(_components.span, {
                  className: "token punctuation",
                  children: "}"
                }), " ", _jsx(_components.span, {
                  className: "token keyword module",
                  children: "from"
                }), " ", _jsx(_components.span, {
                  className: "token string",
                  children: "'@workos-inc/node'"
                }), _jsx(_components.span, {
                  className: "token punctuation",
                  children: ";"
                }), "\n"]
              }), _jsx(CodeBlockLine, {
                color: true,
                children: "\n"
              }), _jsxs(CodeBlockLine, {
                color: true,
                children: [_jsx(_components.span, {
                  className: "token keyword",
                  children: "const"
                }), " ", _jsx(_components.span, {
                  className: "token",
                  children: "workos"
                }), " ", _jsx(_components.span, {
                  className: "token operator",
                  children: "="
                }), " ", _jsx(_components.span, {
                  className: "token keyword",
                  children: "new"
                }), " ", _jsx(_components.span, {
                  className: "token class-name",
                  children: "WorkOS"
                }), _jsx(_components.span, {
                  className: "token punctuation",
                  children: "("
                }), _jsxs(_components.span, {
                  className: "token string",
                  children: ["'", _jsx(CodeBlockReplacement, {
                    pattern: "sk_example_123456789"
                  }), "'"]
                }), _jsx(_components.span, {
                  className: "token punctuation",
                  children: ")"
                }), _jsx(_components.span, {
                  className: "token punctuation",
                  children: ";"
                }), "\n"]
              }), _jsx(CodeBlockLine, {
                color: true,
                children: "\n"
              }), _jsxs(CodeBlockLine, {
                color: true,
                children: [_jsx(_components.span, {
                  className: "token keyword",
                  children: "const"
                }), " ", _jsx(_components.span, {
                  className: "token punctuation",
                  children: "{"
                }), " ", _jsx(_components.span, {
                  className: "token",
                  children: "link"
                }), " ", _jsx(_components.span, {
                  className: "token punctuation",
                  children: "}"
                }), " ", _jsx(_components.span, {
                  className: "token operator",
                  children: "="
                }), " ", _jsx(_components.span, {
                  className: "token keyword control-flow",
                  children: "await"
                }), " ", _jsx(_components.span, {
                  className: "token",
                  children: "workos"
                }), _jsx(_components.span, {
                  className: "token punctuation",
                  children: "."
                }), _jsx(_components.span, {
                  className: "token property-access",
                  children: "portal"
                }), _jsx(_components.span, {
                  className: "token punctuation",
                  children: "."
                }), _jsx(CodeBlockHoverCard, {
                  referenceId: "generate_portal_link",
                  language: "js",
                  children: "generateLink"
                }), _jsx(_components.span, {
                  className: "token punctuation",
                  children: "("
                }), _jsx(_components.span, {
                  className: "token punctuation",
                  children: "{"
                }), "\n"]
              }), _jsxs(CodeBlockLine, {
                color: true,
                children: ["  ", _jsx(_components.span, {
                  className: "token literal-property property",
                  children: "organization"
                }), _jsx(_components.span, {
                  className: "token operator",
                  children: ":"
                }), " ", _jsx(_components.span, {
                  className: "token string",
                  children: "'org_01EHZNVPK3SFK441A1RGBFSHRT'"
                }), _jsx(_components.span, {
                  className: "token punctuation",
                  children: ","
                }), "\n"]
              }), _jsxs(CodeBlockLine, {
                color: true,
                children: ["  ", _jsx(_components.span, {
                  className: "token literal-property property",
                  children: "intent"
                }), _jsx(_components.span, {
                  className: "token operator",
                  children: ":"
                }), " ", _jsx(_components.span, {
                  className: "token string",
                  children: "'domain_verification'"
                }), _jsx(_components.span, {
                  className: "token punctuation",
                  children: ","
                }), "\n"]
              }), _jsxs(CodeBlockLine, {
                color: true,
                children: [_jsx(_components.span, {
                  className: "token punctuation",
                  children: "}"
                }), _jsx(_components.span, {
                  className: "token punctuation",
                  children: ")"
                }), _jsx(_components.span, {
                  className: "token punctuation",
                  children: ";"
                }), "\n"]
              }), _jsx(CodeBlockLine, {
                color: true,
                children: "\n"
              }), _jsxs(CodeBlockLine, {
                color: true,
                children: [_jsx(_components.span, {
                  className: "token comment",
                  children: "// Redirect to link"
                }), "\n"]
              })]
            })
          })
        })
      }), "\n", _jsxs(_components.p, {
        children: ["Please refer to the ", _jsx(_components.a, {
          href: "/admin-portal/b-integrate-with-your-app",
          children: "Admin Portal Integration Guide"
        }), " for additional integration details."]
      }), "\n", _jsx(_components.hr, {}), "\n"]
    }), _jsxs(_components.div, {
      tabIndex: "-1",
      "data-section-slug": "/domain-verification/admin-portal-domain-verification",
      children: [_jsx(PermanentLink, {
        label: "Section titled Admin Portal domain verification",
        hidden: true,
        href: "/domain-verification/admin-portal-domain-verification",
        children: _jsx(_components.h2, {
          id: "/domain-verification/admin-portal-domain-verification",
          children: "Admin Portal domain verification"
        })
      }), "\n", _jsx(_components.p, {
        children: "After receiving the invitation and clicking on the setup link, the organization's admin is prompted to enter the domain they wish to verify."
      }), "\n", _jsx(Screenshot, {
        alt: "A screenshot show the Admin portal domain entry form.",
        src: "https://workos.imgix.net/images/e7e719d6-579b-4567-8c80-772bc2f77563.png?auto=format&fit=clip&q=80"
      }), "\n", _jsx(_components.p, {
        children: "If the domain is valid, we identify the DNS service provider and offer custom setup instructions."
      }), "\n", _jsx(_components.p, {
        children: "The admin will find instruction to add a DNS TXT record with a token generated by our system."
      }), "\n", _jsx(Screenshot, {
        alt: "A screenshot showing the Admin Portal domain dns instructions.",
        src: "https://workos.imgix.net/images/9ab7e2a4-8b11-4a03-8203-d95d1c1abb07.png?auto=format&fit=clip&q=80"
      }), "\n", _jsxs(_components.p, {
        children: ["When we detect and verify the DNS record, we will mark the domain as ", _jsx(_components.code, {
          children: "verified"
        }), " and dispatch a ", _jsx(_components.a, {
          href: "/events",
          children: "domain verification event"
        }), " to inform your application."]
      })]
    })]
  });
}
function MDXContent(props = {}) {
  const {wrapper: MDXLayout} = Object.assign({}, _provideComponents(), props.components);
  return MDXLayout ? _jsx(MDXLayout, Object.assign({}, props, {
    children: _jsx(_createMdxContent, props)
  })) : _createMdxContent(props);
}
return {
  default: MDXContent
};
function _missingMdxReference(id, component) {
  throw new Error("Expected " + (component ? "component" : "object") + " `" + id + "` to be defined: you likely forgot to import, pass, or provide it.");
}


Quick Start

Domain Verification

/portal/generate_link

portalService.GenerateLink()