UserDetails Struct Reference

A datatype to store user credentials. More...

#include <user_details.h>

Collaboration diagram for UserDetails:
[legend]

Public Member Functions

UserDetailsAllocateUserDetails (const json_t *credentials_p)
 Allocate a UserDetails with the given username. More...
 
void FreeUserDetails (UserDetails *user_details_p)
 Free a UserDetails. More...
 

Data Fields

LinkedListud_auth_list_p
 A LinkedList of UserAuthenticationNodes. More...
 

Detailed Description

A datatype to store user credentials.

Examples
long_running_service.c.

Member Function Documentation

◆ AllocateUserDetails()

UserDetails * AllocateUserDetails ( const json_t *  credentials_p)

Allocate a UserDetails with the given username.

Parameters
credentials_pThe credentials to get the details of a user's authorisations for various systems. This can be NULL.
Returns
A newly-allocated UserDetails or NULL upon error.

◆ FreeUserDetails()

void FreeUserDetails ( UserDetails user_details_p)

Free a UserDetails.

Parameters
user_details_pThe UserDetails to free.

Field Documentation

◆ ud_auth_list_p

LinkedList* ud_auth_list_p

A LinkedList of UserAuthenticationNodes.


The documentation for this struct was generated from the following file: