SystemAdmins.Eloomi

1.0.4

public/eloomi/user/New-EloomiUser.ps1

function New-EloomiUser
{
    <#
    .SYNOPSIS
        Create a new Eloomi user.
    .DESCRIPTION
        Create a user in Eloomi using the API.
    .EXAMPLE
        New-EloomiUser -ApiKey '<secret>' -Email "john@contoso.com" -FirstName "John" -LastName "Doe";
    #>
    [cmdletbinding()]
    [OutputType([object])]
    param
    (
        # API Key for Eloomi.
        [Parameter(Mandatory = $false, Position = 0, ValueFromPipelineByPropertyName = $true)]
        [ValidateNotNullOrEmpty()]
        [string]$ApiKey = (Get-EloomiApiKey),

        # Email address.
        [Parameter(Mandatory = $true, Position = 1, ValueFromPipelineByPropertyName = $true)]
        [ValidateNotNullOrEmpty()]
        [ValidateScript({ Test-EmailAddress -InputObject $_ })]
        [ValidateLength(3, 250)]
        [string]$Email,

        # Account ID.
        [Parameter(Mandatory = $false, Position = 2, ValueFromPipelineByPropertyName = $true)]
        [ValidateNotNullOrEmpty()]
        [ValidateLength(3, 250)]
        [string]$AccountId = $Email,

        # First name.
        [Parameter(Mandatory = $true, Position = 3, ValueFromPipelineByPropertyName = $true)]
        [ValidateNotNullOrEmpty()]
        [ValidateLength(1, 250)]
        [string]$FirstName,

        # Last name.
        [Parameter(Mandatory = $true, Position = 4, ValueFromPipelineByPropertyName = $true)]
        [ValidateNotNullOrEmpty()]
        [ValidateLength(1, 250)]
        [string]$LastName,

        # Job title.
        [Parameter(Mandatory = $false, Position = 5, ValueFromPipelineByPropertyName = $true)]
        [ValidateNotNullOrEmpty()]
        [string]$JobTitle,

        # User role.
        [Parameter(Mandatory = $false, Position = 6, ValueFromPipelineByPropertyName = $true)]
        [ValidateNotNullOrEmpty()]
        [ValidateSet('User', 'Admin')]
        [string]$UserRole = 'User',

        # Active.
        [Parameter(Mandatory = $false, Position = 7, ValueFromPipelineByPropertyName = $true)]
        [ValidateNotNullOrEmpty()]
        [bool]$Active = $true,

        # Send email invite.
        [Parameter(Mandatory = $false, Position = 8, ValueFromPipelineByPropertyName = $true)]
        [ValidateNotNullOrEmpty()]
        [bool]$SendEmailInvite = $false,

        # Temporary password.
        [Parameter(Mandatory = $false, Position = 9, ValueFromPipelineByPropertyName = $true)]
        [ValidateNotNullOrEmpty()]
        [securestring]$TemporaryPassword,

        # Custom fields.
        [Parameter(Mandatory = $false, Position = 10, ValueFromPipelineByPropertyName = $true)]
        [ValidateNotNullOrEmpty()]
        [hashtable]$CustomFields,

        # Language.
        [Parameter(Mandatory = $false, Position = 11, ValueFromPipelineByPropertyName = $true)]
        [ValidateNotNullOrEmpty()]
        [ValidateSet('da-DK', 'de-DE', 'en-GB', 'en-US', 'es-ES', 'fi-FI', 'fr-FR', 'is-IS', 'nl-NL', 'no-NO', 'pt-PT', 'ru-RU', 'sv-SE', 'zh-CN')]
        [string]$Language,

        # Manager ID.
        [Parameter(Mandatory = $false, Position = 12, ValueFromPipelineByPropertyName = $true)]
        [ValidateNotNullOrEmpty()]
        [ValidateRange(1, 2147483647)]
        [int]$ManagerId
    )

    BEGIN
    {
        # Write to log.
        $customProgress = Write-CustomProgress -Activity $MyInvocation.MyCommand.Name -CurrentOperation 'Creating Eloomi user';

        # API URI.
        $uri = 'https://api.eloomi.io/public/v1/users';

        # Parameters.
        $paramSplatting = @{
            'ApiKey' = $ApiKey;
            'Uri'    = $uri;
            'Method' = 'POST';
        };

        # Create body.
        $body = @{
            'email'             = $Email;
            'first_name'        = $FirstName;
            'last_name'         = $LastName;
            'active'            = $Active;
            'user_role'         = $UserRole;
            'send_email_invite' = $SendEmailInvite;

        };

        # If account ID is set.
        if (-not [string]::IsNullOrEmpty($AccountId))
        {
            # Add property to body.
            $body.Add('account_id', $AccountId);
        }

        # If job title is set.
        if (-not [string]::IsNullOrEmpty($JobTitle))
        {
            # Add property to body.
            $body.Add('job_title', $JobTitle);
        }

        # If temporary password is set.
        if (-not [string]::IsNullOrEmpty($TemporaryPassword))
        {
            # Convert secure string to plain text.
            $TemporaryPassword = ConvertFrom-SecureString -SecureString $TemporaryPassword -AsPlainText;

            # Add property to body.
            $body.Add('temporary_password', $TemporaryPassword);
        }

        # If custom fields is set.
        if ($null -ne $CustomFields)
        {
            # Add property to body.
            $body.Add('custom_fields', $CustomFields);
        }

        # If language is set.
        if (-not [string]::IsNullOrEmpty($Language))
        {
            # Add property to body.
            $body.Add('language', $Language);
        }

        # If manager ID is set.
        if (0 -ne $ManagerId)
        {
            # Add property to body.
            $body.Add('manager_id', $ManagerId);
        }

        # Add body to parameters.
        $paramSplatting.Add('Body', $body);
    }
    PROCESS
    {
        # Write to log.
        Write-CustomLog -Message ('Trying to create Eloomi user with email {0}' -f $Email) -Level 'Verbose';

        # Invoke Eloomi API.
        $response = Invoke-EloomiApi @paramSplatting;

        # Write to log.
        Write-CustomLog -Message ('Successfully created Eloomi user with email {0}' -f $Email) -Level 'Verbose';
    }
    END
    {
        # Write to log.
        Write-CustomProgress @customProgress;

        # Return result.
        return $response;
    }
}