Connect-R1Session
Connect-R1Session
SYNOPSIS
Authenticates to a RadiantOne deployment and establishes a session.
SYNTAX
Connect-R1Session [-BaseURI] <String> [-Credential] <PSCredential> [-SkipCertificateCheck] [<CommonParameters>]
DESCRIPTION
Authenticates against the RadiantOne v2 login endpoint and stores the returned authentication token, together with the claims it carries, in the module scope session. Every other command in the module uses that session, so this command must be run first.
If the bind fails specifically because the user’s password has expired, the API reports a successful request carrying password reset information rather than a token. In that case this command writes a warning and returns the reset information, whose resetToken can be passed to Reset-R1Password to set a new password. No session is established until the reset is completed and the user authenticates again.
All other authentication failures - bad credentials, a locked account, a denied IP - throw a terminating error.
EXAMPLES
Example 1
$cred = Get-Credential
Connect-R1Session -BaseURI 'https://tenant.example.radiantlogic.io/api' -Credential $cred
Authenticates as the supplied user and establishes the session used by all other commands. Note the /api suffix: this is the API endpoint address, not the Control Panel UI address.
Example 2
$reset = Connect-R1Session -BaseURI 'https://tenant.example.radiantlogic.io/api' -Credential $cred
Reset-R1Password -resetToken $reset.resetToken -newPassword (Read-Host -AsSecureString)
Handles an expired password: the connect attempt returns the reset information, whose resetToken drives the password reset.
Example 3
Connect-R1Session -BaseURI 'https://radiantone.lab.local:7070/api' -Credential $cred -SkipCertificateCheck
Connects to a deployment presenting a self-signed certificate.
PARAMETERS
-BaseURI
The URL of the RadiantOne API endpoint.
This is the API address, not the Control Panel UI address. On a RadiantOne cloud tenant the two differ by an /api suffix, and both are listed in the Application Endpoints panel of the Environment Operations Center:
- Control Panel UI: https://tenant.example.radiantlogic.io
- API: https://tenant.example.radiantlogic.io/api
Supplying the Control Panel UI address produces a valid looking URL which returns 404 for every request, so copy the API address. A trailing slash is accepted and removed.
The LDAPS and REST addresses listed alongside them are the directory and REST client endpoints, and are not this API.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Credential
A PSCredential object containing the username and password of the RadiantOne user to authenticate as.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-SkipCertificateCheck
Bypass certificate validation for the request. Specify when the deployment presents a self-signed certificate.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
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.