SAP ABAP Interface /IWBEP/IF_MGW_UM_USER_MANAGER (User Management Interface)

Hierarchy

☛ SAP_GWFND (Software Component) SAP Gateway Foundation
   ⤷ OPU-BSE-SDE (Application Component) Gateway SAP Data Enablement
     ⤷ /IWBEP/MGW_USER_MGMT_API (Package) User Management - Public APIs

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	/IWBEP/CL_MGW_UM_USR_MGR_SUSR	B2C - User Manager, ABAP User Management	20130418

Properties

Interface	/IWBEP/IF_MGW_UM_USER_MANAGER
Short Description	User Management Interface

General Data

Package	/IWBEP/MGW_USER_MGMT_API	User Management - Public APIs
Created	20130410	SAP
Last changed	20141120
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	/IWBEP/IF_MGW_URM_DBA	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
2	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_BADI_INTERFACE	☐	☐	Tag Interface for BAdIs	20130410

Friends

Interface /IWBEP/IF_MGW_UM_USER_MANAGER has no friend.

Attributes

Interface /IWBEP/IF_MGW_UM_USER_MANAGER has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHANGE_PASSWORD	Instance method	Public	Method	Change User Password	20130410
2	CHECK_PASSWORD_POLICY	Instance method	Public	Method	Check password security policy	20130930
3	CREATE_USER	Instance method	Public	Method	Create User	20130410
4	GENERATE_PASSWORD	Instance method	Public	Method	Generate temporary password	20140409
5	GET_EXTERNAL_USERNAME	Instance method	Public	Method	Get External Username	20130731
6	GET_INTERNAL_USERNAME	Instance method	Public	Method	Get Internal Username	20130509
7	GET_USERS_BY_EMAIL	Instance method	Public	Method	Get Users by email	20140227
8	IS_EXISTS	Instance method	Public	Method	Check user existence	20130503
9	READ_USER	Instance method	Public	Method	Read User Details	20130410
10	UNLOCK_USER	Instance method	Public	Method	Unlock User	20130820
11	UPDATE_USER	Instance method	Public	Method	Update User Details	20130410

Events

Interface /IWBEP/IF_MGW_UM_USER_MANAGER has no event.

Types

Interface /IWBEP/IF_MGW_UM_USER_MANAGER has no local type.

Method Signatures

Method CHANGE_PASSWORD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_USER_CREDENTIAL	Call by reference	☐	Type reference (TYPE)	/IWBEP/S_MGW_UM_USER_PASSCODE		B2C - User Management User Passcode	20130410
2	Importing	IV_IS_FOR_LOCAL_APP	Call by reference	☐	Type reference (TYPE)	BOOLEAN	SPACE	Is User Management deployed Locally	20130613
3	Importing	IV_RESET_CREDENTIAL	Call by reference	☐	Type reference (TYPE)	BOOLEAN	SPACE	X = Reset Credential, SPACE = Change Password	20131110
4	Importing	IV_SERVICE_USER	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20130509

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20130410

Method CHECK_PASSWORD_POLICY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_IS_FOR_LOCAL_APP	Call by reference	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20130930
2	Importing	IV_PASSWORD	Call by reference	☐	Type reference (TYPE)	/IWBEP/MGW_UM_PASSCODE		User Management - Passcode	20130930
3	Importing	IV_REFERENCE_USER	Call by reference	☑	Type reference (TYPE)	/IWBEP/MGW_UM_USER_NAME		User Management User Name	20131008
4	Returning	RV_IS_VALID	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20130930

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20130930
2	/IWBEP/CX_MGW_TECH_EXCEPTION	☐	Technical Exception	20131008

Method CREATE_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_INTERNAL_UNAME	Call by reference	☑	Type reference (TYPE)	SYUNAME		User Name	20130613
2	Changing	CV_ERROR_CODE	Call by reference	☑	Type reference (TYPE)	/IWBEP/MGW_UM_ERROR_CODE		User Management - Error code	20130620
3	Importing	IS_USER_ADDRESS	Call by reference	☑	Type reference (TYPE)	/IWBEP/S_MGW_UM_USER_ADDR_INFO		B2C - User Management, Address Info	20130416
4	Importing	IS_USER_INFO	Call by reference	☐	Type reference (TYPE)	/IWBEP/S_MGW_UM_USER_INFO		B2C - User Management User Info	20130419
5	Importing	IS_USER_PROFILE	Call by reference	☑	Type reference (TYPE)	/IWBEP/S_MGW_UM_USER_PROFILE		B2C - User Management, User Profile	20130416
6	Importing	IV_IS_FOR_LOCAL_APP	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Is User Management deployed Locally	20130613

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20130410

