Interface IPrincipalSecurityContext
Functionality for working with Roster security.
Namespace: Microsoft.XboxStudios.SQTech.Roster.Client
Assembly: Microsoft.XboxStudios.SQTech.Roster.Client.Common.dll
Syntax
public interface IPrincipalSecurityContext
Methods
View SourceUserInRoleAsync(string, CancellationToken)
Checks if a user is in a Roster role.
Declaration
Task<bool> UserInRoleAsync(string roleName, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | roleName | The role in which to check membership. |
| CancellationToken | cancellationToken | A cancellation token. |
Returns
| Type | Description |
|---|---|
| Task<bool> | True if the user is a member. Otherwise, false. |
UserInSecurityGroupAsync(string, CancellationToken)
Checks if the current user is in an Active Directory security group.
Declaration
Task<bool> UserInSecurityGroupAsync(string securityGroupName, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | securityGroupName | The Active Directory security group in which to check membership. |
| CancellationToken | cancellationToken | A cancellation token. |
Returns
| Type | Description |
|---|---|
| Task<bool> | True if the user is a member. Otherwise, false. |