IdentityStoreProvisioner
instead.public interface IdentityStoreUserProvisioner extends Plugin
Modifier and Type | Method and Description |
---|---|
UserResponseContext |
createUser(CreateUserRequestContext createRequestCtx)
Deprecated.
Create a user.
|
void |
deleteUser(DeleteUserRequestContext deleteRequestCtx)
Deprecated.
Delete a user.
|
UserResponseContext |
readUser(ReadUserRequestContext readRequestCtx)
Deprecated.
Read a user.
|
UserResponseContext |
updateUser(UpdateUserRequestContext updateRequestCtx)
Deprecated.
Update a user.
|
configure
getPluginDescriptor
UserResponseContext createUser(CreateUserRequestContext createRequestCtx) throws IdentityStoreException
UserResponseContext
should contain the following attributes within the user attribute
map:
Constants.ID
Constants.WHEN_CHANGED
- returned as a Date
Constants.WHEN_CREATED
- returned as a Date
createRequestCtx
- The Request Context containing all the information needed to fulfill the request, e.g. user attributes.UserResponseContext
containing the results of an Identity Store provisioning operation.IdentityStoreException
- An exception indicating that the Identity Store Provisioner operation failed.UserResponseContext readUser(ReadUserRequestContext readRequestCtx) throws IdentityStoreException
UserResponseContext
should contain the following attributes within the user attribute
map:
Constants.ID
Constants.WHEN_CHANGED
- returned as a Date
Constants.WHEN_CREATED
- returned as a Date
readRequestCtx
- The Request Context containing all the information needed to fulfill the request, e.g. user id.UserResponseContext
containing the results of an Identity Store provisioning operation.IdentityStoreException
- An exception indicating that the Identity Store Provisioner operation failed.UserResponseContext updateUser(UpdateUserRequestContext updateRequestCtx) throws IdentityStoreException
UserResponseContext
should contain the following attributes within the user attribute
map:
Constants.ID
Constants.WHEN_CHANGED
- returned as a Date
Constants.WHEN_CREATED
- returned as a Date
updateRequestCtx
- The Request Context containing all the information needed to fulfill the request, e.g. user attributes.UserResponseContext
containing the results of an Identity Store provisioning operation.IdentityStoreException
- An exception indicating that the Identity Store Provisioner operation failed.void deleteUser(DeleteUserRequestContext deleteRequestCtx) throws IdentityStoreException
deleteUser
MAY choose not to permanently delete the user, but
MUST return a NotFoundException
for all readUser
, updateUser
, and deleteUser
operations associated with the previously deleted ID. In addition, the plugin MUST not consider the deleted user
in conflict calculation. For example, a createUser
request for a user with a previously deleted id should
NOT throw a ConflictException
.deleteRequestCtx
- The Request Context containing all the information needed to fulfill the request, e.g. user id.IdentityStoreException
- An exception indicating that the Identity Store Provisioner operation failed.Copyright 2019 Ping Identity Corp. All rights reserved.