SAP ABAP Class CL_GRFN_UTIL_USER (API to query and retreive backend user)

Hierarchy

☛ GRCFND_A (Software Component) GRC Foundation ABAP
   ⤷ GRC (Application Component) Governance, Risk and Compliance
     ⤷ GRFN_UTILITIES (Package) Various helping infrastructure for GRC ABAP

Properties

Class	CL_GRFN_UTIL_USER
Short Description	API to query and retreive backend user
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	GRFN_UTILITIES	Various helping infrastructure for GRC ABAP
Created	20080514	SAP
Last change	20141106
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_GRFN_UTIL_USER has no interface implemented.

Friends

Class CL_GRFN_UTIL_USER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MT_ADDRESS_BUFFER	Static Attribute	Private	☐	See coding				20080702
2	MT_LOGONDATA_BUFFER	Static Attribute	Private	☐	See coding				20081027
3	MT_ROLE_USER_BUFFER	Static Attribute	Private	☐	See coding				20081002
4	MT_USER_LOCK_BUFFER	Static Attribute	Private	☐	See coding				20100128

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_AUTHORIZED_ENTITIES	Static method	Public	Method	Get all entities the user is authorized to display	20080729
2	GET_DELEGATION_AUTH	Static method	Public	Method	Get the delegation authorization for a user	20081013
3	GET_FULLNAME	Static method	Public	Method	Get full user name	20080514
4	GET_RISKS_FOR_USER	Static method	Private	Method		20080829
5	GET_USERS_FOR_GROUP	Static method	Public	Method	Get all the users assigned to the group	20091217
6	GET_VH_NO_INITIAL_SEARCH	Static method	Public	Method	Check if initial sarch should be executed for empty pattern	20130225
7	HAS_DELEGATION_EXISTED	Static method	Public	Method	Check if the deletation has existed	20100830
8	IS_DATAPART_AUTHORIZED	Static method	Public	Method	Check if given datapart is authorized for the entity	20081105
9	IS_DISPLAY_USER	Static method	Public	Method	Checks whether (current) user is display user	20080701
10	IS_GRC_USER	Static method	Public	Method	Checks whether (current) user is GRC user	20080701
11	IS_POST_USER	Static method	Public	Method	Checks whether (current) user is post user	20081126
12	IS_POWER_USER	Static method	Public	Method	Checks whether (current) user is power user	20080701
13	IS_USER_EXISTS_FOR_FF	Static method	Public	Method	Check user exists in local and remote systems	20111122
14	IS_VALID_USER	Static method	Public	Method	Checks whether the user id is valid	20090217
15	QUERY	Static method	Public	Method	Query for existing usernames	20080514
16	QUERY_ACTIVE_USERS	Static method	Public	Method	Get the active user list from usr02	20130625
17	QUERY_BY_ROLE	Static method	Public	Method	Query users with certain role assigned in su01	20080606
18	QUERY_BY_VALID_ROLE	Static method	Public	Method	Query users valid role assigned in su01	20120301
19	QUERY_CUP	Static method	Public	Method		20111215
20	QUERY_PC	Static method	Public	Method	Special Query for existing usernames with PC requirements	20081212
21	QUERY_USER_GROUPS	Static method	Public	Method	Query all existing SAP user groups	20091217
22	QUERY_USER_GROUPS_CNTRL_OWN	Static method	Public	Method	Query all existing SAP user groups	20120217
23	RETREIVE_USER_GROUPS_CN	Static method	Public	Method	Query all existing SAP user groups	20130628
24	RETRIEVE	Static method	Public	Method	Retrieve details for a certain user	20080514
25	UPDATE_MT_ADDRESS_BUFFER	Static method	Public	Method	Update the MT_ADDRESS_BUFFER for LDAP user data	20130604
26	USERDATA	Static method	Public	Method	Query for existing usernames	20110128

Events

