IntelligentPlant.IndustrialAppStore.Authentication 3.4.1

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package IntelligentPlant.IndustrialAppStore.Authentication --version 3.4.1
                    
NuGet\Install-Package IntelligentPlant.IndustrialAppStore.Authentication -Version 3.4.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="IntelligentPlant.IndustrialAppStore.Authentication" Version="3.4.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="IntelligentPlant.IndustrialAppStore.Authentication" Version="3.4.1" />
                    
Directory.Packages.props
<PackageReference Include="IntelligentPlant.IndustrialAppStore.Authentication" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add IntelligentPlant.IndustrialAppStore.Authentication --version 3.4.1
                    
#r "nuget: IntelligentPlant.IndustrialAppStore.Authentication, 3.4.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package IntelligentPlant.IndustrialAppStore.Authentication@3.4.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=IntelligentPlant.IndustrialAppStore.Authentication&version=3.4.1
                    
Install as a Cake Addin
#tool nuget:?package=IntelligentPlant.IndustrialAppStore.Authentication&version=3.4.1
                    
Install as a Cake Tool

IntelligentPlant.IndustrialAppStore.Authentication

This package provides ASP.NET Core services and authentication handlers that enable you to integrate applications with the Industrial App Store.

Please consider using the IntelligentPlant.IndustrialAppStore.Templates package to simplify creation of projects that are pre-configured to use this package.

Getting Started

Authentication and Industrial App Store Integration

First, visit the Industrial App Store and create a registration for your app. When you register your app, you can configure the default scopes (i.e. permissions) that the app will request (user info, reading user data sources, etc).

You must also register a redirect URL to use when signing users in. The default relative path used is /auth/signin-ip i.e. if your app will run at https://localhost:44321, you must register https://localhost:44321/auth/signin-ip as an allowed redirect URL.

In your application's appsettings.json file, add the following items, replacing the placeholders with values from your app registration:

{
    "IAS": {
        "ClientId": "<YOUR CLIENT ID>",
        "ClientSecret": "<YOUR CLIENT SECRET>"
    }
}

NOTE: Do not store client secrets in the appsettings.json file in a production environment! Services such as Azure Key Vault can be used to securely store client secrets and retrieve them at runtime.

Next, configure your application to use the Industrial App Store for authentication:

// Program.cs

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddIndustrialAppStoreAuthentication(options => {
    // Bind the settings from the app configuration to the Industrial App Store 
    // authentication options.
    builder.Configuration.GetSection("IAS").Bind(options);
});

// Configure additional services etc. here.

var app = builder.Build();

app.UseRouting();

app.UseAuthentication();
app.UseAuthorization();

// Configure HTTP pipeline here.

If your app has a login page that requires the user to accept a privacy policy or explicitly enable persistent cookies, you can specify this as follows:

builder.Services.AddIndustrialAppStoreAuthentication(options => {
    // Bind the settings from the app configuration to the Industrial App Store 
    // authentication options.
    builder.Configuration.GetSection("IAS").Bind(options);

    // Set the login path to be our login page.
    options.LoginPath = new PathString("/Account/Login");
});

Calling Industrial App Store APIs

Inject the IndustrialAppStoreHttpClient service into your types to obtain an API client that will authenticate as the calling user:

app.MapGet("/api/user", async (IndustrialAppStoreHttpClient client) => {
    var user = await client.UserInfo.GetUserInfoAsync();
    return Results.Json(user);
});

Refer to the project repository for more details on available API calls.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
3.5.0-pre.417 112 7/2/2025
3.5.0-pre.414 123 5/20/2025
3.5.0-pre.409 76 5/9/2025
3.4.1 171 4/8/2025
3.4.0 165 4/8/2025
3.3.0 120 2/28/2025
3.3.0-pre.382 71 2/26/2025
3.2.0 128 2/3/2025
3.1.0 175 12/12/2024
3.0.0 120 11/27/2024
3.0.0-pre.361 62 11/20/2024
3.0.0-pre.358 62 11/20/2024
3.0.0-pre.351 67 11/15/2024
3.0.0-pre.348 81 11/11/2024
3.0.0-pre.339 66 11/7/2024
3.0.0-pre.328 95 10/31/2024
3.0.0-pre.320 71 10/31/2024
2.3.0-pre.293 98 2/6/2024
2.3.0-pre.280 143 3/28/2023
2.3.0-pre.269 173 9/9/2022
2.3.0-pre.259 148 6/28/2022
2.3.0-pre.256 171 6/27/2022
2.3.0-pre.236 171 3/24/2022
2.2.3 128 10/29/2024
2.2.2 141 10/10/2024
2.2.1 729 5/11/2022
2.2.0 631 3/10/2022
2.1.0 647 2/23/2022
2.1.0-alpha.220 185 2/23/2022
2.1.0-alpha.216 174 2/23/2022
2.1.0-alpha.213 169 2/22/2022
2.1.0-alpha.210 165 2/22/2022
2.1.0-alpha.207 171 2/22/2022
2.0.0 622 2/17/2022
2.0.0-beta.195 177 2/17/2022
2.0.0-beta.175 177 2/10/2022
2.0.0-beta.171 176 2/9/2022
2.0.0-beta.165 184 1/13/2022
2.0.0-beta.162 182 1/6/2022
2.0.0-beta.158 181 1/5/2022
2.0.0-alpha.148 217 11/12/2021
2.0.0-alpha.139 211 11/11/2021
1.4.0 554 7/14/2021
1.2.1 529 4/7/2021
1.2.0 506 2/8/2021
1.1.0 491 1/18/2021
1.0.2 476 12/3/2020
1.0.1 462 12/3/2020
1.0.0 508 10/13/2020
1.0.0-alpha32 445 8/7/2020
1.0.0-alpha29 423 7/13/2020
1.0.0-alpha27 405 7/10/2020
1.0.0-alpha25 457 7/10/2020
1.0.0-alpha22 452 7/10/2020