Deploy Okta People Picker for SharePoint agent

Install and deploy the Okta People Picker for SharePoint agent to your SharePoint farm environment. The following default installation steps activate the feature at the farm level.

Before you begin

• Complete Configure Okta as Claims Provider in SharePoint (On-Premises).

• If you're upgrading the Okta People Picker, completely remove the previous version of the Okta People Picker. See Uninstall Okta People Picker and Okta authentication.

Start this procedure

This procedure includes the following tasks:

1. Install Okta People Picker for SharePoint agent

2. Assign Okta Claims Provider as Trusted Identity Token Issuer

3. Validate the installation and configuration

1. Install Okta People Picker for SharePoint agent

1. In the Okta Admin Console, go to SettingsDownload and download the Okta People Picker for SharePoint Server 2013 or 2016.

2. Enter the following PowerShell commands to add and install the Okta SharePoint solution for People Picker:

   Copy

   Add-SPSolution -LiteralPath "C:\OktaClaimsProviderxx.xxx.wsp"
   Install-SPSolution -Identity "oktaclaimsproviderxx.xxx.wsp" –GACDeployment
   

   Replace the LiteralPath command-line argument with the path to the downloaded People Picker WSP solution file, and update the Identity command-line argument with the appropriate version-based file name.

   • It might take a few minutes for the agent to be installed and deployed.
   • You can query your deployment status by entering the following PowerShell command: Get-SPSolution.
   • The status output reads Deployed after the solution has been deployed to the farm.
   • If the status output continues to read Not deployed, sign into the SharePoint Central Administration console, select System SettingsManage Farm Solutions, and check for error messages.
   • If necessary, cancel the deployment and restart it using the SharePoint Central Administration Management Console.

3. Deploy the agent using the SharePoint Central Administration Management Console. Confirm the installation and troubleshoot any issues.

   Okta recommends that you use a ULS viewer during the People Picker installation procedure to help you diagnose configuration issues.

   

2. Assign Okta Claims Provider as Trusted Identity Token Issuer

Assign the Okta Claims Provider that was configured during the Okta SSO configuration as the SPTrustedIdentityTokenIssuer for People Picker.

If the SPTrustedIdentityTokenIssuer was named something other than Okta during the SSO configuration, update the following commands with the correct values:

$trust = Get-SPTrustedIdentityTokenIssuer "Okta"
$trust.ClaimProviderName = "OktaClaimsProvider"
$trust.Update()

3. Validate the installation and configuration

1. Enter the following PowerShell command to retrieve the OktaClaimsProvider value:

   Copy

   Get-SPClaimProvider
   

2. Make sure that the Okta provider is Enabled and configured as Default.

   

Troubleshoot the People Picker

Look for OktaClaimsProvider in the SharePoint ULS logs to monitor the activity of the claims provider. A ULS log viewer is recommended.

Next steps

Configure Okta SharePoint People Picker agent