user.h

Go to the documentation of this file.

/*==============================================================================
                Copyright (c) 2003-2005 UGS Corporation
                   Unpublished - All Rights Reserved
 ==============================================================================*/

/*  */

#ifndef USER_H
#define USER_H

#include <sa/sa.h>
#include <sa/libsa_exports.h>
#include <unidefs.h>

typedef struct SA_user_profile_props_s {
    char*  prop_name;        
    int    n_values;         
    char** values;           
} SA_user_profile_props_t;

#ifdef __cplusplus
     extern "C"{
#endif


extern SA_API int SA_extent_user(
    int*          nusers,       
    tag_t**       user_tags     
    );

extern SA_API int SA_extent_active_user(
    int*          num_users,    
    tag_t**       user_tags     
    );

extern SA_API int SA_initialize_user(
    tag_t         userTag,                          
    const char    userid[SA_user_size_c + 1],       
    const char    personname[SA_person_name_size_c + 1],   
    const char    password[SA_password_size_c + 1]  
    );

extern SA_API int SA_initialize_user2(
    tag_t         userTag,                          
    const char    *userid,                          
    const char    *personname,                      
    const char    *password                         
    );

extern SA_API int SA_create_user(
    const char    userid[SA_user_size_c + 1],           
    const char    personname[SA_person_name_size_c + 1],       
    const char    password[SA_password_size_c + 1],     
    tag_t*        user_tag                              
    );

extern SA_API int SA_create_user2(
    const char    *userid,                              
    const char    *personname,                          
    const char    *password,                            
    tag_t*        user_tag                              
    );

extern SA_API int SA_create_licensed_user(
    const char    userid[SA_user_size_c + 1],                
    const char    personname[SA_person_name_size_c + 1],     
    const char    password[SA_password_size_c + 1],          
    int           licenseLevel,                              
    int           userStatus,                                
    tag_t*        user_tag                                   
    );

extern SA_API int SA_create_licensed_user2(
    const char    *userid,                                   
    const char    *personname,                               
    const char    *password,                                 
    int           licenseLevel,                              
    int           userStatus,                                
    tag_t*        user_tag                                   
    );

extern SA_API int SA_create_licensed_user3(
    const char    *user_id,                                  
    const char    *person_name,                              
    const char    *password,                                 
    int           license_level,                             
    const char    *license_bundle,                           
    int           user_status,                               
    tag_t*        user_tag                                   
    );

extern SA_API int SA_set_user_identifier(
    tag_t         user_tag,                     
    const char    userid[SA_user_size_c + 1]    
    );

extern SA_API int SA_set_user_identifier2(
    tag_t         user_tag,                     
    const char    *userid                       
    );

extern SA_API int SA_set_user_person(
    tag_t         user_tag,     
    tag_t         person_tag    
    );

extern SA_API int SA_change_user_password(
    tag_t         user_tag,                             
    const char    newpassword[SA_password_size_c + 1],  
    const char    oldpassword[SA_password_size_c + 1]   
    );

extern SA_API int SA_change_user_password2(
    tag_t         user_tag,                             
    const char    *newpassword,                         
    const char    *oldpassword                          
    );

extern SA_API int SA_set_user_login_group(
    tag_t         user_tag,     
    tag_t         group_tag     
    );

extern SA_API int SA_set_user_default_volume(
    tag_t         user_tag,                                 
    const char    volume_name[SA_volume_name_size_c + 1]    
    );

extern SA_API int SA_set_user_default_volume2(
    tag_t         user_tag,                                 
    const char    *volume_name                              
    );

extern SA_API int SA_set_user_default_local_volume(
    tag_t         user_tag,                                 
    const char    volume_name[SA_volume_name_size_c + 1]    
    );

extern SA_API int SA_set_user_default_local_volume2(
    tag_t         user_tag,                                 
    const char    *volume_name                              
    );

extern SA_API int SA_find_user(
    const char    userid[SA_user_size_c + 1],   
    tag_t*        user_tag                      
    );

extern SA_API int SA_find_user2(
    const char    *userid,                      
    tag_t*        user_tag                      
    );

extern SA_API int SA_ask_user_identifier(
    tag_t         user_tag,                     
    char          userid[SA_user_size_c + 1]    
    );

extern SA_API int SA_ask_user_identifier2(
    tag_t         user_tag,                     
    char          **userid                      
    );

extern SA_API int SA_ask_user_person_name(
    tag_t         user_tag,                         
    char          personname[SA_person_name_size_c + 1]    
    );

extern SA_API int SA_ask_user_person_name2(
    tag_t         user_tag,                         
    char          **personname                      
    );

extern SA_API int SA_ask_user_person(
    tag_t         user_tag,     
    tag_t*        person_tag    
    );

extern SA_API int SA_ask_user_home_folder(
    tag_t         user_tag,     
    tag_t*        folder_tag    
    );

extern SA_API int SA_ask_user_mailbox(
    tag_t         user_tag,     
    tag_t*        folder_tag    
    );

extern SA_API int SA_ask_user_newstuff_folder(
    tag_t         user_tag,     
    tag_t*        folder_tag    
    );

extern SA_API int SA_ask_user_login_group(
    tag_t         user_tag,     
    tag_t*        group_tag     
    );

extern SA_API int SA_ask_user_default_volume(
    tag_t         user_tag,                                 
    char          volume_name[SA_volume_name_size_c + 1]    
    );

extern SA_API int SA_ask_user_default_volume2(
    tag_t         user_tag,                                 
    char          **volume_name                             
    );

extern SA_API int SA_ask_user_default_local_volume(
    tag_t         user_tag,                                 
    char          volume_name[SA_volume_name_size_c + 1]    
    );

extern SA_API int SA_ask_user_default_local_volume2(
    tag_t         user_tag,                                 
    char          **volume_name                             
    );

extern SA_API int SA_find_user_objects(
    tag_t         user_tag,         
    int*          num_of_objects,   
    tag_t**       object_tags       
    );

extern SA_API int SA_delete_user_objects(
    tag_t         user_tag      
    );

extern SA_API int SA_delete_user(
    tag_t         user_tag,             
    tag_t         new_owning_user,      
    tag_t         new_owning_group,     
    logical       delete_objects        
    );


extern SA_API int SA_set_user_ip_clearance(
        tag_t userTag,                 
        const char * ip_clearance      
        );

extern SA_API int SA_ask_user_ip_clearance(
        tag_t userTag,                                 
        char ip_clearance[SA_ip_clearance_size_c + 1]  
        );

extern SA_API int SA_ask_user_ip_clearance2(
        tag_t userTag,                                 
        char **ip_clearance                            
        );

extern SA_API int SA_set_user_gov_clearance(
        tag_t userTag,                 
        const char * gov_clearance      
        );

extern SA_API int SA_ask_user_gov_clearance(
        tag_t userTag,                                 
        char gov_clearance[SA_gov_clearance_size_c + 1]  
        );

extern SA_API int SA_ask_user_gov_clearance2(
        tag_t userTag,                                 
        char **gov_clearance                           
        );

extern SA_API int SA_set_user_geography(
        tag_t userTag,                
        const char * geography        
        );

extern SA_API int SA_ask_user_geography(
        tag_t userTag,                               
        char geography[SA_geography_size_c + 1]      
        );

extern SA_API int SA_ask_user_geography2(
        tag_t userTag,                               
        char **geography                             
        );

extern SA_API int SA_set_user_nationality(
        tag_t userTag,                
        const char * nationality      
        );

extern SA_API int SA_ask_user_nationality(
        tag_t userTag,                               
        char nationality[SA_nationality_size_c + 1]  
        );

extern SA_API int SA_ask_user_nationality2(
        tag_t userTag,                               
        char **nationality                           
        );

extern SA_API int SA_set_user_ttc_date(
        tag_t userTag,                
        date_t ttc_date               
        );

extern SA_API int SA_ask_user_ttc_date(
        tag_t userTag,                
        date_t *ttc_date              
        );

extern SA_API int SA_set_os_user_name(
    tag_t         userTag,                          
    char          osUserName[SA_name_size_c + 1]    
    );

extern SA_API int SA_set_os_user_name2(
    tag_t         userTag,                          
    const char    *osUserName                       
    );

extern SA_API int SA_ask_os_user_name(
    tag_t         userTag,                          
    char          osUserName[SA_name_size_c + 1]    
    );

extern SA_API int SA_ask_os_user_name2(
     tag_t         userTag,                          
     char          **osUserName                      
     );

extern SA_API int SA_get_mapped_user_attr_list(
    int*     numberOfAttributes,   
    char***  list                  );
extern SA_API int SA_get_user_status(
    const tag_t   user_tag,                      
    int           *status                        
    );
extern SA_API int SA_set_user_status(
    const tag_t   user_tag,                      
    int           newStatus                      
    );
extern SA_API int SA_set_user_last_sync_date(
    const tag_t   user_tag,                      
    date_t        syncDate                       
    );
extern SA_API int SA_get_user_last_sync_date(
    const tag_t   user_tag,                      
    date_t        *syncDate                      
    );
extern SA_API int SA_set_user_data_source(
    const tag_t   user_tag,                      
    int           dataSource                     
    );
extern SA_API int SA_get_user_data_source(
    const tag_t   user_tag,                      
    int           *dataSource                    
    );

extern SA_API int SA_set_user_citizenships(
    tag_t user_tag,               
    int num,                     
    const char** citizenships    
    );

extern SA_API int SA_ask_user_citizenships(
    tag_t user_tag,        
    int *num,             
    char*** citizenships  
    );

extern SA_API int SA_set_user_license_status(
    tag_t  user_tag,             
    int    user_status,          
    int    license_level,        
    const char *license_bundle,  
    int    *purchased,           
    int    *used,                
    int    *purchased_bundles,   
    int    *used_bundles         
    );

extern SA_API int SA_set_user_profile_attributes(
    tag_t                          user,                        
    int                            n_profile_props,             
    const SA_user_profile_props_t  *profile_props               
    );

extern SA_API int SA_ask_user_sponsorability(
    tag_t      user,                       
    int*       sponsorable                 
    );

extern SA_API int SA_set_user_sponsorability(
    tag_t     user,                       
    int       sponsorable                 
    );

#ifdef __cplusplus
}
#endif

#include <sa/libsa_undef.h>

#endif