NinjaOne

Generated Cmdlet Help

This page has been generated from the NinjaOne PowerShell module source. To make changes please edit the appropriate PowerShell source file.

SYNOPSIS

Creates a new connection to a NinjaOne instance.

SYNTAX

Authorisation Code (Default)

Connect-NinjaOne [-useWebAuth] -instance <String> -clientId <String> -clientSecret <String>
 [-scopes <String[]>] [-redirectURL <Uri>] [-port <Int32>] [-showTokens] [-useSecretManagement]
 [-vaultName <String>] [-writeToSecretVault] [-parseDateTimes] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Secret Vault Write

Connect-NinjaOne [-useWebAuth] [-useTokenAuth] [-useClientAuth] -instance <String> -clientId <String>
 -clientSecret <String> [-scopes <String[]>] [-redirectURL <Uri>] [-port <Int32>] [-refreshToken <String>]
 [-useSecretManagement] -vaultName <String> [-writeToSecretVault] [-secretPrefix <String>] [-parseDateTimes]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Token Authentication

Connect-NinjaOne [-useTokenAuth] -instance <String> -clientId <String> -clientSecret <String>
 [-scopes <String[]>] [-refreshToken <String>] [-showTokens] [-useSecretManagement] [-vaultName <String>]
 [-writeToSecretVault] [-parseDateTimes] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Client Credentials

Connect-NinjaOne [-useClientAuth] -instance <String> -clientId <String> -clientSecret <String>
 [-scopes <String[]>] [-showTokens] [-useSecretManagement] [-vaultName <String>] [-writeToSecretVault]
 [-parseDateTimes] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Secret Vault Read

Connect-NinjaOne [-useSecretManagement] -vaultName <String> [-writeToSecretVault] [-readFromSecretVault]
 [-secretPrefix <String>] [-parseDateTimes] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Creates a new connection to a NinjaOne instance and stores this in a PowerShell Session.

EXAMPLES

EXAMPLE 1

Connect-NinjaOne -instance 'eu' -clientId 'AAaaA1aaAaAA-aaAaaA11a1A-aA' -clientSecret '00Z00zzZzzzZzZzZzZzZZZ0zZ0zzZ_0zzz0zZZzzZz0Z0ZZZzz0z0Z' -useClientAuth

This logs into NinjaOne using the client credentials flow.

EXAMPLE 2

Connect-NinjaOne -instance 'eu' -clientId 'AAaaA1aaAaAA-aaAaaA11a1A-aA' -clientSecret '00Z00zzZzzzZzZzZzZzZZZ0zZ0zzZ_0zzz0zZZzzZz0Z0ZZZzz0z0Z' -Port 9090 -useWebAuth

This logs into NinjaOne using the authorization code flow.

EXAMPLE 3

Connect-NinjaOne -instance 'eu' -clientId 'AAaaA1aaAaAA-aaAaaA11a1A-aA' -clientSecret '00Z00zzZzzzZzZzZzZzZZZ0zZ0zzZ_0zzz0zZZzzZz0Z0ZZZzz0z0Z' -refreshToken 'a1a11a11-aa11-11a1-a111-a1a111aaa111.11AaaAaaa11aA-AA1aaaAAA111aAaaaaA1AAAA1_AAa' -useTokenAuth

This logs into NinjaOne using the refresh token flow.

EXAMPLE 4

Connect-NinjaOne -useSecretManagement -vaultName 'NinjaOneVault' -writeToSecretVault -instance 'eu' -clientId 'AAaaA1aaAaAA-aaAaaA11a1A-aA' -clientSecret '00Z00zzZzzzZzZzZzZzZZZ0zZ0zzZ_0zzz0zZZzzZz0Z0ZZZzz0z0Z' -useClientAuth

This logs into NinjaOne using the client credentials flow and writes the connection information to the secret vault.

EXAMPLE 5

Connect-NinjaOne -useSecretManagement -vaultName 'NinjaOneVault' -readFromSecretVault

This reads the connection information from the secret vault.

