FindUserProfile

The FindUserProfile method finds a user profile given its name.

Parameters

xsd:string sessionId (^m)

The session identifier.

xsd:stringuserProfileLabel (^m)

The user profile display name to search for. This may contain wildcard characters (*).

xsd:long noOfUserProfiles

This parameter can be 0 and in this case the method retrieves the totalNoOfUserProfilesFound (match found).

The number of user profiles to return from the search if more than 1 match is found.

UserProfilePropertiesRequired userProfilePropertiesRequired

Specifies which user profile properties to retrieve.

Mandatory if noOfUserProfiles is greater than 0.

Return Values

ArrayOfUserProfileProperties FindUserProfileReturn: An array of user profile properties structures, one for each profile matched by the search. This array will either be of the size of the number of profiles matched by the search, or of the number of profiles requested by the method call - whichever size is the lowest.
xsd:long totalNoOfUserProfilesFound: The total number of user profiles that were matched by the search (this can be used to indicate whether there were more matches found than the requested number of user profiles).

Remarks

The method supports wildcard pattern matching for the user profile name. The name is case insensitive.

More information: