WorkOS · Schema

CreateUserlandUserInviteOptionsDto

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name	Type	Description
email	string	The email address of the recipient.
organization_id	string	The ID of the [organization](/reference/organization) that the recipient will join.
role_slug	string	The [role](/authkit/roles) that the recipient will receive when they join the organization in the invitation.
expires_in_days	integer	How many days the invitations will be valid for. Must be between 1 and 30 days. Defaults to 7 days if not specified.
inviter_user_id	string	The ID of the [user](/reference/authkit/user) who invites the recipient. The invitation email will mention the name of this user.
locale	string	The locale to use when rendering the invitation email. See [supported locales](/authkit/hosted-ui/localization).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateUserlandUserInviteOptionsDto",
  "title": "CreateUserlandUserInviteOptionsDto",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "description": "The email address of the recipient.",
      "example": "[email protected]"
    },
    "organization_id": {
      "type": "string",
      "description": "The ID of the [organization](/reference/organization) that the recipient will join.",
      "example": "org_01E4ZCR3C56J083X43JQXF3JK5"
    },
    "role_slug": {
      "type": "string",
      "description": "The [role](/authkit/roles) that the recipient will receive when they join the organization in the invitation.",
      "example": "admin"
    },
    "expires_in_days": {
      "type": "integer",
      "description": "How many days the invitations will be valid for. Must be between 1 and 30 days. Defaults to 7 days if not specified.",
      "example": 7
    },
    "inviter_user_id": {
      "type": "string",
      "description": "The ID of the [user](/reference/authkit/user) who invites the recipient. The invitation email will mention the name of this user.",
      "example": "user_01HYGBX8ZGD19949T3BM4FW1C3"
    },
    "locale": {
      "type": "string",
      "enum": [
        "af",
        "am",
        "ar",
        "bg",
        "bn",
        "bs",
        "ca",
        "cs",
        "da",
        "de",
        "de-DE",
        "el",
        "en",
        "en-AU",
        "en-CA",
        "en-GB",
        "en-US",
        "es",
        "es-419",
        "es-ES",
        "es-US",
        "et",
        "fa",
        "fi",
        "fil",
        "fr",
        "fr-BE",
        "fr-CA",
        "fr-FR",
        "fy",
        "gl",
        "gu",
        "ha",
        "he",
        "hi",
        "hr",
        "hu",
        "hy",
        "id",
        "is",
        "it",
        "it-IT",
        "ja",
        "jv",
        "ka",
        "kk",
        "km",
        "kn",
        "ko",
        "lt",
        "lv",
        "mk",
        "ml",
        "mn",
        "mr",
        "ms",
        "my",
        "nb",
        "ne",
        "nl",
        "nl-BE",
        "nl-NL",
        "nn",
        "no",
        "pa",
        "pl",
        "pt",
        "pt-BR",
        "pt-PT",
        "ro",
        "ru",
        "sk",
        "sl",
        "sq",
        "sr",
        "sv",
        "sw",
        "ta",
        "te",
        "th",
        "tr",
        "uk",
        "ur",
        "uz",
        "vi",
        "zh",
        "zh-CN",
        "zh-HK",
        "zh-TW",
        "zu"
      ],
      "description": "The locale to use when rendering the invitation email. See [supported locales](/authkit/hosted-ui/localization).",
      "example": "en"
    }
  },
  "required": [
    "email"
  ]
}