GDCredentialsProfile.h File Reference

#include "GDCommon.h"

Classes
struct	GDCredentialsProfile
	User Credential profile. More...
struct	GDCredentialsProfileEvent
	User Credential profile event. More...

Enumerations
enum	GDCredentialsProfileState {   GDCredentialsProfileStateImportDue,   GDCredentialsProfileStateImportNow,   GDCredentialsProfileStateImported,   GDCredentialsProfileStateModified,   GDCredentialsProfileStateRenewalDue,   GDCredentialsProfileStateDeleted }
	User Credential profile states. More...
enum	GDCredentialsProfileType {   GDCredentialsProfileTypeUnknown,   GDCredentialsProfileTypeAppbased,   GDCredentialsProfileTypeDeviceKeystore,   GDCredentialsProfileTypeUserCertificate,   GDCredentialsProfileTypeAssistedSCEP,   GDCredentialsProfileTypeEntrust,   GDCredentialsProfileTypePKIConnector }
	User Credential profile type. More...

Functions
GDCredentialsProfileType	GDCredentialsProfile_type (const char *profileId)
	Return the profile type. More...
typedef void(*	GDCredentialsProfileEventCb) (const struct GDCredentialsProfileEvent event, void *appData)
	Type for User Credential profile callback implementation. More...
void	GDCredentialsProfile_register (GDCredentialsProfileEventCb cb, void *appData)
	Register for notification of User Credential profile state changes. More...
void	GDCredentialsProfile_register_type (GDCredentialsProfileType type, GDCredentialsProfileEventCb cb, void *appData)
	Register User Credential profile. More...
bool	GDCredentialsProfile_is_type_registered (GDCredentialsProfileType type)
	Check if registered for a User Credential profile type. More...
bool	GDCredentialsProfile_list (size_t *profileCount, struct GDCredentialsProfile **profiles, struct GDError *error)
	List User Credential profiles. More...
int	GDCredentialsProfile_days_until_expiry (const char *profileId)
	Days until the next credential expires. More...
int	GDCredentialsProfile_days_until_renewal_due (const char *profileId)
	Days until the next credential is due to be renewed. More...
void	GDCredentialsProfile_begin_enrolment (const char *profileId)
	Begin enrolment for a User Credential profile. More...
void	GDCredentialsProfile_begin_enrolment_type (GDCredentialsProfileType type)
	Begin enrolment for all User Credential profiles of the same type. More...
bool	GDCredentialsProfile_can_reset_type (GDCredentialsProfileType type)
	Determine whether a User Credential profile of a specific type can be reset. More...
void	GDCredentialsProfile_reset_type (GDCredentialsProfileType type)
	Reset all the User Credential profiles of the same type. More...
void	GDCredentialsProfile_free (struct GDCredentialsProfile *profiles, size_t profileCount)
	Free a returned profiles buffer. More...
void	GDCredentialsProfile_unregister (void)
	Unregister from notification of app-based User Credential profile state changes. More...
void	GDCredentialsProfile_unregister_type (GDCredentialsProfileType type)
	Unregister from notification of User Credential profile state changes. More...

Enumeration Type Documentation

GDCredentialsProfileType

enum GDCredentialsProfileType

Values in this enumeration represent the possible kinds of User Credential profiles (UCPs).

Enumerator
GDCredentialsProfileTypeUnknown	Unkown User Credential profile type.
GDCredentialsProfileTypeAppbased	App-based User Credential profile.
GDCredentialsProfileTypeDeviceKeystore	Device User Credential profile. Device-based User Credential profile, otherwise known as a User Credential profile with a Native Keystore connector
GDCredentialsProfileTypeUserCertificate	User Certificate profile. User Certificate profile otherwise known as Manual Upload that allows users to upload (to UEM Server) password protected PKCS#12 files containing their credentials.
GDCredentialsProfileTypeAssistedSCEP	Assisted SCEP User Credential profile.
GDCredentialsProfileTypeEntrust	Entrust User Credential profile.
GDCredentialsProfileTypePKIConnector	PKI Connector User Credential profile.

Function Documentation

GDCredentialsProfile_type()

GDCredentialsProfileType GDCredentialsProfile_type

(

const char *

profileId

)

Return the kind of User Credential profile (UCP).

Parameters

profileId

Null-terminated string containing the UCP ID.

Returns

GDCredentialsProfileType UCP type.