invite-user

Instructions

Create and invite a new user to the Descope project

Input Schema

Name	Required	Description
`additionalLoginIds`	No	Additional login identifiers
`customAttributes`	No	Custom attributes for the user
`displayName`	No	User's display name
`email`	No	User's email address
`familyName`	No	User's family/last name
`givenName`	No	User's given/first name
`inviteUrl`	No	Custom URL for the invitation link
`loginId`	Yes	Primary login identifier for the user
`middleName`	No	User's middle name
`phone`	No	User's phone number in E.164 format
`picture`	No	URL to user's profile picture
`roles`	No	Global role names to assign to the user
`sendMail`	No	Send invite via email (default follows project settings)
`sendSMS`	No	Send invite via SMS (default follows project settings)
`ssoAppIds`	No	SSO application IDs to associate
`templateId`	No	Custom template ID for the invitation
`templateOptions`	No	Options for customizing the invitation template
`userTenants`	No	Tenant associations with specific roles
`verifiedEmail`	No	Whether the email is pre-verified
`verifiedPhone`	No	Whether the phone is pre-verified

Input Schema (JSON Schema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "additionalLoginIds": {
      "description": "Additional login identifiers",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "customAttributes": {
      "additionalProperties": {},
      "description": "Custom attributes for the user",
      "type": "object"
    },
    "displayName": {
      "description": "User's display name",
      "type": "string"
    },
    "email": {
      "description": "User's email address",
      "format": "email",
      "type": "string"
    },
    "familyName": {
      "description": "User's family/last name",
      "type": "string"
    },
    "givenName": {
      "description": "User's given/first name",
      "type": "string"
    },
    "inviteUrl": {
      "description": "Custom URL for the invitation link",
      "format": "uri",
      "type": "string"
    },
    "loginId": {
      "description": "Primary login identifier for the user",
      "type": "string"
    },
    "middleName": {
      "description": "User's middle name",
      "type": "string"
    },
    "phone": {
      "description": "User's phone number in E.164 format",
      "type": "string"
    },
    "picture": {
      "description": "URL to user's profile picture",
      "format": "uri",
      "type": "string"
    },
    "roles": {
      "description": "Global role names to assign to the user",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "sendMail": {
      "description": "Send invite via email (default follows project settings)",
      "type": "boolean"
    },
    "sendSMS": {
      "description": "Send invite via SMS (default follows project settings)",
      "type": "boolean"
    },
    "ssoAppIds": {
      "description": "SSO application IDs to associate",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "templateId": {
      "description": "Custom template ID for the invitation",
      "type": "string"
    },
    "templateOptions": {
      "additionalProperties": false,
      "description": "Options for customizing the invitation template",
      "properties": {
        "appUrl": {
          "description": "Application URL to use in the template",
          "format": "uri",
          "type": "string"
        },
        "customClaims": {
          "description": "Custom claims to include in the template (as JSON string)",
          "type": "string"
        },
        "redirectUrl": {
          "description": "URL to redirect after authentication",
          "format": "uri",
          "type": "string"
        }
      },
      "type": "object"
    },
    "userTenants": {
      "description": "Tenant associations with specific roles",
      "items": {
        "additionalProperties": false,
        "properties": {
          "roleNames": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "tenantId": {
            "type": "string"
          }
        },
        "required": [
          "tenantId",
          "roleNames"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "verifiedEmail": {
      "description": "Whether the email is pre-verified",
      "type": "boolean"
    },
    "verifiedPhone": {
      "description": "Whether the phone is pre-verified",
      "type": "boolean"
    }
  },
  "required": [
    "loginId"
  ],
  "type": "object"
}

descope-mcp-server

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from descope-mcp-server

Related Tools