Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/StyraInc/opa-csharp
Styra's C# OPA Client SDK
https://github.com/StyraInc/opa-csharp
Last synced: about 2 months ago
JSON representation
Styra's C# OPA Client SDK
- Host: GitHub
- URL: https://github.com/StyraInc/opa-csharp
- Owner: StyraInc
- License: apache-2.0
- Created: 2024-03-06T18:58:52.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-04-19T18:24:31.000Z (5 months ago)
- Last Synced: 2024-04-19T21:15:14.636Z (5 months ago)
- Language: C#
- Homepage: https://styrainc.github.io/opa-csharp/
- Size: 111 KB
- Stars: 2
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-opa - Styra C# SDK - C# SDK for interacting with OPA ([documentation](https://docs.styra.com/sdk)) (Language and Platform Integrations / .NET)
README
# OPA C# SDK
[](https://opensource.org/licenses/Apache-2.0)
[](https://www.nuget.org/packages/Styra.Opa/)
> [!IMPORTANT]
> The documentation for this SDK lives at https://docs.styra.com/sdk, with reference documentation available at https://styrainc.github.io/opa-csharp
You can use the Styra OPA SDK to connect to [Open Policy Agent](https://www.openpolicyagent.org/) and [Enterprise OPA](https://www.styra.com/enterprise-opa/) deployments.
## SDK Installation
### Nuget
```bash
dotnet add package Styra.Opa
```
## SDK Example Usage (high-level)
All the code examples that follow assume that the high-level SDK module has been imported, and that an `OpaClient` instance was created:
```csharp
using Styra.Opa;
private string serverURL = "http://opa-host:8181";
private string path = "authz/allow";
private OpaClient opa;
opa = new OPAClient(serverURL);
var input = new Dictionary() {
{ "user", "alice" },
{ "action", "read" },
{"resource", "/finance/reports/fy2038_budget.csv"},
};
// (local variable) bool allowed
var allowed = await opa.check("authz/allow", input);
// (local variable) violations List?
var violations = await opa.evaluate>("authz/violations", input);
// Normal true/false cases...
if (allowed) {
// ...
} else {
Console.WriteLine("Violations: " + violations);
}
```
### Input types
The `check` and `evaluate` methods are overloaded for most standard JSON types, which include the following variants for the `input` parameter:
| C# type | JSON equivalent type |
| ------- | -------------------- |
| `bool` | Boolean |
| `double` | Number |
| `string` | String |
| `List` | Array |
| `Dictionary` | Object |
### Result Types
#### `OpaClient.check`
For the `check` method, the output type is always `bool`.
#### `OpaClient.evaluate`
For the `evaluate` method, the output type is configurable using generics, as shown in the example below.
```csharp
string path = "authz/accounts/max_limit";
double? maxLimit = opa.evaluate(path, "example");
```
For cases where a default value is appropriate, you can avoid the nullable `double` type in the example like so:
```csharp
string path = "authz/accounts/max_limit";
double maxLimit = opa.evaluate(path, "example") ?? 0.0f;
```
If the selected return type `` is possible to deserialize from the returned JSON, `evaluate` will attempt to populate the variable with the value(s) present.
```csharp
public struct AuthzStatus
{
public AuthzStatus(bool allowed)
{
Allowed = allowed;
}
public double Allowed { get; }
public override string ToString() => $"Application authorized: {Allowed}";
}
var input = new Dictionary() {
{ "user", "alice" },
{ "action", "read" },
};
// (local variable) AuthzStatus status
var status = opa.evaluate(path, input) ?? AuthzStatus(false);
```
> [!NOTE]
> For low-level SDK usage, see the sections below.
---
# OPA OpenAPI SDK (low-level)
## SDK Example Usage
### Example 1
```csharp
using Styra.Opa.OpenApi;
using Styra.Opa.OpenApi.Models.Requests;
using Styra.Opa.OpenApi.Models.Components;
var sdk = new OpaApiClient();
var res = await sdk.ExecuteDefaultPolicyWithInputAsync(
input: Input.CreateInputNumber(
8203.11D,
),
pretty: false,
acceptEncoding: GzipAcceptEncoding.Gzip);
// handle response
```
### Example 2
```csharp
using Styra.Opa.OpenApi;
using Styra.Opa.OpenApi.Models.Requests;
using System.Collections.Generic;
using Styra.Opa.OpenApi.Models.Components;
var sdk = new OpaApiClient();
ExecuteBatchPolicyWithInputRequest req = new ExecuteBatchPolicyWithInputRequest() {
Path = "app/rbac",
RequestBody = new ExecuteBatchPolicyWithInputRequestBody() {
Inputs = new Dictionary() {
{ "key", Input.CreateInputStr(
"",
) },
},
},
};
var res = await sdk.ExecuteBatchPolicyWithInputAsync(req);
// handle response
```
### Example 3
```csharp
using Styra.Opa.OpenApi;
using Styra.Opa.OpenApi.Models.Requests;
using Styra.Opa.OpenApi.Models.Components;
var sdk = new OpaApiClient();
ExecutePolicyWithInputRequest req = new ExecutePolicyWithInputRequest() {
Path = "app/rbac",
RequestBody = new ExecutePolicyWithInputRequestBody() {
Input = Input.CreateInputBoolean(
false,
),
},
};
var res = await sdk.ExecutePolicyWithInputAsync(req);
// handle response
```
## Available Resources and Operations
### [OpaApiClient SDK](docs/sdks/opaapiclient/README.md)
* [ExecuteDefaultPolicyWithInput](docs/sdks/opaapiclient/README.md#executedefaultpolicywithinput) - Execute the default decision given an input
* [Health](docs/sdks/opaapiclient/README.md#health) - Verify the server is operational
* [ExecuteBatchPolicyWithInput](docs/sdks/opaapiclient/README.md#executebatchpolicywithinput) - Execute a policy given a batch of inputs
* [ExecutePolicy](docs/sdks/opaapiclient/README.md#executepolicy) - Execute a policy
* [ExecutePolicyWithInput](docs/sdks/opaapiclient/README.md#executepolicywithinput) - Execute a policy given an input
## Server Selection
### Select Server by Index
You can override the default server globally by passing a server index to the `serverIndex: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
| - | ------ | --------- |
| 0 | `http://localhost:8181` | None |
### Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the `serverUrl: str` optional parameter when initializing the SDK client instance. For example:
## Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or thow an exception. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate type.
| Error Object | Status Code | Content Type |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| Styra.Opa.OpenApi.Models.Errors.ClientError | 400,404 | application/json |
| Styra.Opa.OpenApi.Models.Errors.ServerError | 500 | application/json |
| Styra.Opa.OpenApi.Models.Errors.SDKException | 4xx-5xx | */* |
### Example
```csharp
using Styra.Opa.OpenApi;
using System;
using Styra.Opa.OpenApi.Models.Errors;
using Styra.Opa.OpenApi.Models.Requests;
using Styra.Opa.OpenApi.Models.Components;
var sdk = new OpaApiClient();
try
{
var res = await sdk.ExecuteDefaultPolicyWithInputAsync(
input: Input.CreateInputNumber(
8203.11D,
),
pretty: false,
acceptEncoding: GzipAcceptEncoding.Gzip);
// handle response
}
catch (Exception ex)
{
if (ex is ClientError)
{
// handle exception
}
else if (ex is Models.Errors.ServerError)
{
// handle exception
}
else if (ex is Styra.Opa.OpenApi.Models.Errors.SDKException)
{
// handle exception
}
}
```
## Community
For questions, discussions and announcements related to Styra products, services and open source projects, please join
the Styra community on [Slack](https://communityinviter.com/apps/styracommunity/signup)!