GenerateLinkDto

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GenerateLinkDto",
  "title": "GenerateLinkDto",
  "type": "object",
  "properties": {
    "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.",
      "example": "https://example.com/admin-portal/return"
    },
    "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.",
      "example": "https://example.com/admin-portal/success"
    },
    "organization": {
      "type": "string",
      "description": "An [Organization](/reference/organization) identifier.",
      "example": "org_01EHZNVPK3SFK441A1RGBFSHRT"
    },
    "intent": {
      "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",
      "example": "sso",
      "enum": [
        "sso",
        "dsync",
        "audit_logs",
        "log_streams",
        "domain_verification",
        "certificate_renewal",
        "bring_your_own_key"
      ]
    },
    "intent_options": {
      "description": "Options to configure the Admin Portal based on the intent.",
      "$ref": "#/components/schemas/IntentOptions"
    },
    "it_contact_emails": {
      "description": "The email addresses of the IT contacts to grant access to the Admin Portal for the given organization. Accepts up to 20 emails.",
      "example": [
        "[email protected]"
      ],
      "maxItems": 20,
      "items": {
        "type": "string",
        "format": "email"
      },
      "type": "array"
    }
  },
  "required": [
    "organization"
  ]
}