Enum UserAPI.USER_DETAILS

  • All Implemented Interfaces:
    Serializable, Comparable<UserAPI.USER_DETAILS>
    Enclosing class:
    UserAPI

    public static enum UserAPI.USER_DETAILS
    extends Enum<UserAPI.USER_DETAILS>
    Returns informations about the user received as parameter (can be also me) Normal member users can use only "me" or his username as parameter Users with "idm-service-read" or "idm-service-admin" role can invoke this method with any username accepted parameters are:
    • profile: returns the profile of the user in the Liferay CMS (only if the user is not a service)
    • email: returns the email of the user from the authentication service
    • user: the user representation from the authentication service
    if the optional parameter inspect is passed as true, returns additional values:
    • roles_realm: roles in realm for the user from the authentication service
    • roles_clients: roles in clients for the user from the authentication service
    • groups: id of the user from the authentication service
    • username: username of the user from the authentication service
    • name: Fullname of the user from the authentication service
    • attributes: attributes of the user from the authentication service
    • user: full user from the authentication service
    • profile: profile of the user from the Liferay CMS service
    • Method Detail

      • values

        public static UserAPI.USER_DETAILS[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (UserAPI.USER_DETAILS c : UserAPI.USER_DETAILS.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static UserAPI.USER_DETAILS valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null