Structs, Types, ...

Collaboration diagram for Structs, Types, ...:

Typedefs
typedef struct MlpiUserInfo	MlpiUserInfo
typedef struct MlpiAccessControlExpirationDetails	MlpiAccessControlExpirationDetails
typedef struct MlpiUserDetails	MlpiUserDetails
typedef struct MlpiPasswordPolicies	MlpiPasswordPolicies
typedef struct MlpiUserPolicies	MlpiUserPolicies
typedef struct MlpiGroupInfo	MlpiGroupInfo
typedef struct MlpiGroupPolicies	MlpiGroupPolicies
typedef struct MlpiGroupDetails	MlpiGroupDetails

Enumerations

Detailed Description

List of used types, enumerations, structures and more.

Typedef Documentation

MlpiUserInfo

This structure provides all basic information about a specific user.

Elements of struct MlpiUserInfo

Type	Element	Description
ULONG	userId	User's unique identification number.
WCHAR16	username	Name of the user employed for Login (i.e. login name).
WCHAR16	description	Description of the user account.
MlpiUserPersistenceType	persistenceType	Type of lifetime: temporary (only valid for a session) or permanent.
BOOL8	disabled	If true, the user authentication fails.

MlpiAccessControlExpirationDetails

This structure provides information about the expiration settings applied to sessions and passwords.

Elements of struct MlpiAccessControlExpirationDetails

Type	Element	Description
BOOL8	enabled	Indicates if the object expiration is enabled.
ULONG	expirationTime	Time after the creation of the object, at which the object will expire.
MlpiAccessControlExpirationTimeUnit	expirationTimeUnit	Unit of expiration time (i.e. days or minutes).

MlpiUserDetails

This structure provides all detailed information about a specific user.

Elements of struct MlpiUserDetails

Type	Element	Description
ULONG	userId	User's unique identification number.
WCHAR16	username	Name of the user employed for Login (i.e. Username).
WCHAR16	description	Description of the user account.
BOOL8	disabled	If true, the user is disabled and the authentication will fail.
BOOL8	userExpirationEnabled	Indicates if the user is to be disabled automatically at a specific date.
MlpiDateAndTime	userExpirationTime	Date in which the user will be disabled if autoDisableEnabled is true.
MlpiAccessControlExpirationDetails	sessionExpiration	Information regarding a user's session expiration.
MlpiUserPersistenceType	persistenceType	Type of lifetime: temporary (only valid for a session) or permanent.

MlpiPasswordPolicies

This structure contains the policies to be followed to define the user passwords, such as password length boundaries and minimum amount of specific-type characters.

Elements of struct MlpiPasswordPolicies

Type	Element	Description
ULONG	minLength	Minimum length that a password shall contain.
ULONG	maxLength	Maximum length that a password shall contain.
ULONG	minUpperCase	Minimum amount of upper case characters that a password shall contain.
ULONG	minLower	Minimum amount of lower case characters that a password shall contain.
ULONG	minNumerical	Minimum amount of numerical characters that a password shall contain.
ULONG	minSpecial	Minimum amount of special characters (e.g. #, $, etc.) that a password shall contain.

MlpiUserPolicies

This structure contains the policies to be followed by a user.

Elements of struct MlpiUserPolicies

Type	Element	Description
ULONG	usernameMinLength	Minimum length that a Username shall contain.
ULONG	usernameMaxLength	Maximum length that a Username shall contain.
ULONG	usernameInvalidChars	Contains the characters that are not allowed to be used on the username.
ULONG	descriptionMinLength	Minimum length that a user description shall contain.
ULONG	descriptionMaxLength	Maximum length that a user description shall contain.
MlpiAccessControlExpirationDetails	sessionExpirationSettings	Global session expiration settings

MlpiGroupInfo

This structure provides all basic information about a specific group.

Elements of struct MlpiGroupInfo

Type	Element	Description
ULONG	groupId	Group's unique identification number.
WCHAR16	groupName	Name of the group.
WCHAR16	description	Description of the group.
BOOL8	disabled	If true, the permissions assigned to the group are no longer valid for the group members.

MlpiGroupPolicies

This structure contains the policies to be followed by a group.

Elements of struct MlpiGroupPolicies

Type	Element	Description
ULONG	groupNameMinLength	Minimum group name length.
ULONG	groupNameMaxLength	Maximum group name length.
WCHAR16	groupNameInvalidChars	Contains the characters that are not allowed in a group name.
ULONG	descriptionMinLength	Minimum length of the group description.
ULONG	descriptionMaxLength	Maximum length of the group description.

MlpiGroupDetails

This structure provides all detailed information about a specific group.

Elements of struct MlpiGroupDetails

Type	Element	Description
ULONG	groupId	Group's unique identification number..
WCHAR16	groupName	Name of the group
WCHAR16	description	Description of the group.
BOOL8	disabled	If true, the permissions assigned to the group are no longer valid for the group members.

Enumeration Type Documentation

enum MlpiUserPersistenceType

This enumeration describes the possible persistence type of a user, whether it a temp or remanent user.

Enumerator
MLPI_USER_PERSISTENCE_TYPE_TEMPORARY	The user is only available temporarily.
MLPI_USER_PERSISTENCE_TYPE_PERMANENT	The user is available permanently until specified otherwise.

Definition at line 233 of file mlpiAccessControlLib.h.

enum MlpiAccessControlExpirationTimeUnit

This enumeration describes the possible units that the expiration time can have (i.e. days or minutes).

Enumerator
MLPI_ACCESSCONTROL_EXPIRATION_UNIT_MINUTES	Unit of expiration time is in minutes.
MLPI_ACCESSCONTROL_EXPIRATION_UNIT_DAYS	Unit of expiration time is in days.

Definition at line 241 of file mlpiAccessControlLib.h.