Method GENERATE_PASSWORD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_IS_FOR_LOCAL_APP	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Is User Management deployed Locally	20140409
2	Importing	IV_USER_ALIAS	Call by reference	☐	Type reference (TYPE)	/IWBEP/MGW_UM_USER_NAME		User Management User Name	20140409
3	Returning	RV_PASSWORD	Value transfer	☐	Type reference (TYPE)	/IWBEP/MGW_UM_PASSCODE		User Management - Passcode	20140409

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20140409
2	/IWBEP/CX_MGW_TECH_EXCEPTION	☐	Technical Exception	20140409

Method GET_EXTERNAL_USERNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_USER_NAME	Call by reference	☐	Type reference (TYPE)	SYUNAME		User Name	20130731
2	Returning	RV_USER_NAME	Value transfer	☐	Type reference (TYPE)	/IWBEP/MGW_UM_USER_NAME		User Management User Name	20130731

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20130731

Method GET_INTERNAL_USERNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_UNAME	Call by reference	☐	Type reference (TYPE)	SYUNAME		User Name	20130509
2	Importing	IV_IS_FOR_LOCAL_APP	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Is User Management deployed Locally	20130613
3	Importing	IV_USERNAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MGW_UM_USER_NAME		User Management User Name	20130509

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20130509

Method GET_USERS_BY_EMAIL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_USER_ALIASES	Call by reference	☐	Type reference (TYPE)	/IWBEP/IF_MGW_URM_DBA=>TT_USER_ALIAS		List of User aliases	20140227
2	Importing	IV_USER_EMAIL	Call by reference	☐	Type reference (TYPE)	/IWBEP/MGW_URM_EMAIL_ADDR		User Request Management (Email Address)	20140227

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20140227

Method IS_EXISTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_EXISTS	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20130503
2	Importing	IV_IS_FOR_LOCAL_APP	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Is User Management deployed Locally	20130613
3	Importing	IV_USERNAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MGW_UM_USER_NAME		User Management User Name	20130503

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20130503

Method READ_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_USER_ADDRESS	Call by reference	☐	Type reference (TYPE)	/IWBEP/S_MGW_UM_USER_ADDR_INFO		B2C - User Management, Address Info	20130416
2	Changing	CS_USER_DETAIL	Call by reference	☐	Type reference (TYPE)	/IWBEP/S_MGW_UM_USER_INFO		B2C - User Management User Info	20130412
3	Changing	CS_USER_PROFILE	Call by reference	☐	Type reference (TYPE)	/IWBEP/S_MGW_UM_USER_PROFILE		B2C - User Management, User Profile	20130416
4	Importing	IV_IS_FOR_LOCAL_APP	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Is User Management deployed Locally	20130613
5	Importing	IV_SERVICE_USER	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20130509
6	Importing	IV_USERNAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MGW_UM_USER_NAME		User Name in User Master Record	20130410

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20130410

Method UNLOCK_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_IS_FOR_LOCAL_APP	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Is User Management deployed Locally	20130821
2	Importing	IV_USER_NAME	Call by reference	☐	Type reference (TYPE)	/IWBEP/MGW_UM_USER_NAME		User Management User Name	20130820

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20130820

Method UPDATE_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_USER_ADDRESS	Call by reference	☑	Type reference (TYPE)	/IWBEP/S_MGW_UM_USER_ADDR_INFO		B2C - User Management, Address Info	20130416
2	Importing	IS_USER_DETAIL	Call by reference	☐	Type reference (TYPE)	/IWBEP/S_MGW_UM_USER_INFO		B2C - User Management User Info	20130410
3	Importing	IS_USER_PROFILE	Call by reference	☑	Type reference (TYPE)	/IWBEP/S_MGW_UM_USER_PROFILE		B2C - User Management, User Profile	20130416
4	Importing	IV_IS_FOR_LOCAL_APP	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Is User Management deployed Locally	20130613

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20130410

History

Last changed by/on	SAP	20141120
SAP Release Created in	200