Class CL_GRFN_UTIL_USER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	YS_ADDRESS_BUFFER	Private	See coding			20080702	BEGIN OF ys_address_buffer, username TYPE uname, address TYPE bapiaddr3, END OF ys_address_buffer
2	YS_ENTITY_DATAPART	Public	See coding			20080812	begin of ys_entity_datapart , entity type grfn_api_entity_id, datapart type grfn_datapart, end of ys_entity_datapart
3	YS_LOCKDATA_BUFFER	Private	See coding			20100128	BEGIN OF ys_lockdata_buffer, username TYPE uname, lockdata TYPE bapislockd, END OF ys_lockdata_buffer
4	YS_LOGONDATA_BUFFER	Private	See coding			20081027	BEGIN OF ys_logondata_buffer, username TYPE uname, logondata TYPE bapilogond, END OF ys_logondata_buffer
5	YS_ROLE_USER_BUFFER	Private	See coding			20081002	BEGIN OF ys_role_user_buffer, role TYPE agr_name, t_user TYPE spers_ulst, END OF ys_role_user_buffer

Method Signatures

Method GET_AUTHORIZED_ENTITIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20080729
2	Importing	IV_IGNORE_REG_RELEVANCE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100513
3	Importing	IV_NO_TEXT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100917
4	Importing	IV_REGULATION_ID	Call by reference	☑	Type reference (TYPE)	GRFN_API_OBJECT_ID		Regulation Type	20100504
5	Importing	IV_USER	Call by reference	☐	Type reference (TYPE)	UNAME	SY-UNAME	User Name	20080729
6	Returning	RT_ENTITY	Value transfer	☐	Type reference (TYPE)	GRFN_T_ENTITY		Table of entities	20080729

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20080729

Method GET_DELEGATION_AUTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CENTRAL_DELEGATION	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20081013
2	Exporting	EV_SELF_DELEGATION	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20081013
3	Importing	IV_USER	Call by reference	☐	Type reference (TYPE)	UNAME	SY-UNAME	User Name	20081013

Method GET_DELEGATION_AUTH on class CL_GRFN_UTIL_USER has no exception.

Method GET_FULLNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_USERNAME	Value transfer	☐	Type reference (TYPE)	UNAME		User Name	20080514
2	Returning	RV_FULLNAME	Value transfer	☐	Type reference (TYPE)	AD_NAMTEXT		Full Name of Person	20080514

Method GET_FULLNAME on class CL_GRFN_UTIL_USER has no exception.

Method GET_RISKS_FOR_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RISK_LIST	Call by reference	☐	Type reference (TYPE)	GRRM_T_API_RISK_LIST		Table Type of Risk list	20080829
2	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20080830
3	Importing	IV_ACTIVITY	Call by reference	☐	Type reference (TYPE)	ACTIV_AUTH		Activity	20080829
4	Importing	IV_USER	Call by reference	☐	Type reference (TYPE)	UNAME	SY-UNAME	USER TO CHECK FOR	20080829

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20080830

Method GET_USERS_FOR_GROUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SEARCH	Call by reference	☑	Type reference (TYPE)	GRFN_T_SEARCH_CRITERIA		API search pattern	20091217
2	Importing	IV_USERGROUP	Value transfer	☐	Type reference (TYPE)	XUCLASS		User group in user master maintenance	20091217
3	Returning	RT_USER	Value transfer	☐	Type reference (TYPE)	GRFN_T_USER		Table of users (+details)	20091217

Method GET_USERS_FOR_GROUP on class CL_GRFN_UTIL_USER has no exception.

Method GET_VH_NO_INITIAL_SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NO_SEARCH	Value transfer	☐	Type reference (TYPE)	AS4FLAG		Flag (X or Blank)	20130225

Method GET_VH_NO_INITIAL_SEARCH on class CL_GRFN_UTIL_USER has no exception.

Method HAS_DELEGATION_EXISTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ACTING_USER	Call by reference	☐	Type reference (TYPE)	SYUNAME		Acting user	20100830
2	Importing	IV_MAIN_USER	Call by reference	☐	Type reference (TYPE)	SYUNAME		Main user	20100830
3	Importing	IV_VALID_FROM	Call by reference	☐	Type reference (TYPE)	GRFN_DATE_FROM		Valid from Date	20100830
4	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100830

Method HAS_DELEGATION_EXISTED on class CL_GRFN_UTIL_USER has no exception.

Method IS_DATAPART_AUTHORIZED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20081105
2	Importing	IV_DATAPART	Call by reference	☐	Type reference (TYPE)	GRFN_DATAPART		Data Part for GRC Object Types	20081105
3	Importing	IV_ENTITY_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_ENTITY_ID		Entity ID	20081105
4	Importing	IV_REGULATION	Call by reference	☑	Type reference (TYPE)	GRFN_REGULATION		Regulation	20081105
5	Importing	IV_USER	Call by reference	☐	Type reference (TYPE)	UNAME	SY-UNAME	User Name	20081105
6	Returning	RV_AUTHORIZED	Value transfer	☐	Type reference (TYPE)	AS4FLAG		Flag (X or Blank)	20081105

