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

Modifier and Type	Method	Description
GroupsResponseContext	readGroups(ReadGroupsRequestContext readRequestCtx)	Read a list of groups.
UsersResponseContext	readUsers(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, the UsersResponseContext list should contain users with the following attributes within the user attribute map:

• Constants.ID
• Constants.WHEN_CHANGED - returned as a Date
• Constants.WHEN_CREATED - returned as a Date

Parameters:

readRequestCtx - The Request Context containing all the information needed to fulfill the request, e.g. filter.

Returns:

A UsersResponseContext containing 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, the GroupsResponseContext should contain groups with the following attributes within the groups attribute map:

• Constants.ID
• Constants.WHEN_CHANGED - returned as a Date
• Constants.WHEN_CREATED - returned as a Date

Parameters:

readRequestCtx - The Request Context containing all the information needed to fulfill the request, e.g. filter

Returns:

A GroupsResponseContext containing the results of an Identity Store provisioning operation.

Throws:

IdentityStoreException - An exception indicating that the Identity Store Provisioner operation failed.