CIPP icon

CIPP

Interact with CIPP API
Join our community

Actions129

Overview

This node operation allows adding a new user to the system via the CIPP API. It is useful for automating user creation in organizational environments, such as onboarding new employees or managing user accounts in bulk. Practical examples include setting up user profiles with personal and contact details, assigning licenses, and configuring password policies automatically.

Use Case Examples

  1. Create a new user with specified first name, last name, and username, automatically generating a password and requiring password change at next login.
  2. Add a user with detailed contact information, job title, and assign specific licenses.
  3. Add a user and send the creation result to a webhook or email for notification purposes.

Properties

Name Meaning
Usage Location The usage location for the user, selected from a predefined list of countries.
First Name The first name of the user.
Last Name The last name of the user.
Display Name The display name of the user.
Username The username for the user without domain.
Primary Domain Primary domain for the user, e.g., n8layer.com.
Auto Generate Password Whether to automatically generate a password for the user.
Must Change Password Whether the user must change their password at next login.
Remove Licenses Whether to remove licenses from the user.
License SKU ID Comma-separated list of license SKU IDs to assign to the user.
Job Title The job title of the user.
Street Address The street address of the user.
City The city of the user.
State/Province The state or province of the user.
Postal Code The postal code of the user.
Country The country of the user.
Company Name The company name of the user.
Department The department of the user.
Mobile Phone The mobile phone number of the user.
Business Phones Business phone numbers, comma-separated.
Other Email Addresses Additional email addresses for the user, comma-separated.
Default Attributes Default attributes for the user in JSON format.
Set Manager Manager email address.
Password Manual password, used only if Auto Generate Password is false.
Send to Webhook Whether to send results to a webhook.
Send to Email Whether to send results to email.
Send to PSA Whether to send results to PSA.
Tenant Filter The tenant ID or domain name of the user.
Request Options Additional request options such as batching, SSL handling, proxy, and timeout settings.

Output

JSON

  • id - The unique identifier of the created user.
  • givenName - The first name of the created user.
  • surname - The last name of the created user.
  • displayName - The display name of the created user.
  • userPrincipalName - The full username including domain.
  • usageLocation - The usage location of the user.
  • jobTitle - The job title of the user.
  • streetAddress - The street address of the user.
  • city - The city of the user.
  • state - The state or province of the user.
  • postalCode - The postal code of the user.
  • country - The country of the user.
  • companyName - The company name of the user.
  • department - The department of the user.
  • mobilePhone - The mobile phone number of the user.
  • businessPhones - Business phone numbers of the user.
  • otherMails - Additional email addresses of the user.
  • accountEnabled - Indicates if the user account is enabled.

Dependencies

  • An API key credential for authenticating with the CIPP API

Troubleshooting

  • Ensure all required fields such as Usage Location, First Name, Last Name, Display Name, Username, Primary Domain, and Tenant Filter are provided to avoid validation errors.
  • If Auto Generate Password is false, provide a valid manual password to prevent errors.
  • Check network connectivity and API credentials if requests fail or time out.
  • If licenses are not assigned correctly, verify the License SKU IDs format and values.
  • For SSL issues, consider enabling the option to ignore SSL certificate validation if appropriate.

Discussion