C# Class KeycloakIdentityModel.KeycloakIdentity

Inheritance: System.Security.Claims.ClaimsIdentity, IIdentity

Mostra file Open project: dylanplecki/KeycloakOwinAuthentication Class Usage Examples

Public Methods

Method	Description
Clone ( ) : ClaimsIdentity	Returns a new System.Security.Claims.ClaimsIdentity copied from this claims identity
ConvertFromAuthResponseAsync ( IKeycloakParameters parameters, AuthorizationResponse response, Uri baseUri ) : Task	Converts a JWT token-response endpoint message into a Keycloak identity
ConvertFromClaimsAsync ( IKeycloakParameters parameters, IEnumerable claims ) : Task	Converts a keycloak-generated claims list into a Keycloak identity
ConvertFromClaimsIdentityAsync ( IKeycloakParameters parameters, ClaimsIdentity identity ) : Task	Converts a keycloak-generated claims identity into a Keycloak identity
ConvertFromJwtAsync ( IKeycloakParameters parameters, string accessToken, string refreshToken = null, string idToken = null ) : Task	Converts a set of JWTs into a Keycloak identity
ConvertFromTokenResponseAsync ( IKeycloakParameters parameters, TokenResponse message ) : Task	Converts a JWT token-response endpoint message into a Keycloak identity
GenerateLoginCallbackUriAsync ( IKeycloakParameters parameters, Uri baseUri ) : Task	Generates the local URL on which to accept OIDC callbacks from Keycloak
GenerateLoginUriAsync ( IKeycloakParameters parameters, Uri baseUri, string state = null ) : Task	Generates the OpenID Connect compliant Keycloak login URL
GenerateLogoutUriAsync ( IKeycloakParameters parameters, Uri baseUri, string redirectUrl = null ) : Task	Generates the OpenID Connect compliant Keycloak logout URL
GetUpdatedClaimsAsync ( ) : Task>	Refreshes and returns the updated claims for the identity (refreshes only if necessary)
RefreshIdentityAsync ( ) : Task	Refreshes and re-authenticates the current identity from the Keycloak instance (only if necessary)
ToClaimsIdentityAsync ( ) : Task	Returns a static base representation of the identity as a claims identity
TryValidateParameters ( IKeycloakParameters parameters ) : bool	Trys to validate an IKeycloakParameters object for completeness and correctness
ValidateParameters ( IKeycloakParameters parameters ) : void	Validates an IKeycloakParameters object for completeness and correctness

Protected Methods

Method	Description
CopyFromJwt ( string accessToken, string refreshToken = null, string idToken = null ) : Task
GenerateJwtClaims ( JwtSecurityToken accessToken, JwtSecurityToken idToken, JwtSecurityToken refreshToken ) : IEnumerable
KeycloakIdentity ( IKeycloakParameters parameters ) : System	Load a new Keycloak-based identity from a claims identity
RefreshIdentity ( string refreshToken ) : Task

Private Methods

Method	Description
AddClaim ( Claim claim ) : void
AddClaims ( IEnumerable claims ) : void
GetClaimsAsync ( ) : Task>
GetCurrentClaims ( ) : IEnumerable
ProcessOidcToken ( JObject webToken, IEnumerable claimMappings, string jsonId ) : IEnumerable
RemoveClaim ( Claim claim ) : void
TryRemoveClaim ( Claim claim ) : bool

Method Details

Clone() public method

Returns a new System.Security.Claims.ClaimsIdentity copied from this claims identity

public Clone ( ) : ClaimsIdentity
return	System.Security.Claims.ClaimsIdentity

ConvertFromAuthResponseAsync() public static method

Converts a JWT token-response endpoint message into a Keycloak identity

public static ConvertFromAuthResponseAsync ( IKeycloakParameters parameters, AuthorizationResponse response, Uri baseUri ) : Task
parameters	IKeycloakParameters
response	KeycloakIdentityModel.Models.Responses.AuthorizationResponse
baseUri	System.Uri
return	Task

ConvertFromClaimsAsync() public static method

