Class ActionAuthorizationRequest

Namespace

FoundationaLLM.Common.Models.Authorization

Assembly

FoundationaLLM.Common.dll

Represents a request to authorize an action.

public class ActionAuthorizationRequest

Inheritance

object

ActionAuthorizationRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Properties

Action

The authorizable action for which authorization is requested.

[JsonPropertyName("action")]
public required string Action { get; set; }

Property Value

string

ExpandResourceTypePaths

Gets or sets a value indicating whether to expand resource type paths that are not authorized.

[JsonPropertyName("expand_resource_type_paths")]
public required bool ExpandResourceTypePaths { get; set; }

Property Value

bool

Remarks

If the action specified by Action is not authorized for a resource type path, and this property is set to true, the response will include any authorized resource paths matching the resource type path.

IncludeActions

Gets or sets a value indicating whether to include authorizable actions in the response.

[JsonPropertyName("include_actions")]
public required bool IncludeActions { get; set; }

Property Value

bool

Remarks

If this property is set to true, for each authorized resource path, the response will include the authorizable actions assigned directly or indirectly to the resource path.

IncludeRoles

Gets or sets a value indicating whether to include roles in the response.

[JsonPropertyName("include_roles")]
public required bool IncludeRoles { get; set; }

Property Value

bool

Remarks

If this property is set to true, for each authrorized resource path, the response will include the roles assigned directly or indirectly to the resource path.

ResourcePaths

The list of resources for which authorization is requested.

[JsonPropertyName("resources")]
public required List<string> ResourcePaths { get; set; }

Property Value

List<string>

RoleName

Gets or sets the optional role name to check for assignment.

[JsonPropertyName("role_name")]
public string? RoleName { get; set; }

Property Value

string

UserContext

The UserAuthorizationContext containing the authorization context for the user.

[JsonPropertyName("user_context")]
public required UserAuthorizationContext UserContext { get; set; }

Property Value

UserAuthorizationContext