> For the complete documentation index, see [llms.txt](https://help.santesuite.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.santesuite.org/developers/server-plugins/implementing-.net-features/service-definitions/role-provider.md).

# Role Provider

`IRoleProviderService` in assembly SanteDB.Core.Api version 3.0.1980.0

## Summary

Represents a service which is capableof retrieving roles

## Operations

| Operation            | Response/Return | Input/Parameter                                                                                                                                 | Description                        |
| -------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
| CreateRole           | void            | <p><em>String</em> <strong>roleName</strong><br><em>IPrincipal</em> <strong>principal</strong></p>                                              | Creates a role                     |
| AddUsersToRoles      | void            | <p><em>String\[]</em> <strong>users</strong><br><em>String\[]</em> <strong>roles</strong><br><em>IPrincipal</em> <strong>principal</strong></p> | Add users to roles                 |
| RemoveUsersFromRoles | void            | <p><em>String\[]</em> <strong>users</strong><br><em>String\[]</em> <strong>roles</strong><br><em>IPrincipal</em> <strong>principal</strong></p> | Remove users from specified roles  |
| FindUsersInRole      | String\[]       | *String* **role**                                                                                                                               | Find all users in a specified role |
| GetAllRoles          | String\[]       | *none*                                                                                                                                          | Get all roles                      |
| GetAllRoles          | String\[]       | *String* **userName**                                                                                                                           | Get all roles                      |
| IsUserInRole         | Boolean         | <p><em>String</em> <strong>userName</strong><br><em>String</em> <strong>roleName</strong></p>                                                   | User user in the specified role    |

## Implementations

### BridgedRoleProvider - (SanteDB.Client)

The bridged role provider is the preferred service for the role provider and is just a wrapper for [ILocalServiceProvider\`1](http://santesuite.org/assets/doc/net/html/T_SanteDB_Core_Services_ILocalServiceProvider_1.htm) for the dCDR

#### Service Registration

```markup
...
<section xsi:type="ApplicationServiceContextConfigurationSection" threadPoolSize="4">
	<serviceProviders>
		...
		<add type="SanteDB.Client.Upstream.Security.BridgedRoleProvider, SanteDB.Client, Version=3.0.1980.0, Culture=neutral, PublicKeyToken=null" />
		...
	</serviceProviders>
```

### UpstreamRoleProviderService - (SanteDB.Client)

A [IRoleProviderService](http://santesuite.org/assets/doc/net/html/T_SanteDB_Core_Security_Services_IRoleProviderService.htm) which manages upstream roles

#### Service Registration

```markup
...
<section xsi:type="ApplicationServiceContextConfigurationSection" threadPoolSize="4">
	<serviceProviders>
		...
		<add type="SanteDB.Client.Upstream.Security.UpstreamRoleProviderService, SanteDB.Client, Version=3.0.1980.0, Culture=neutral, PublicKeyToken=null" />
		...
	</serviceProviders>
```

### AdoRoleProvider - (SanteDB.Persistence.Data)

A role provider which uses the ADO.NET classes

#### Service Registration

```markup
...
<section xsi:type="ApplicationServiceContextConfigurationSection" threadPoolSize="4">
	<serviceProviders>
		...
		<add type="SanteDB.Persistence.Data.Services.AdoRoleProvider, SanteDB.Persistence.Data, Version=3.0.1980.0, Culture=neutral, PublicKeyToken=null" />
		...
	</serviceProviders>
```

## Example Implementation

```csharp
/// Example Implementation
using SanteDB.Core.Security.Services;
/// Other usings here
public class MyRoleProviderService : SanteDB.Core.Security.Services.IRoleProviderService { 
	public String ServiceName => "My own IRoleProviderService service";
	/// <summary>
	/// Creates a role
	/// </summary>
	public void CreateRole(String roleName,IPrincipal principal){
		throw new System.NotImplementedException();
	}
	/// <summary>
	/// Add users to roles
	/// </summary>
	public void AddUsersToRoles(String[] users,String[] roles,IPrincipal principal){
		throw new System.NotImplementedException();
	}
	/// <summary>
	/// Remove users from specified roles
	/// </summary>
	public void RemoveUsersFromRoles(String[] users,String[] roles,IPrincipal principal){
		throw new System.NotImplementedException();
	}
	/// <summary>
	/// Find all users in a specified role
	/// </summary>
	public String[] FindUsersInRole(String role){
		throw new System.NotImplementedException();
	}
	/// <summary>
	/// Get all roles
	/// </summary>
	public String[] GetAllRoles(){
		throw new System.NotImplementedException();
	}
	/// <summary>
	/// Get all roles
	/// </summary>
	public String[] GetAllRoles(String userName){
		throw new System.NotImplementedException();
	}
	/// <summary>
	/// User user in the specified role
	/// </summary>
	public Boolean IsUserInRole(String userName,String roleName){
		throw new System.NotImplementedException();
	}
}
```

## References

* [IRoleProviderService C# Documentation](http://santesuite.org/assets/doc/net/html/T_SanteDB_Core_Security_Services_IRoleProviderService.htm)
* [BridgedRoleProvider C# Documentation](http://santesuite.org/assets/doc/net/html/T_SanteDB_Client_Upstream_Security_BridgedRoleProvider.htm)
* [UpstreamRoleProviderService C# Documentation](http://santesuite.org/assets/doc/net/html/T_SanteDB_Client_Upstream_Security_UpstreamRoleProviderService.htm)
* [AdoRoleProvider C# Documentation](http://santesuite.org/assets/doc/net/html/T_SanteDB_Persistence_Data_Services_AdoRoleProvider.htm)