BccCode.Privacy.Client 0.0.6

BCC Privacy Client (.NET)

Machine-to-machine client for the BCC Privacy API, built on BCC Platform like the Core API and Notifications clients.

Install

dotnet add package BccCode.Privacy.Client

Register

The installer follows bcc-platform-sdks' pattern (docs/dotnet/openapi-sdk-installer.md), like the Core API client: the credential overloads configure the platform with AddBccPlatform, and every request carries the platform's cached, auto-refreshing token.

With an environment and the client credentials (one call):

services.AddBccPrivacyClient(AppEnvironment.Prod, "client-id", "client-secret");

With the BCC platform already configured, for example because the service uses several BCC SDKs:

services.AddBccPlatform(AppEnvironment.Prod);   // credentials from the BccAuth section
services.AddBccPrivacyClient();

AddBccPrivacyClient(environment), AddBccPrivacyClient(environment, oAuthOptions) and AddBccPrivacyClient(environment, authConfig) mirror the other AddBccPlatform overloads.

The token is requested for the platform's M2M audience (api.bcc.no, sandbox-api.bcc.no in sandbox), the same one the Core API uses, with the scope privacy.catalogue#read.

For any other host, pass its base URL: services.AddBccPrivacyClient("https://localhost:13000"), with the platform configured.

Use

var personalData = await privacyClient.GetPersonalDataAsync();
var processes = await privacyClient.GetProcessesAsync();

GetPersonalDataAsync returns every personal-data item (names in each language, classification and scopes), including items no process uses yet. GetProcessesAsync returns every active process (controller, purposes in each language, legal basis, validity) with the personal-data items it uses.

The client application must be granted the scope on the Core API resource in Auth0. Failed calls throw PrivacyApiException with the status code and response body.

Releases

.github/workflows/sdk-dotnet-publish.yml publishes the package to NuGet; the version follows bcc-core-api's SDK workflow. A merge to main that changes sdk/dotnet publishes <major>.<minor>.<n> once the integration tests pass, where <n> counts the SDK's commits since the last sdk-dotnet-v<major>.<minor>.0 tag (0.0.<n> until the first tag). A pull request only builds and packs; nothing is published from it. To publish a beta (<version>-beta.<run>) from a branch, run the workflow by hand on that branch; a required reviewer of the nuget-beta environment approves the run before it publishes. Tag a commit sdk-dotnet-v<major>.<minor>.0 to start a new minor or major version.

See the .NET SDK section of the integration guide for usage.