# Interface IWorkflowApiPermissionsBuilder

OptimaJet.Workflow.Api.IWorkflowApiPermissionsBuilder

Fluent builder for Workflow Engine API permissions values.

Namespace: [OptimaJet.Workflow.Api](https://api.workflowengine.io/web-api/OptimaJet.Workflow.Api/)

```csharp
public interface IWorkflowApiPermissionsBuilder
```

## Type Hierarchy

-   IWorkflowApiPermissionsBuilder Current type
    -   Derived interfaces
        -   [IWorkflowApiOperationPermissionsBuilder](https://api.workflowengine.io/web-api/OptimaJet.Workflow.Api/IWorkflowApiOperationPermissionsBuilder/)

## Methods

`IWorkflowApiOperationPermissionsBuilder AllowAllOperations()` 

Replaces the current operation permissions with a policy that allows all operations by default.

### Returns

| Type | Description |
| --- | --- |
| `IWorkflowApiOperationPermissionsBuilder` | An operation permissions builder. |

### Remarks

Sets `allow` as the default for all operations. Additional explicit rules may deny specific branches or exact operations.

`IWorkflowApiOperationPermissionsBuilder DenyAllOperations()` 

Replaces the current operation permissions with a policy that denies all operations by default.

### Returns

| Type | Description |
| --- | --- |
| `IWorkflowApiOperationPermissionsBuilder` | An operation permissions builder. |

### Remarks

Sets `deny` as the default for all operations. Additional explicit rules may allow specific branches or exact operations.

`IWorkflowApiPermissionsBuilder AllowAllTenants()` 

Replaces the current tenant permissions with a policy that allows all tenants by default.

### Returns

| Type | Description |
| --- | --- |
| `IWorkflowApiPermissionsBuilder` | The current permissions builder. |

### Remarks

Sets `allow` as the default for all tenants with no explicit exceptions.

`IWorkflowApiPermissionsBuilder AllowAllTenantsExcept(params string[] tenantIds)` 

Replaces the current tenant permissions with a policy that allows all tenants by default except the specified tenant ids.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `tenantIds` | `String[]` | Tenant identifiers to deny. |

### Returns

| Type | Description |
| --- | --- |
| `IWorkflowApiPermissionsBuilder` | The current permissions builder. |

### Remarks

Sets `allow` as the default for all tenants and the specified tenant ids as `deny` exceptions.

`IWorkflowApiPermissionsBuilder AllowAllTenantsExcept(IEnumerable<string> tenantIds)` 

Replaces the current tenant permissions with a policy that allows all tenants by default except the specified tenant ids.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `tenantIds` | `IEnumerable<String>` | Tenant identifiers to deny. |

### Returns

| Type | Description |
| --- | --- |
| `IWorkflowApiPermissionsBuilder` | The current permissions builder. |

### Remarks

Sets `allow` as the default for all tenants and the specified tenant ids as `deny` exceptions.

`IWorkflowApiPermissionsBuilder DenyAllTenants()` 

Replaces the current tenant permissions with a policy that denies all tenants by default.

### Returns

| Type | Description |
| --- | --- |
| `IWorkflowApiPermissionsBuilder` | The current permissions builder. |

### Remarks

Sets `deny` as the default for all tenants with no explicit exceptions.

`IWorkflowApiPermissionsBuilder DenyAllTenantsExcept(params string[] tenantIds)` 

Replaces the current tenant permissions with a policy that denies all tenants by default except the specified tenant ids.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `tenantIds` | `String[]` | Tenant identifiers to allow. |

### Returns

| Type | Description |
| --- | --- |
| `IWorkflowApiPermissionsBuilder` | The current permissions builder. |

### Remarks

Sets `deny` as the default for all tenants and the specified tenant ids as `allow` exceptions.

`IWorkflowApiPermissionsBuilder DenyAllTenantsExcept(IEnumerable<string> tenantIds)` 

Replaces the current tenant permissions with a policy that denies all tenants by default except the specified tenant ids.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `tenantIds` | `IEnumerable<String>` | Tenant identifiers to allow. |

### Returns

| Type | Description |
| --- | --- |
| `IWorkflowApiPermissionsBuilder` | The current permissions builder. |

### Remarks

Sets `deny` as the default for all tenants and the specified tenant ids as `allow` exceptions.

`string GetValue()` 

Returns the serialized permissions value from the current builder state.

### Returns

| Type | Description |
| --- | --- |
| `String` | A serialized permissions value. |

`IWorkflowApiPermissionsBuilder SetValue(string value)` 

Replaces the current builder state with the rules from a serialized permissions value.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `value` | `String` | A serialized permissions value. |

### Returns

| Type | Description |
| --- | --- |
| `IWorkflowApiPermissionsBuilder` | The current permissions builder. |

`bool ValidateValue(string value)` 

Validates a serialized permissions value.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `value` | `String` | A serialized permissions value. |

### Returns

| Type | Description |
| --- | --- |
| `Boolean` | `true` when the value is valid; otherwise `false`. |

[Previous IWorkflowApiPermissions](https://api.workflowengine.io/web-api/OptimaJet.Workflow.Api/IWorkflowApiPermissions/) [Next IWorkflowRuntimeConfigurator](https://api.workflowengine.io/web-api/OptimaJet.Workflow.Api/IWorkflowRuntimeConfigurator/)