Class SecurityPrincipalQueryParameters

Namespace

FoundationaLLM.Common.Models.Authorization

Assembly

FoundationaLLM.Common.dll

Parameters for querying role assignments.

public class SecurityPrincipalQueryParameters

Inheritance

object

SecurityPrincipalQueryParameters

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

Ids

Gets of sets a list of security principal identifiers to query.

[JsonPropertyName("ids")]
public string[]? Ids { get; set; }

Property Value

string[]

Remarks

When this property is specified, the Name and SecurityPrincipalType properties must be null.

Name

Gets or sets the name of the security principal to query.

[JsonPropertyName("name")]
public string? Name { get; set; }

Property Value

string

Remarks

The name can be a partial name used to indetify multiple security principals. When this property is specified, the SecurityPrincipalName property muse be set and the Ids property must be an empty array.

SecurityPrincipalType

Gets or sets the type of security principal to query. Must be one of the SecurityPrincipalTypes values.

[JsonPropertyName("security_principal_type")]
public string? SecurityPrincipalType { get; set; }

Property Value

string

Remarks

This property must be set when the Name property is specified.