Connect-BeInstance

Last Updated On

Connects the PowerShell session to a BiG EVAL intance.

Connect-BeInstance
    -ServerUrl <String>
    -ClientId <String>
    -ClientSecret <String>
    [-InstanceName <String>]
    [-ApiVersion <String>]

Description

The Connect-BeInstance cmdlet connects the current session to a specific BiG EVAL instance. To do that, it needs at least the URL of the BiG EVAL instance in the ServerUrl parameter as well as the OAuth 2.0 authentication parameters ClientId and ClientSecret. These authentication parameters can be obtained in the system-setting section of BiG EVAL. See Managing API Clients.

When connected, the cmdlet returns a connection-object that contains information about the connection and that must be passed to each of the other cmdlets for authorization.

Example

$serverUrl = "https://bigeval.mycompany.com/"
$clientId = "f85eb6171a4e077b56022e892e5cd941"
$clientSecret = "83b29028cd7e4a8392b861462b62d038"

$connection = Connect-BeInstance -ServerUrl $serverUrl -ClientId $clientId -ClientSecret $clientSecret

Parameters

-ServerUrl

The root URL of the BiG EVAL server without any subfolders.

Type:String
Mandatory:Yes
Position:Named
Default Value:None

-ClientId

The client-ID of the API-Client that can be configured in BiG EVALs system settings. See Managing API Clients.

Type:String
Mandatory:Yes
Position:Named
Default Value:None

-ClientSecret

The client-Secret of the API-Client that can be configured in BiG EVALs system settings. See Managing API Clients.

Type:String
Mandatory:Yes
Position:Named
Default Value:None

-Instance

This parameter can be used to optionally target a specific instance of BiG EVAL. If not used, the default instance is targeted.

Type:String
Mandatory:No
Position:Named
Default Value:“default”

-ApiVersion

This parameter can be used to optionally target another version of the BiG EVAL API.

Type:String
Mandatory:No
Position:Named
Default Value:“v1”

Table of Contents