| // |
| // Licensed to the Apache Software Foundation (ASF) under one |
| // or more contributor license agreements. See the NOTICE file |
| // distributed with this work for additional information |
| // regarding copyright ownership. The ASF licenses this file |
| // to you under the Apache License, Version 2.0 (the |
| // "License"); you may not use this file except in compliance |
| // with the License. You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, |
| // software distributed under the License is distributed on an |
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| // KIND, either express or implied. See the License for the |
| // specific language governing permissions and limitations |
| // under the License. |
| // |
| === Provisioning |
| |
| As described <<identity-managers,above>>, provisioning is actually _the_ core feature provided by Apache Syncope. |
| |
| Essentially, it can be seen as the process of keeping the identity data synchronized between Syncope and related external resources, according to the specifications provided by the <<mapping,mapping>>. It does this by performing create, update and |
| delete operations onto the <<persistence,internal storage>> or external resources via connectors. |
| |
| ==== Overview |
| |
| The picture below contains an expanded view of the <<architecture,core architecture>>, with particular reference to the |
| components involved in the provisioning process. |
| |
| [.text-center] |
| image::provisioningFlow.png[title="Provisioning flow",alt="Provisioning flow"] |
| |
| The provisioning operations can be initiated in several different ways: |
| |
| * by creating, updating or deleting Users, Groups or Any Objects via REST (thus involving the underlying |
| <<logic,logic>> layer) |
| * by requesting execution of pull or push tasks via REST |
| * by triggering periodic pull or push task executions |
| |
| [[provisioning-managers]] |
| [NOTE] |
| .Provisioning Managers |
| ==== |
| The provisioning operations are defined by the provisioning manager interfaces: |
| |
| ifeval::["{snapshotOrRelease}" == "release"] |
| * https://github.com/apache/syncope/blob/syncope-{docVersion}/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/UserProvisioningManager.java[UserProvisioningManager^] |
| endif::[] |
| ifeval::["{snapshotOrRelease}" == "snapshot"] |
| * https://github.com/apache/syncope/blob/master/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/UserProvisioningManager.java[UserProvisioningManager^] |
| endif::[] |
| ifeval::["{snapshotOrRelease}" == "release"] |
| * https://github.com/apache/syncope/blob/syncope-{docVersion}/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/GroupProvisioningManager.java[GroupProvisioningManager^] |
| endif::[] |
| ifeval::["{snapshotOrRelease}" == "snapshot"] |
| * https://github.com/apache/syncope/blob/master/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/GroupProvisioningManager.java[GroupProvisioningManager^] |
| endif::[] |
| ifeval::["{snapshotOrRelease}" == "release"] |
| * https://github.com/apache/syncope/blob/syncope-{docVersion}/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/AnyObjectProvisioningManager.java[AnyObjectProvisioningManager^] |
| endif::[] |
| ifeval::["{snapshotOrRelease}" == "snapshot"] |
| * https://github.com/apache/syncope/blob/master/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/AnyObjectProvisioningManager.java[AnyObjectProvisioningManager^] |
| endif::[] |
| |
| Default implementations are available: |
| |
| ifeval::["{snapshotOrRelease}" == "release"] |
| * https://github.com/apache/syncope/blob/syncope-{docVersion}/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/DefaultUserProvisioningManager.java[DefaultUserProvisioningManager^] |
| endif::[] |
| ifeval::["{snapshotOrRelease}" == "snapshot"] |
| * https://github.com/apache/syncope/blob/master/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/DefaultUserProvisioningManager.java[DefaultUserProvisioningManager^] |
| endif::[] |
| ifeval::["{snapshotOrRelease}" == "release"] |
| * https://github.com/apache/syncope/blob/syncope-{docVersion}/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/DefaultGroupProvisioningManager.java[DefaultGroupProvisioningManager^] |
| endif::[] |
| ifeval::["{snapshotOrRelease}" == "snapshot"] |
| * https://github.com/apache/syncope/blob/master/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/DefaultGroupProvisioningManager.java[DefaultGroupProvisioningManager^] |
| endif::[] |
| ifeval::["{snapshotOrRelease}" == "release"] |
| * https://github.com/apache/syncope/blob/syncope-{docVersion}/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/DefaultAnyObjectProvisioningManager.java[DefaultAnyObjectProvisioningManager^] |
| endif::[] |
| ifeval::["{snapshotOrRelease}" == "snapshot"] |
| * https://github.com/apache/syncope/blob/master/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/DefaultAnyObjectProvisioningManager.java[DefaultAnyObjectProvisioningManager^] |
| endif::[] |
| ==== |
| |
| include::propagation.adoc[] |
| |
| include::pull.adoc[] |
| |
| include::push.adoc[] |
| |
| include::passwordreset.adoc[] |