Interface ISynchronizedUsersRepository
Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Repository for synchronized users
Namespace: EPiServer.Security.Internal
Assembly: EPiServer.dll
Version: 11.20.7Syntax
public interface ISynchronizedUsersRepositoryProperties
DefaultSynchronizedClaims
Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. The default synchronized claims, which are Email, GivenName, Surname and role claims
Declaration
IEnumerable<string> DefaultSynchronizedClaims { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.String> |
Methods
ClearRoles(String)
Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Clears all synchronized roles for a user
Declaration
void ClearRoles(string username)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | The user to clear roles for |
FindRoles(String)
Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Find all roles that matches the specified string
Declaration
IEnumerable<string> FindRoles(string partOfName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | partOfName | A string to match roles against |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.String> | A list of matched roles |
FindUsers(String)
Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Find all users that matches the specified string
Declaration
IEnumerable<string> FindUsers(string partOfName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | partOfName | A string to match user against |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.String> | A list of matched users |
FindUsersInRole(String, String)
Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Finds all synchronized users that is part of role
Declaration
IEnumerable<string> FindUsersInRole(string roleName, string partOfUsername)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | roleName | The role name |
| System.String | partOfUsername | Part of the user name to match, if any |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.String> | A list of matched users |
GetRolesForUser(String)
Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets all synchronized roles for a user
Declaration
IEnumerable<string> GetRolesForUser(string username)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | The user to get roles for |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.String> | A list of roles |
HideRole(String)
Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. A synched role can be hidden, meaning it will not be returned from FindRoles.
Declaration
void HideRole(string role)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | role | The role to hide |
ListRoleStatus()
Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. List statuses for all synchronized roles
Declaration
IEnumerable<SynchronizedRoleStatus> ListRoleStatus()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<SynchronizedRoleStatus> | A list of statuses for all roles |
ShowRole(String)
Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Call to show a previously hidden role in FindRoles.
Declaration
void ShowRole(string role)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | role | The role that should shown. |
Synchronize(String, String, IEnumerable<Claim>)
Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Synchronizes an user and claims
Declaration
void Synchronize(string username, string roleClaimType, IEnumerable<Claim> claims)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | The user to synchronize |
| System.String | roleClaimType | The roleClaimType used to identify role claims |
| System.Collections.Generic.IEnumerable<System.Security.Claims.Claim> | claims | The claims to synchronize |
SynchronizeAsync(String, String, IEnumerable<Claim>)
Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Synchronizes an user and claims asynchronusly
Declaration
Task SynchronizeAsync(string username, string roleClaimType, IEnumerable<Claim> claims)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | The user to synchronize |
| System.String | roleClaimType | The roleClaimType used to identify role claims |
| System.Collections.Generic.IEnumerable<System.Security.Claims.Claim> | claims | The claims to synchronize |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
