Samples

The FoxIDs samples show user login and logout with OpenID Connect 1.0 and SAML 2.0, client credential grant with secret and certificate, API calls secured with OAuth 2.0 and token exchange. The sample source is located in the FoxIDs.Samples repository.

The samples are pre-configured in the FoxIDs.com test track and can immediately run locally in Visual Studio on the pre-configured localhost ports.
You can also configure the samples in your one FoxIDs track.

You can use the JWT tool and SAML 2.0 tool to decode tokens and create self-signed certificates with the certificate tool.

The sample Visual Studio solution contain the following down-party and up-party sample applications.

Down-party sample applications

AspNetCoreOidcAuthCodeAllUpPartiesSample

Sample (code link) applicationshowing user login and logout with OpenID Connect (OIDC) using authorization code flow as a service provider and requesting login by all up-parties.

This sample is a good starting point!

The possible up-parties is configured in the down-party as allowed up-parties. There can be configured one to many allowed up-parties. All the configured up-parties is selected with a star instead of an up-party name.

Support login/logout with FoxIDs login page, Identity Server, SAML 2.0 IdP sample and all other up-parties.

API calls:

  • Show how to call the API1 sample secured with an access token.
  • Show how to call the API1 sample secured with an access token which again call API2 sample using token exchange insight API1.
  • Show how to obtained an access token by token exchange, the client use client authentication method client_secret_post. And then call the API2 sample secured with the obtained access token.

Local development domain and port: https://localhost:44349

AspNetCoreOidcAuthorizationCodeSample

Sample (code link) application showing user login and logout with OpenID Connect (OIDC) using authorization code flow as a service provider.

Support login/logout with FoxIDs login page, Identity Server, SAML 2.0 IdP sample and if configured AD FS using SAML 2.0.

Show how to call the API1 sample secured with an access token.

Local development domain and port: https://localhost:44340

AspNetCoreOidcImplicitSample

Sample (code link) application showing user login and logout with OpenID Connect (OIDC) using implicit flow as a service provider.

Support login/logout with FoxIDs login page, Identity Server, SAML 2.0 IdP sample and if configured AD FS using SAML 2.0.

Local development domain and port: https://localhost:44341

AspNetCoreSamlSample

Sample (code link) application showing user login and logout with SAML 2.0 as a relying party.

Support login/logout with FoxIDs login page, Identity Server, SAML 2.0 IdP sample and if configured AD FS using SAML 2.0.

Show how to obtained an access token from an SAML 2.0 bearer token with token exchange, the client use client authentication method private_key_jwt (certificate). And then call the API1 sample secured with the obtained access token.

Local development domain and port: https://localhost:44343

NetCoreClientCredentialGrantConsoleSample

Sample (code link) console application (backend) showing client authentication with OAuth 2.0 Client Credentials Grant using a secret (client authentication method client_secret_post).

Show how to call the API1 sample and API with two IdPs sample secured with an access token.

NetCoreClientCredentialGrantAssertionConsoleSample

Sample (code link) console application (backend) showing client authentication with OAuth 2.0 Client Credentials Grant using a certificate (client authentication method private_key_jwt).

Show how to call the API1 sample and API with two IdPs sample secured with an access token.

BlazorBFFAspNetCoreOidcSample

Sample (code link client and server) application showing user login and logout with OpenID Connect (OIDC) using authorization code flow in a Blazor BFF (Backend For Frontend) application with a ASP.NET Core backend.
In a BFF architecture the backend handles OIDC, the tokens are never shared with the Blazor client. Instead a session based on an identity cookie secure the application after successfully user authentication.

The sample show how to call the API1 sample from both the Blazor client through a backend API proxy which add the access token to the outgoing API call.

Local development domain and port: https://localhost:44348

BlazorOidcPkceSample

Blazor sample (code link) application showing user login and logout with OpenID Connect (OIDC) using authorization code flow and PKCE as a service provider.

Show how to call the API1 sample secured with an access token.

Local development domain and port: https://localhost:44345

BlazorServerOidcSample