PARAMETERS

-useWebAuth

Use the "Authorisation Code" flow with your web browser.

Type: SwitchParameter
Parameter Sets: Authorisation Code
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Type: SwitchParameter
Parameter Sets: Secret Vault Write
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-useTokenAuth

Use the "Token Authentication" flow - useful if you already have a refresh token.

Type: SwitchParameter
Parameter Sets: Secret Vault Write
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Type: SwitchParameter
Parameter Sets: Token Authentication
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-useClientAuth

Use the "Client Credentials" flow - useful if you already have a client ID and secret.

Type: SwitchParameter
Parameter Sets: Secret Vault Write
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Type: SwitchParameter
Parameter Sets: Client Credentials
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-instance

The NinjaOne instance to connect to. Choose from 'eu', 'oc' or 'us'.

Type: String
Parameter Sets: Authorisation Code, Secret Vault Write, Token Authentication, Client Credentials
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-clientId

The Client Id for the application configured in NinjaOne.

Type: String
Parameter Sets: Authorisation Code, Secret Vault Write, Token Authentication, Client Credentials
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-clientSecret

The Client Secret for the application configured in NinjaOne.

Type: String
Parameter Sets: Authorisation Code, Secret Vault Write, Token Authentication, Client Credentials
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-scopes

The API scopes to request, if this isn't passed the scope is assumed to be "all". Pass a string or array of strings. Limited by the scopes granted to the application in NinjaOne.

Type: String[]
Parameter Sets: Authorisation Code, Secret Vault Write, Token Authentication, Client Credentials
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-redirectURL

The redirect URI to use. If not set defaults to 'http://localhost'. Should be a full URI e.g. https://redirect.example.uk:9090/auth

Type: Uri
Parameter Sets: Authorisation Code, Secret Vault Write
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-port

The port to use for the redirect URI. Must match with the configuration set in NinjaOne. If not set defaults to '9090'.

Type: Int32
Parameter Sets: Authorisation Code, Secret Vault Write
Aliases:

Required: False
Position: Named
Default value: 9090
Accept pipeline input: False
Accept wildcard characters: False

-refreshToken

The refresh token to use for "Token Authentication" flow.

Type: String
Parameter Sets: Secret Vault Write, Token Authentication
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-showTokens

Output the tokens - useful when using "Authorisation Code" flow - to use with "Token Authentication" flow.

Type: SwitchParameter
Parameter Sets: Authorisation Code, Token Authentication, Client Credentials
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-useSecretManagement

Use the secret management module to retrieve credentials and store tokens. Check the docs on setting up the secret management module at https://docs.homotechsual.dev/common/secretmanagement.

Type: SwitchParameter
Parameter Sets: Authorisation Code, Token Authentication, Client Credentials
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Type: SwitchParameter
Parameter Sets: Secret Vault Write, Secret Vault Read
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-vaultName

The name of the secret vault to use.

Type: String
Parameter Sets: Authorisation Code, Token Authentication, Client Credentials
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Type: String
Parameter Sets: Secret Vault Write, Secret Vault Read
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-writeToSecretVault

Write updated credentials to secret management vault.

Type: SwitchParameter
Parameter Sets: Authorisation Code, Token Authentication, Client Credentials, Secret Vault Read
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Type: SwitchParameter
Parameter Sets: Secret Vault Write
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-readFromSecretVault

Read the authentication information from secret management vault.

Type: SwitchParameter
Parameter Sets: Secret Vault Read
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-secretPrefix

The prefix to add to the name of the secrets stored in the secret vault.

Type: String
Parameter Sets: Secret Vault Write, Secret Vault Read
Aliases:

Required: False
Position: Named
Default value: NinjaOne
Accept pipeline input: False
Accept wildcard characters: False

-parseDateTimes

Automatically parse date/time values in API responses.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

Sets two script-scoped variables to hold connection and authentication information.

NOTES

RELATED LINKS

https://docs.homotechsual.dev/modules/ninjaone/commandlets/Connect/ninjaone