Show / Hide Table of Contents

Interface IPrincipalService

Base principal security interface.

Namespace: Microsoft.GNS.Roster.Service
Assembly: Microsoft.GNS.Roster.Service.dll
Syntax
public interface IPrincipalService

Methods

View Source

GetPrincipalOrDeletedAsync(Guid, String)

Gets a security principal.

Declaration
Task<IRosterPrincipal> GetPrincipalOrDeletedAsync(Guid principalId, string principalContainer)
Parameters
Type Name Description
Guid principalId

The unique principal identifier.

System.String principalContainer

The principal container.

Returns
Type Description
Task<IRosterPrincipal>

Returns a principal as an .

View Source

GetPrincipalOrEmptyAsync(Guid, String, Boolean)

Gets a security principal.

Declaration
Task<IRosterPrincipal> GetPrincipalOrEmptyAsync(Guid principalId, string principalContainer, bool throwIfNotFound = false)
Parameters
Type Name Description
Guid principalId

The unique principal identifier.

System.String principalContainer

The principal container.

System.Boolean throwIfNotFound

If true throws an EntityNotFoundException if the principal does not exist. If false will return type equivalent.

Returns
Type Description
Task<IRosterPrincipal>

Returns a principal as an .

View Source

GetPrincipalOrEmptyAsync(String, String, Scope, Boolean)

Gets a security principal.

Declaration
Task<IRosterPrincipal> GetPrincipalOrEmptyAsync(string principalName, string principalContainer, Scope principalScope, bool throwIfNotFound = false)
Parameters
Type Name Description
System.String principalName

The unique principal name.

System.String principalContainer

The principal container.

Scope principalScope

The principal scope.

System.Boolean throwIfNotFound

If true throws an EntityNotFoundException if the principal does not exist. If false will return type equivalent.

Returns
Type Description
Task<IRosterPrincipal>

Returns a principal as an .

  • View Source
In This Article
Back to top Generated by DocFX