Class AuthContext (2.63.0)

public class AuthContext

Authentication context for a call. AuthContext is the only reliable source of truth when it comes to authenticating calls. Using any other call/context properties for authentication purposes is wrong and inherently unsafe. Note: experimental API that can change or be removed without any prior notice.

Inheritance

object > AuthContext

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace

Grpc.Core

Assembly

Grpc.Core.Api.dll

Constructors

AuthContext(string?, Dictionary<string, List<AuthProperty>>)

public AuthContext(string? peerIdentityPropertyName, Dictionary<string, List<AuthProperty>> properties)

Initializes a new instance of the AuthContext class.

Parameters
Name	Description
`peerIdentityPropertyName`	`string` Peer identity property name.
`properties`	`DictionarystringListAuthProperty` Multimap of auth properties by name.

Properties

IsPeerAuthenticated

public bool IsPeerAuthenticated { get; }

Returns true if the peer is authenticated.

Property Value
Type	Description
`bool`

PeerIdentity

public IEnumerable<AuthProperty> PeerIdentity { get; }

Gets properties that represent the peer identity (there can be more than one). Returns an empty collection if the peer is not authenticated.

Property Value
Type	Description
`IEnumerableAuthProperty`

PeerIdentityPropertyName

public string? PeerIdentityPropertyName { get; }

Gets the name of the property that indicates the peer identity. Returns null if the peer is not authenticated.

Property Value
Type	Description
`string`

Properties

public IEnumerable<AuthProperty> Properties { get; }

Gets the auth properties of this context.

Property Value
Type	Description
`IEnumerableAuthProperty`

Methods

FindPropertiesByName(string)

public IEnumerable<AuthProperty> FindPropertiesByName(string propertyName)

Returns the auth properties with given name (there can be more than one). If no properties of given name exist, an empty collection will be returned.

Parameter
Name	Description
`propertyName`	`string`

Returns
Type	Description
`IEnumerableAuthProperty`