Skip to main content

IScopeClaimsProvider Interface

Abblix.Oidc.Server​

Abblix.Oidc.Server.Features.UserInfo​

IScopeClaimsProvider Interface​

Defines a service responsible for determining the claims associated with specific OAuth 2.0 and OpenID Connect scopes. This interface facilitates the mapping of requested scopes to their corresponding claims, enabling effective claims management based on the authorization policies and client request parameters.

public interface IScopeClaimsProvider

Derived
↳ ScopeClaimsProvider

Properties​

IScopeClaimsProvider.ClaimsSupported Property​

Provides a collection of all the claims that this provider can handle. These claims represent the total set of data points that can be requested through various scopes and are used for constructing tokens and user information responses.

System.Collections.Generic.IEnumerable<string> ClaimsSupported { get; }

Property Value​

System.Collections.Generic.IEnumerable<System.String>

IScopeClaimsProvider.ScopesSupported Property​

Provides a collection of all the scopes that are recognized and supported by this provider. This property can be used to validate scope requests or to generate metadata for discovery documents.

System.Collections.Generic.IEnumerable<string> ScopesSupported { get; }

Property Value​

System.Collections.Generic.IEnumerable<System.String>

Methods​

IScopeClaimsProvider.GetRequestedClaims(IEnumerable<string>, IEnumerable<string>) Method​

Retrieves the set of claim names associated with the requested scopes and any additional claim details. This method allows for dynamic claim resolution based on the authorization request, supporting customization of claims returned in tokens or user info responses.

System.Collections.Generic.IEnumerable<string> GetRequestedClaims(System.Collections.Generic.IEnumerable<string> scopes, System.Collections.Generic.IEnumerable<string>? requestedClaims);

Parameters​

scopes System.Collections.Generic.IEnumerable<System.String>​

An enumerable of strings representing the requested scopes. Each scope can be associated with one or multiple claims as defined by the implementation.

requestedClaims System.Collections.Generic.IEnumerable<System.String>​

An optional collection of additional claims requested, which may not necessarily be tied to specific scopes but are required by the client.

Returns​

System.Collections.Generic.IEnumerable<System.String>
An IEnumerable of strings, each representing a claim name that should be included based on the requested scopes and additional claims.