Class OrganizationRequirement

Namespace

Keycloak.AuthServices.Authorization.Requirements

Assembly

Keycloak.AuthServices.Authorization.dll

Authorization requirement that validates the user's membership in a Keycloak organization.

public class OrganizationRequirement : IAuthorizationRequirement, IAuthorizationRequirementData

Inheritance

object

OrganizationRequirement

Implements

IAuthorizationRequirement

IAuthorizationRequirementData

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

OrganizationRequirement()

Constructs requirement that checks for any organization membership.

public OrganizationRequirement()

OrganizationRequirement(string)

Constructs requirement that checks for membership in a specific organization.

public OrganizationRequirement(string organization)

Parameters

organization string

The organization alias, id, or route template (e.g., "{orgId}").

Fields

OrganizationPolicy

Internal name for the organization policy.

public const string OrganizationPolicy = "$OrganizationPolicy"

Field Value

string

Properties

Organization

Gets the organization alias or route template to check membership against. When null, any organization membership satisfies the requirement. Supports {param} route templates that are resolved at evaluation time.

public string? Organization { get; }

Property Value

string

ResolverType

Gets the type of IParameterResolver used to resolve organization template parameters. When null, the default RouteParameterResolver is used.

public Type? ResolverType { get; init; }

Property Value

Type

Methods

GetRequirements()

Returns IAuthorizationRequirement that should be satisfied for authorization.

public IEnumerable<IAuthorizationRequirement> GetRequirements()

Returns

IEnumerable<IAuthorizationRequirement>

IAuthorizationRequirement used for authorization.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.