SAP Function BAPI_USER_GETLIST - Search for Users

Parameter Reference Type Length Default Optional Text
MAX_ROWS BAPIUSMISC-BAPIMAXROW I 4 0 X Maximum Number of Lines of Hits
WITH_USERNAME BAPIUSMISC-WITH_NAME C 1 SPACE X Read User with Name

Parameter Reference Type Length Text
ROWS BAPIUSMISC-BAPIROWS I 4 No. of users selected

Parameter Reference Length Optional Text
RETURN BAPIRET2 548 X Return Parameter
SELECTION_EXP BAPIUSSEXP 164 X Search for Users with Free Selections
SELECTION_RANGE BAPIUSSRGE 155 X Search for Users with a Ranges Table
USERLIST BAPIUSNAME 172 X User List

Functionality
This method provides a generic search for users, depending on thedifferent user attributes. It supports the most important userattributes delivered by the function module BAPI_USER_GET_DETAIL:
PARAMETER,,FIELD,,permitted LOW values
USERNAME,,,,
LOGONDATA ,,GLTGV, GLTGB, USTYP, CLASS, ACCNT, TZONE, CODVN, UFLAG (notin BAPI_USER_GET_DETAIL, that shows this information in parameterISLOCKED),,(in accordance with the field type)
DEFAULTS,,SPLD, SPLG, SPDB, SPDA, DATFM, DCPFM, LANGU, KOSTL,START_MENU,,(in accordance with the field type)
REF_USER,,REF_USER,,
ALIAS,,USERALIAS,,
PROFILES,,BAPIPROF,,
LOCPROFILES,,SUBSYSTEM, PROFILE,,(in accordance with the field type)
ACTIVITYGROUPS ,,AGR_NAME, FROM_DAT, TO_DAT,,(in accordance with thefield type)
LOCACTGROUPS,,SUBSYSTEM, AGR_NAME, FROM_DAT, TO_DAT,,(in accordance withthe field type)
ADDRESS,,FIRSTNAME, LASTNAME, DEPARTMENT, INHOUSE_ML, FUNCTION,BUILDING_P, BUILDING, ROOM_NO_P, TEL1_EXT, TEL1_NUMBR, FAX_EXTENS,FAX_NUMBER, E_MAIL,,(in accordance with the field type)
COMPANY,,COMPANY,,
LASTMODIFIED,,MODDATE, MODTIME,,(in accordance with the field type)
ISLOCKED,,LOCAL_LOCK, GLOB_LOCK, WRNG_LOGON, NO_USER_PW,,'L'
SYSTEM,,SUBSYSTEM,,

Notes
You can transfer the selection criteria either in table Selection_Rangeor in table Selection_Exp. If the Selection_Range table is filled, theSelection_Exp table is not used.
Caution
The possible specifications in the tables Selection_Exp andSelection_Exp are very restrictive.
Table Selection_Exp:

  • In the first row, only the logical operator in field LOGOP and the
    • number of following rows in field ARITY are evaluated.
    • If you use the AND operator, you cannot specify more than one identical
      • field for the same parameter. The result list would then be empty.
      For both tables:
      • Only the values "EQ" and "L" are supported as field values for SIGN and
        • OPTION for the parameter ISLOCKED. All other values do not lead to theexpected results. For very general queries, such as to find all unlockedor all locked users, it is better to use the following entries in theSelection_Range table
        For all unlocked users:
        PARAMETER FIELD S OP LOW
        LOGONDATA UFLAG I EQ 0
        For all locked users:
        PARAMETER FIELD S OP LOW
        LOGONDATA UFLAG I NE 0
        • You cannot combine the fields MODDATE and MODTIME for the parameter
          • LAST_MODIFIED. For example, it is not possible to find all users thatwere modified after 05/01/2005 12:15. Either all users that weremodified after 05/01/2005 are to be found (this selection is the onlymeaningful one for this example.), or you can select all users that weremodified after 12:15 (regardless of which day).
          RESET N1
          BAPIUSCNT
          BAPIMAXROW
          BAPIUSNAFL
          INCLUDE SU_RETURN OBJECT DOKU ID TX

          Description
          You can use this parameter for a generic search with free selections.You can restrict the selection by users using different attributes.The most important user attributes delivered by the function moduleBAPI_USER_GET_DETAIL are supported.
          In the field PARAMETER, specify a parameter name for thefunction module BAPI_USER_GET_DETAIL. The field FIELD must befilled with the component name of the reference type.
          The following operators are available for OPTION:
          EQ - Equal
          NE - Not Equal
          BT - BeTween
          NB - Not Between
          LT - Less Than
          LE - Less Equal
          GT - Greater Than
          GE - Greater Equal
          CP - Contains Pattern
          NP - Not contains Pattern
          The fields LOW and HIGH contain the lower limit and upper limit for thegeneric selection.
          You can list multiple attributes in the table, and an attribute canappear more than once. The logical operation LOGOP specifieswhether the selection is to be linked with 'OR' or 'AND'. The logicaloperation must be in the first row of the table, together with thearity ARITY. It specifies the number of subsequent rows.

          Example:
          You are searching for dialog users that start with 'A' and 'B':
          LOGOP,,ARITY,,PARAMETER,,FIELD,,OPTION,,LOW,,HIGH
          AND,,2
          ,,,,USERNAME,,,,BT,,A,,C
          ,,,,LOGONDATA,,USTYP,,EQ,,B

          Description
          This parameter is a generic ranges table, with which you can restrictthe selection of users using various attributes. The most importantuser attributes delivered by the function module BAPI_USER_GET_DETAILare supported.
          In the PARAMETER field, specify a parameter name of thefunction module BAPI_USER_GET_DETAIL. The field FIELD must befilled with the component name of the reference type. For informationabout the general functions of a range table, see the documentation forthe fields SIGN and OPTION. Thefields LOW and HIGH contain the lower limit and upperlimit for the generic selection.
          You can list multiple attributes in the table, and an attribute canappear more than once. In this case, the selection using the sameattribute is linked with 'OR', and selection using different attributeswith 'AND'.

          Example:
          You are searching for dialog users that begin with 'A' and 'B':
          PARAMETER,,FIELD,,SIGN,,OPTION,,LOW,,HIGH
          USERNAME,,,,I,,BT,,A,,C
          LOGONDATA,,USTYP,,I,,EQ,,A

          Description
          The table contains all users found for the selection. If the parameterWITH_USERNAME was set, the first name, family name, and thecomplete name are also returned.

753559BAPI_USER_GETLIST does not return any names