Skip to content

Latest commit

 

History

History
90 lines (68 loc) · 4.2 KB

File metadata and controls

90 lines (68 loc) · 4.2 KB

Add-CIPPUser

SYNOPSIS

Adds a user to the specified customer tenant.

DESCRIPTION

The Add-CIPPUser function adds a user to the specified customer tenant in the CIPP system. It sends a request to the "/api/adduser" endpoint with the provided user details.

PARAMETERS

-CustomerTenantID

Foo Foo
The ID of the customer tenant to which the user will be added.

-DisplayName

Foo Foo
The display name of the user.

-UserName

Foo Foo
The username of the user.

-AutoPassword

Foo Foo Foo
Specifies whether to automatically generate a password for the user. Default value is $true.

-FirstName

Foo Foo
The first name of the user.

-LastName

Foo Foo
The last name of the user.

-Domain

Foo Foo
The domain of the user.

-AddedAliases

Foo Foo
Additional aliases for the user.

-CopyFrom

Foo Foo
Specifies the user to copy settings from.

-UsageLocation

Foo Foo
The usage location of the user.

-Department

Foo Foo
The department of the user.

-City

Foo Foo
The city of the user.

-Country

Foo Foo
The country of the user.

-Jobtitle

Foo Foo
The job title of the user.

-MobilePhone

Foo Foo
The mobile phone number of the user.

-StreetAddress

Foo Foo
The street address of the user.

-PostalCode

Foo Foo
The postal code of the user.

-CompanyName

Foo Foo
The company name of the user.

-MustChangePass

Foo Foo Foo
Specifies whether the user must change their password on first login. Default value is $true.

EXAMPLE 1

PS > Add-CIPPUser -CustomerTenantID "7ced1621-b8f7-4231-868c-bc6b1a2f1778" -DisplayName "John Doe" -UserName "johndoe" -FirstName "John" -LastName "Doe" -Domain "example.com" -UsageLocation "US"

Adds a user with the specified details to the customer tenant with ID "7ced1621-b8f7-4231-868c-bc6b1a2f1778". The user's display name is "John Doe", username is "johndoe", first name is "John", last name is "Doe", domain is "example.com", and usage location is "US".