New-NectarTokenRegistration
    • 20 Aug 2024
    • 1 Minute to read
    • Dark
      Light
    • PDF

    New-NectarTokenRegistration

    • Dark
      Light
    • PDF

    Article summary

    Registers a Nectar DXP token for connecting to Nectar DXP using JWT

    Description

    Registers a Nectar DXP token for connecting to Nectar DXP using JWT. One-time task required before attempting to access Nectar DXP APIs.
    Stored using Microsoft SecretManagement PS module.
    If SecretManagement PS module is is not installed, install via:
    Install-Module Microsoft.PowerShell.SecretManagement

    There are several PS modules that connect to different secret providers. Install the one appropriate for your situation prior to running this command.
    For example, the PS SecretStore stores secrets on the local machine and can be installed via:
    Install-Module Microsoft.PowerShell.SecretStore

    Syntax

    New-NectarTokenRegistration
      -CloudFQDN  <String>
      -Identifier  <String>
      -AccessToken  <String>
      -RefreshToken  <String>
      -SecretVault  <String>
    

    Examples

    Example 1

    Connect-NectarCloud -Credential $cred -CloudFQDN contoso.nectar.services
    

    Connects to the contoso.nectar.services Nectar DXP cloud using the credentials supplied to the Get-Credential command

    Parameters

    -CloudFQDN <String>
    The FQDN of the Nectar DXP cloud.

    ParameterValue
    Requiredtrue
    Position1
    Requiredtrue
    Default ValueNone
    Accept pipeline input?true (ByValue)
    Accept wildcard characters?false

    -Identifier <String>
    An optional unique identifier (such as script name or username) to use when saving secrets to a secret store shared by multiple parties/scripts

    ParameterValue
    Requiredfalse
    Position2
    Requiredfalse
    Default ValueNone
    Accept pipeline input?true (ByPropertyName)
    Accept wildcard characters?false

    -AccessToken <String>
    The access token to use for connecting to Nectar DXP

    ParameterValue
    Requiredtrue
    Position3
    Requiredtrue
    Default ValueNone
    Accept pipeline input?true (ByPropertyName)
    Accept wildcard characters?false

    -RefreshToken <String>
    The refresh token used to refresh the Nectar DXP access token every 2 hours

    ParameterValue
    Requiredtrue
    Position4
    Requiredtrue
    Default ValueNone
    Accept pipeline input?true (ByPropertyName)
    Accept wildcard characters?false

    -SecretVault <String>
    The name of the secret vault to install the secret. Use if installing to non-default secret vault

    ParameterValue
    Requiredfalse
    Position5
    Requiredfalse
    Default ValueNone
    Accept pipeline input?true (ByPropertyName)
    Accept wildcard characters?false

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    ESC

    Eddy AI, facilitating knowledge discovery through conversational intelligence