org.forgerock.openam.core.rest

Class IdentityRestUtils

java.lang.Object

org.forgerock.openam.core.rest.IdentityRestUtils

public final class IdentityRestUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGENT_TYPE
static String	FIELD_MAIL
static String	GROUP_TYPE
static String	REALM
static String	UNIVERSAL_ID
static String	USER_KBA_ATTRIBUTE
static String	USER_TYPE
static String	USERNAME

Method Summary

Modifier and Type	Method and Description
static void	changeMemberships(org.forgerock.services.context.Context serverContext, String realm, String username, Set<String> groupNames)
static void	changePassword(org.forgerock.services.context.Context serverContext, String realm, String username, String oldPassword, String newPassword)
static void	enforceWhiteList(org.forgerock.services.context.Context context, org.forgerock.json.JsonValue jsonValue, String objectType, Set<String> validUserAttributes) When an instance of a user is created via self service, we impose additional rules for security purposes.
static Map<String,Set<String>>	getIdentityServicesAttributes(String realm, String objectType)
static SSOToken	getSSOToken(String ssoTokenId)
static org.forgerock.json.JsonValue	identityDetailsToJsonValue(IdentityDetails details) Convert an IdentityDetails object into a JsonValue.
static boolean	isUserActive(String uid) Uses an amAdmin SSOtoken to create an AMIdentity from the UID provided and checks whether the AMIdentity in context is active/inactive
static IdentityDetails	jsonValueToIdentityDetails(String objectType, org.forgerock.json.JsonValue jVal, String realm) Returns an IdentityDetails from a JsonValue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

USER_TYPE

public static final String USER_TYPE

See Also:

Constant Field Values

GROUP_TYPE

public static final String GROUP_TYPE

See Also:

Constant Field Values

AGENT_TYPE

public static final String AGENT_TYPE

See Also:

Constant Field Values

UNIVERSAL_ID

public static final String UNIVERSAL_ID

See Also:

Constant Field Values

FIELD_MAIL

public static final String FIELD_MAIL

See Also:

Constant Field Values

REALM

public static final String REALM

See Also:

Constant Field Values

USER_KBA_ATTRIBUTE

public static final String USER_KBA_ATTRIBUTE

See Also:

Constant Field Values

USERNAME

public static final String USERNAME

See Also:

Constant Field Values

Method Detail

changePassword

public static void changePassword(org.forgerock.services.context.Context serverContext,
                                  String realm,
                                  String username,
                                  String oldPassword,
                                  String newPassword)
                           throws org.forgerock.json.resource.ResourceException

Throws:

org.forgerock.json.resource.ResourceException

changeMemberships

public static void changeMemberships(org.forgerock.services.context.Context serverContext,
                                     String realm,
                                     String username,
                                     Set<String> groupNames)
                              throws org.forgerock.json.resource.ResourceException

Throws:

org.forgerock.json.resource.ResourceException

getIdentityServicesAttributes

public static Map<String,Set<String>> getIdentityServicesAttributes(String realm,
                                                                    String objectType)

getSSOToken

public static SSOToken getSSOToken(String ssoTokenId)
                            throws SSOException

Throws:

SSOException

identityDetailsToJsonValue

public static org.forgerock.json.JsonValue identityDetailsToJsonValue(IdentityDetails details)

Convert an IdentityDetails object into a JsonValue. Package private for IdentityResourceV2.

Parameters:

details - The IdentityDetails

Returns:

The JsonValue

enforceWhiteList

public static void enforceWhiteList(org.forgerock.services.context.Context context,
                                    org.forgerock.json.JsonValue jsonValue,
                                    String objectType,
                                    Set<String> validUserAttributes)
                             throws org.forgerock.json.resource.BadRequestException

When an instance of a user is created via self service, we impose additional rules for security purposes. Namely, we strictly apply a whitelist of valid attribute names to each attribute in the incoming JSON representation of the user object. This ensures a hacker can't manipulate the request and thereby pretend to be a manager, demigod or individual they are not. There is no return value. If you survive calling this function without an exception being thrown, there are no illegal values in the incoming JSON

Parameters:

context - The context

jsonValue - The request

objectType - The type of object we're creating, user, group, etc.

validUserAttributes - The set of valid user attributes

Throws:

org.forgerock.json.resource.BadRequestException - If any attribute is found in the JSON representation of the user object containing an attribute that is not in our whitelist

jsonValueToIdentityDetails

public static IdentityDetails jsonValueToIdentityDetails(String objectType,
                                                         org.forgerock.json.JsonValue jVal,
                                                         String realm)

Returns an IdentityDetails from a JsonValue.

Parameters:

objectType - the object type, eg. user, group, etc.

jVal - The JsonValue Object to be converted

realm - The realm

Returns:

The IdentityDetails object

isUserActive

public static boolean isUserActive(String uid)
                            throws org.forgerock.json.resource.NotFoundException

Uses an amAdmin SSOtoken to create an AMIdentity from the UID provided and checks whether the AMIdentity in context is active/inactive

Parameters:

uid - the universal identifier of the user

Returns:

true is the user is active, false otherwise

Throws:

org.forgerock.json.resource.NotFoundException - invalid SSOToken, invalid UID