Converts a keycloak-generated claims list into a Keycloak identity

public static ConvertFromClaimsAsync ( IKeycloakParameters parameters, IEnumerable claims ) : Task
parameters	IKeycloakParameters
claims	IEnumerable
return	Task

ConvertFromClaimsIdentityAsync() public static method

Converts a keycloak-generated claims identity into a Keycloak identity

public static ConvertFromClaimsIdentityAsync ( IKeycloakParameters parameters, ClaimsIdentity identity ) : Task
parameters	IKeycloakParameters
identity	System.Security.Claims.ClaimsIdentity
return	Task

ConvertFromJwtAsync() public static method

Converts a set of JWTs into a Keycloak identity

public static ConvertFromJwtAsync ( IKeycloakParameters parameters, string accessToken, string refreshToken = null, string idToken = null ) : Task
parameters	IKeycloakParameters
accessToken	string
refreshToken	string
idToken	string
return	Task

ConvertFromTokenResponseAsync() public static method

Converts a JWT token-response endpoint message into a Keycloak identity

public static ConvertFromTokenResponseAsync ( IKeycloakParameters parameters, TokenResponse message ) : Task
parameters	IKeycloakParameters
message	TokenResponse
return	Task

CopyFromJwt() protected method

protected CopyFromJwt ( string accessToken, string refreshToken = null, string idToken = null ) : Task
accessToken	string
refreshToken	string
idToken	string
return	Task

GenerateJwtClaims() protected method

protected GenerateJwtClaims ( JwtSecurityToken accessToken, JwtSecurityToken idToken, JwtSecurityToken refreshToken ) : IEnumerable
accessToken	JwtSecurityToken
idToken	JwtSecurityToken
refreshToken	JwtSecurityToken
return	IEnumerable

GenerateLoginCallbackUriAsync() public static method

Generates the local URL on which to accept OIDC callbacks from Keycloak

public static GenerateLoginCallbackUriAsync ( IKeycloakParameters parameters, Uri baseUri ) : Task
parameters	IKeycloakParameters
baseUri	Uri
return	Task

GenerateLoginUriAsync() public static method

Generates the OpenID Connect compliant Keycloak login URL

public static GenerateLoginUriAsync ( IKeycloakParameters parameters, Uri baseUri, string state = null ) : Task
parameters	IKeycloakParameters
baseUri	Uri
state	string
return	Task

GenerateLogoutUriAsync() public static method

Generates the OpenID Connect compliant Keycloak logout URL

public static GenerateLogoutUriAsync ( IKeycloakParameters parameters, Uri baseUri, string redirectUrl = null ) : Task
parameters	IKeycloakParameters
baseUri	Uri
redirectUrl	string
return	Task

GetUpdatedClaimsAsync() public method

Refreshes and returns the updated claims for the identity (refreshes only if necessary)

public GetUpdatedClaimsAsync ( ) : Task>
return	Task>

KeycloakIdentity() protected method

Load a new Keycloak-based identity from a claims identity

protected KeycloakIdentity ( IKeycloakParameters parameters ) : System
parameters	IKeycloakParameters
return	System

RefreshIdentity() protected method

protected RefreshIdentity ( string refreshToken ) : Task
refreshToken	string
return	Task

RefreshIdentityAsync() public method

Refreshes and re-authenticates the current identity from the Keycloak instance (only if necessary)

public RefreshIdentityAsync ( ) : Task
return	Task

ToClaimsIdentityAsync() public method

Returns a static base representation of the identity as a claims identity

public ToClaimsIdentityAsync ( ) : Task
return	Task

TryValidateParameters() public static method

Trys to validate an IKeycloakParameters object for completeness and correctness

public static TryValidateParameters ( IKeycloakParameters parameters ) : bool
parameters	IKeycloakParameters
return	bool

ValidateParameters() public static method

Validates an IKeycloakParameters object for completeness and correctness

public static ValidateParameters ( IKeycloakParameters parameters ) : void
parameters	IKeycloakParameters
return	void