invite-user
Create and invite new users to your Descope project with customizable login options, role assignments, and invitation templates for secure user onboarding.
Instructions
Create and invite a new user to the Descope project
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| loginId | Yes | Primary login identifier for the user | |
| additionalLoginIds | No | Additional login identifiers | |
| No | User's email address | ||
| verifiedEmail | No | Whether the email is pre-verified | |
| phone | No | User's phone number in E.164 format | |
| verifiedPhone | No | Whether the phone is pre-verified | |
| displayName | No | User's display name | |
| givenName | No | User's given/first name | |
| middleName | No | User's middle name | |
| familyName | No | User's family/last name | |
| picture | No | URL to user's profile picture | |
| roles | No | Global role names to assign to the user | |
| userTenants | No | Tenant associations with specific roles | |
| ssoAppIds | No | SSO application IDs to associate | |
| customAttributes | No | Custom attributes for the user | |
| inviteUrl | No | Custom URL for the invitation link | |
| sendMail | No | Send invite via email (default follows project settings) | |
| sendSMS | No | Send invite via SMS (default follows project settings) | |
| templateId | No | Custom template ID for the invitation | |
| templateOptions | No | Options for customizing the invitation template |
Input Schema (JSON Schema)
{
"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"
}