public interface IdentityStoreProvisioner extends Plugin
Modifier and Type | Method and Description |
---|---|
GroupResponseContext |
createGroup(CreateGroupRequestContext createRequestCtx)
Create a group.
|
UserResponseContext |
createUser(CreateUserRequestContext createRequestCtx)
Create a user.
|
void |
deleteGroup(DeleteGroupRequestContext deleteRequestCtx)
Delete a group.
|
void |
deleteUser(DeleteUserRequestContext deleteRequestCtx)
Delete a user.
|
IdentityStoreProvisionerDescriptor |
getIdentityStoreProvisionerDescriptor()
The PingFederate server will invoke this method on your IdentityStoreProvisioner implementation to discover
metadata about the implementation.
|
boolean |
isGroupProvisioningSupported()
Indicate if group provisioning is implemented or not.
|
GroupResponseContext |
readGroup(ReadGroupRequestContext readRequestCtx)
Read a group.
|
UserResponseContext |
readUser(ReadUserRequestContext readRequestCtx)
Read a user.
|
GroupResponseContext |
updateGroup(UpdateGroupRequestContext updateRequestCtx)
Update a group.
|
UserResponseContext |
updateUser(UpdateUserRequestContext updateRequestCtx)
Update a user.
|
configure
getPluginDescriptor
IdentityStoreProvisionerDescriptor getIdentityStoreProvisionerDescriptor()
DescribablePlugin.getPluginDescriptor()
method.
Your implementation of this method should return the same IdentityStoreProvisionerDescriptor object from
call to call - behaviour of the system is undefined if this convention is not followed.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.GroupResponseContext readGroup(ReadGroupRequestContext readRequestCtx) throws IdentityStoreException
GroupResponseContext
should contain the following attributes within the group 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. group id.GroupResponseContext
containing the results of an Identity Store provisioning operation.IdentityStoreException
- An exception indicating that the Identity Store Provisioner operation failed.GroupResponseContext createGroup(CreateGroupRequestContext createRequestCtx) throws IdentityStoreException
GroupResponseContext
should contain the following attributes within the group 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. group attributes.GroupResponseContext
containing the results of an Identity Store provisioning operation.IdentityStoreException
- An exception indicating that the Identity Store Provisioner operation failed.void deleteGroup(DeleteGroupRequestContext deleteRequestCtx) throws IdentityStoreException
deleteGroup
MAY choose not to permanently delete the group, but
MUST return a NotFoundException
for all readGroup
, updateGroup
, and deleteGroup
operations associated with the previously deleted ID. In addition, the plugin MUST not consider the deleted group
in conflict calculation. For example, a createGroup
request for a group 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. group id.IdentityStoreException
- An exception indicating that the Identity Store Provisioner operation failed.GroupResponseContext updateGroup(UpdateGroupRequestContext updateRequestCtx) throws IdentityStoreException
GroupResponseContext
should contain the following attributes within the group 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. group attributes.GroupResponseContext
containing the results of an Identity Store provisioning operation.IdentityStoreException
- An exception indicating that the Identity Store Provisioner operation failed.boolean isGroupProvisioningSupported()
readGroup
, createGroup
, updateGroup
,
and deleteGroup
should throw NotImplementedException
.IdentityStoreException
- An exception indicating that the Identity Store Provisioner operation failed.Copyright 2019 Ping Identity Corp. All rights reserved.