Joutsen.AuthenticationService.Roles Class Reference

A clss that provides the Roles used by the AuthenticationService. More...

Static Public Attributes
const String	ADMIN = "Admin"
	The administrator role for the service or applications. More...
const String	USER = "User"
	A minimal role for applications. More...
const String	USER_DESCRIPTION = "A minimal role for applications defined by the system."
	The description text for the User role. More...
const String	NEIGHBOUR = "Neighbour"
	A role that allows searching for other users. More...
const String	USER_ACTIVATION = "UserActivation"
	A special role that should not be added to users but is only used in tokens to allow users to activate their account. More...
const String	USER_ACTIVATION_DESCRIPTION = "A system role without any rights that is used to allow users to activate their account."
	The description text for the UserActivation role. More...

Detailed Description

A clss that provides the Roles used by the AuthenticationService.

Since

0.2.0

Member Data Documentation

ADMIN

const String Joutsen.AuthenticationService.Roles.ADMIN = "Admin"

static

The administrator role for the service or applications.

Remarks

The Admin role for the AuthenticationService allows full access to all available api endpoints and the AuthenticationControl command line tool. This allows CRUD operations on all masterdata. For applications authenticated by the AuthenticationService the Admin role allows the management of masterdata for the application. This includes adding and listing users and adding and deleting roles but limited to the application where the user has this role.

NEIGHBOUR

const String Joutsen.AuthenticationService.Roles.NEIGHBOUR = "Neighbour"

static

A role that allows searching for other users.

Remarks

The Neighbour role only allows users of an application to list the other users of the same application. This can be useful to implement e.g. sharing or communication between users. Applications need to define which additional rights they offer users with this role.

USER

const String Joutsen.AuthenticationService.Roles.USER = "User"

static

A minimal role for applications.

Remarks

The user role simply adds user to an application but comes without any rights for the AuthenticationService. Applications need to define which rights they offer users with this role.

USER_ACTIVATION

const String Joutsen.AuthenticationService.Roles.USER_ACTIVATION = "UserActivation"

static

A special role that should not be added to users but is only used in tokens to allow users to activate their account.

Remarks

The UserActivation role should never be added to a user. It is a pseudo role that allows users to activate their accounts. While it should not cause any problems applications should avoid using a role calleduserActivation.

USER_ACTIVATION_DESCRIPTION

const String Joutsen.AuthenticationService.Roles.USER_ACTIVATION_DESCRIPTION = "A system role without any rights that is used to allow users to activate their account."

static

The description text for the UserActivation role.

USER_DESCRIPTION

const String Joutsen.AuthenticationService.Roles.USER_DESCRIPTION = "A minimal role for applications defined by the system."

static

The description text for the User role.