Package com.pingidentity.sdk.provision
Interface IdentityStoreProvisionerWithFiltering
-
- All Superinterfaces:
ConfigurablePlugin,DescribablePlugin,IdentityStoreProvisioner,Plugin
public interface IdentityStoreProvisionerWithFiltering extends IdentityStoreProvisioner
The Identity Store Provisioner interface which adds support for filtering. If filtering will be supported, this interface should be used.- Since:
- 8.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description GroupsResponseContextreadGroups(ReadGroupsRequestContext readRequestCtx)Read a list of groups.UsersResponseContextreadUsers(ReadUsersRequestContext readRequestCtx)Read a list of users based on the SCIM filter criteria.-
Methods inherited from interface com.pingidentity.sdk.ConfigurablePlugin
configure
-
Methods inherited from interface com.pingidentity.sdk.DescribablePlugin
getPluginDescriptor
-
Methods inherited from interface com.pingidentity.sdk.provision.IdentityStoreProvisioner
createGroup, createUser, deleteGroup, deleteUser, getIdentityStoreProvisionerDescriptor, isGroupProvisioningSupported, readGroup, readUser, updateGroup, updateUser
-
-
-
-
Method Detail
-
readUsers
UsersResponseContext readUsers(ReadUsersRequestContext readRequestCtx) throws IdentityStoreException
Read a list of users based on the SCIM filter criteria. At a minimum, theUsersResponseContextlist should contain users with the following attributes within the user attribute map:Constants.IDConstants.WHEN_CHANGED- returned as aDateConstants.WHEN_CREATED- returned as aDate
- Parameters:
readRequestCtx- The Request Context containing all the information needed to fulfill the request, e.g. filter.- Returns:
- A
UsersResponseContextcontaining the results of an Identity Store provisioning operation. - Throws:
IdentityStoreException- An exception indicating that the Identity Store Provisioner operation failed.
-
readGroups
GroupsResponseContext readGroups(ReadGroupsRequestContext readRequestCtx) throws IdentityStoreException
Read a list of groups. At a minimum, theGroupsResponseContextshould contain groups with the following attributes within the groups attribute map:Constants.IDConstants.WHEN_CHANGED- returned as aDateConstants.WHEN_CREATED- returned as aDate
- Parameters:
readRequestCtx- The Request Context containing all the information needed to fulfill the request, e.g. filter- Returns:
- A
GroupsResponseContextcontaining the results of an Identity Store provisioning operation. - Throws:
IdentityStoreException- An exception indicating that the Identity Store Provisioner operation failed.
-
-