Blazor server sample (code link) application showing user login and logout with OpenID Connect (OIDC) using authorization code flow as a service provider.

Show how to call the API1 sample secured with an access token.

Local development domain and port: https://localhost:44347

AspNetCoreApi1Sample

Sample (code link) API showing how to secure an API with an access token and how to restrict access by scopes.

The API calls API2 sample secured with an access token obtained by token exchange where the client use client authentication method private_key_jwt (certificate).

Local development domain and port: https://localhost:44344

AspNetCoreApi2Sample

Sample (code link) API showing how to secure an API with an access token and how to restrict access by a scope.

Local development domain and port: https://localhost:44351

AspNetCoreApiOAuthTwoIdPsSample

Sample (code link) API showing how to create an API which can accept access tokens from two different IdPs. Each IdP - API relation can be configured with individual resource IDs and scopes.

This scenario occurs most often in a transitional period moving from one IdP to another IdP. Having APIs with dual IdP support the clients can be moved from one IdP to another IdP independent of the APIs.

The sample API can be called by changing comment out code in the NetCoreClientCredentialGrantConsoleSample or NetCoreClientCredentialGrantAssertionConsoleSample samples.

Local development domain and port: https://localhost:44350

Up-party sample applications

AspNetCoreSamlIdPSample

Sample (code link) application implementing a SAML 2.0 identity provider (IdP) connected as a SAML 2.0 up-party in FoxIDs.

Local development domain and port: https://localhost:44342

IdentityServerOidcOpSample

Identity Server (code link) implementing OpenID Connect (OIDC) exposing a OpenID Provider (OP) / identity provider (IdP) connected as a OpenID Connect up-party in FoxIDs.

Local development domain and port: https://localhost:44346

Configure samples in FoxIDs track

The samples can be configured in a FoxIDs track with the sample seed tool or manually through the FoxIDs Control Client.

The sample seed tool is found in the sample solution: tools/SampleSeedTool.

Configure the sample seed tool

The sample seed tool is configured in the appsettings.json file.

Add the FoxIDs and FoxIDs Control API endpoints to the sample seed tool configuration. They can be added by updating the instance names https://foxids.com and https://control.foxids.com/api. If you are running FoxIDs locally in Visual Studio the endpoints is configured to FoxIDs localhost https://localhost:44330/ and FoxIDs Control API localhost https://localhost:44331/.

"SeedSettings": {
    "FoxIDsEndpoint": "https://foxids.com", 
    "FoxIDsConsolApiEndpoint": "https://control.foxids.com/api"
}

Access to create the sample configuration in a track is granted in the master track. The sample configuration should not be added to the master track.

Create a sample seed tool OAuth 2.0 client in the FoxIDs Control Client:

  1. Select the master track and create a OAuth 2.0 down-party, click OAuth 2.0 - Client Credentials Grant.
  2. Set the client id to sample_seed.
  3. Remember the client secret.
  4. In the resource and scopes section. Grant the sample seed client access to the FoxIDs Control API resource foxids_control_api with the scope foxids:tenant.
  5. Click show advanced settings.
  6. In the issue claims section. Add a claim with the name role and the value foxids:tenant.admin. This will granted the client the administrator role.

The sample seed tool client is thereby granted access to update to the tenant.

FoxIDs Control Client - sample_seed client

Create a new FoxIDs track for the sample applications or select an existing track.

Change the tenant, the track and the sample seed tool client secret in the sample seed tool configured.

"SeedSettings": {
  "Tenant": "xxx",
  "Track": "xxx",
  "DownParty": "sample_seed",
  "ClientSecret": "xxx"
}

Change the tenant and the track configuration for all the samples.

Run the sample seed tool

Run the sample seed tool executable SampleSeedTool.exe or run the seed tool directly from Visual Studio.

  • Click 'c' to create the sample configuration
  • Click 'd' to delete the sample configuration

The sample seed tool will create and delete configurations for all samples.

The sample applications require a login up-party with the name login (handles user login). It is created by the sample seed tool if it do not exists. The login up-party is not deleted if the sample configuration is deleted.