Method IS_DATAPART_AUTHORIZED on class CL_GRFN_UTIL_USER has no exception.

Method IS_DISPLAY_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_USER	Call by reference	☑	Type reference (TYPE)	UNAME		User Name	20080701
2	Returning	RV_HAS_ROLE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20080701

Method IS_DISPLAY_USER on class CL_GRFN_UTIL_USER has no exception.

Method IS_GRC_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_USER	Call by reference	☑	Type reference (TYPE)	UNAME		User Name	20080701
2	Returning	RV_HAS_ROLE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20080701

Method IS_GRC_USER on class CL_GRFN_UTIL_USER has no exception.

Method IS_POST_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_USER	Call by reference	☑	Type reference (TYPE)	UNAME		User Name	20081126
2	Returning	RV_HAS_ROLE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20081126

Method IS_POST_USER on class CL_GRFN_UTIL_USER has no exception.

Method IS_POWER_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_USER	Call by reference	☑	Type reference (TYPE)	UNAME		User Name	20080701
2	Returning	RV_HAS_ROLE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20080701

Method IS_POWER_USER on class CL_GRFN_UTIL_USER has no exception.

Method IS_USER_EXISTS_FOR_FF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_USER	Call by reference	☐	Type reference (TYPE)	UNAME		User Name	20111122
2	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	BOOL		ABAP_TRUE for valid user, else invalid	20111122

Method IS_USER_EXISTS_FOR_FF on class CL_GRFN_UTIL_USER has no exception.

Method IS_VALID_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_USER	Call by reference	☐	Type reference (TYPE)	UNAME		User Name	20090217
2	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	BOOL		ABAP_TRUE for valid user, else invalid	20090217

Method IS_VALID_USER on class CL_GRFN_UTIL_USER has no exception.

Method QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_USR_RANGE	Call by reference	☑	Type reference (TYPE)	GRFN_T_SOD_USR_RANGE		Search for Users with a Ranges Table	20100705
2	Importing	IV_GRC_USERS_ONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Only return GRC users	20080702
3	Importing	IV_ROLE_ASSIGNMENT	Call by reference	☑	Type reference (TYPE)	AGR_NAME		Only users with certain role assignment	20080820
4	Importing	IV_SEARCH_PATTERN	Call by reference	☑	Type reference (TYPE)	GRFN_API_SEARCH_PATTERN		Search pattern for the Query APIs	20080514
5	Returning	RT_USERNAME	Value transfer	☐	Type reference (TYPE)	GRFN_T_USER		User names table	20080514

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20080514

Method QUERY_ACTIVE_USERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_USER	Call by reference	☑	Type reference (TYPE)	GRAC_RT_USER		Table of users (+details)	20131203
2	Importing	IT_USER_NAME	Call by reference	☑	Type reference (TYPE)	GRAC_RT_USER_NAME		Range table for user name	20131203
3	Importing	IT_USR_RANGE	Call by reference	☑	Type reference (TYPE)	GRFN_T_SOD_USR_RANGE		Search for Users with a Ranges Table	20131203
4	Importing	IV_GRC_USERS_ONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Only return GRC users	20131203
5	Importing	IV_RECORDS	Call by reference	☑	Type reference (TYPE)	I		default value	20131203
6	Importing	IV_ROLE_ASSIGNMENT	Call by reference	☑	Type reference (TYPE)	AGR_NAME		Only users with certain role assignment	20131203
7	Importing	IV_SEARCH_PARAM	Call by reference	☑	Type reference (TYPE)	GRFN_T_SEARCH_CRITERIA		search criteria from browse and collect component	20131203
8	Importing	IV_SEARCH_PATTERN	Call by reference	☑	Type reference (TYPE)	GRFN_API_SEARCH_PATTERN		Search pattern for the Query APIs	20131203
9	Returning	RT_USERNAME	Value transfer	☐	Type reference (TYPE)	GRFN_T_USER		User names table	20130625

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20130625

Method QUERY_BY_ROLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ROLE	Call by reference	☐	Type reference (TYPE)	AGR_NAME		Role Name	20080606
2	Returning	RT_USERNAME	Value transfer	☐	Type reference (TYPE)	SPERS_ULST		User names table	20080606

Method QUERY_BY_ROLE on class CL_GRFN_UTIL_USER has no exception.

Method QUERY_BY_VALID_ROLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ROLE	Call by reference	☐	Type reference (TYPE)	AGR_NAME		Role Name	20120301
2	Returning	RT_USERNAME	Value transfer	☐	Type reference (TYPE)	SPERS_ULST		User names table	20120301

Method QUERY_BY_VALID_ROLE on class CL_GRFN_UTIL_USER has no exception.

Method QUERY_CUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_USR_RANGE	Call by reference	☑	Type reference (TYPE)	GRFN_T_SOD_USR_RANGE			20111215
2	Returning	RT_USERNAME	Value transfer	☐	Type reference (TYPE)	GRFN_T_USER			20111215

Method QUERY_CUP on class CL_GRFN_UTIL_USER has no exception.

Method QUERY_PC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GRC_USERS_ONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Only return GRC users	20081212
2	Importing	IV_ROLE_ASSIGNMENT	Call by reference	☑	Type reference (TYPE)	AGR_NAME		Only users with certain role assignment	20081212
3	Importing	IV_SEARCH_PATTERN	Call by reference	☑	Type reference (TYPE)	GRFN_API_SEARCH_PATTERN		Search pattern for the Query APIs	20081212
4	Returning	RT_USERNAME	Value transfer	☐	Type reference (TYPE)	GRFN_T_WD_CANDIDATE		User names table	20081212

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20081212

Method QUERY_USER_GROUPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SEARCH	Call by reference	☑	Type reference (TYPE)	GRFN_T_SEARCH_CRITERIA		Table for setting search param	20091217
2	Returning	RT_GROUPS	Value transfer	☐	Type reference (TYPE)	GRFN_T_USERGROUP		User Groups	20091217

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20091217

Method QUERY_USER_GROUPS_CNTRL_OWN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SEARCH	Call by reference	☑	Type reference (TYPE)	GRFN_T_SEARCH_CRITERIA		Table for setting search param	20120217
2	Returning	RT_GROUPS	Value transfer	☐	Type reference (TYPE)	GRFN_T_USERGROUP		User Groups	20120217

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20120217

Method RETREIVE_USER_GROUPS_CN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SEARCH	Call by reference	☑	Type reference (TYPE)	GRFN_T_SEARCH_CRITERIA		Table for setting search param	20130628
2	Returning	RT_GROUPS	Value transfer	☐	Type reference (TYPE)	GRFN_T_USERGROUP		User Groups	20130628

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20130628

Method RETRIEVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_ADDRESS	Call by reference	☐	Type reference (TYPE)	BAPIADDR3		BAPI reference structure for addresses (contact person)	20080514
2	Exporting	ES_LOCKED	Call by reference	☐	Type reference (TYPE)	BAPISLOCKD		User Lock	20100128
3	Exporting	ES_LOGONDATA	Call by reference	☐	Type reference (TYPE)	BAPILOGOND		BAPI reference structure for logondata	20081027
4	Importing	IV_USERNAME	Value transfer	☐	Type reference (TYPE)	UNAME		User Name	20080514

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20080514

Method UPDATE_MT_ADDRESS_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_RECIPIENT_DETAILS	Call by reference	☑	Type reference (TYPE)	GRFN_S_SV_ATTR		Survey Entity Attribute	20130604

Method UPDATE_MT_ADDRESS_BUFFER on class CL_GRFN_UTIL_USER has no exception.

Method USERDATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_USR_RANGE	Call by reference	☑	Type reference (TYPE)	GRFN_T_SOD_USR_RANGE		Search for Users with a Ranges Table	20110128
2	Importing	IV_GRC_USERS_ONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Only return GRC users	20110128
3	Importing	IV_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20110128
4	Importing	IV_ROLE_ASSIGNMENT	Call by reference	☑	Type reference (TYPE)	AGR_NAME		Only users with certain role assignment	20110128
5	Importing	IV_SEARCH_PATTERN	Call by reference	☑	Type reference (TYPE)	GRFN_API_SEARCH_PATTERN		Search pattern for the Query APIs	20110128
6	Returning	RT_USERNAME	Value transfer	☐	Type reference (TYPE)	GRFN_T_USER		User names table	20110128

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20110128

History

Last changed by/on	SAP	20141106
SAP Release Created in	300