CINXE.COM

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Users Guide — Apache Directory</title> <link href="/css/common.css" rel="stylesheet" type="text/css"/> <link href="/css/scimple.css" rel="stylesheet" type="text/css"/> <link rel="shortcut icon" href="/images/server-icon_16x16.png" /> <script src="https://www.apachecon.com/event-images/snippet.js"></script> </head> <body> <div class="top-bottom-spacer"></div> <div id="container"> <div id="header"> Apache Directory <a href="/"><div id="headerClick"></div></a> <div id="subProjectsNavBar"> <a href="/"> Main </a>  |  <a href="/apacheds/"> ApacheDS </a>  |  <a href="/studio/"> Studio </a>  |  <a href="/api/"> LDAP API </a>  |  <a href="/mavibot/"> Mavibot </a>  |  <a href="/scimple/"> SCIMple </a>  |  <a href="/fortress/"> Fortress </a>  |  <a href="/kerby/"> Kerby </a> </div> </div> <div id="content"> <div id="leftColumn"> <div id="navigation"> <a class="acevent" data-format="wide" data-width="170"></a> <h5>SCIMple</h5> <ul> <li><a href="/scimple/">Home</a></li> <li><a href="/scimple/news.html">News</a></li> </ul> <h5>Downloads</h5> <ul> <li><a href="/scimple/downloads.html">Version 1.0.0-M1</a>  <IMG src="/images/new_badge.svg" alt="" style="margin-bottom:-3px;" border="0"></li> </ul> <h5>Documentation</h5> <ul> <li><a href="/scimple/five-minutes-tutorial.html">Five minute tutorial</a></li> <li><a href="/scimple/user-guide.html">User Guide</a></li> <li><a href="/scimple/gen-docs/latest/apidocs/">JavaDocs</a></li> </ul> <h5>Support</h5> <ul> <li><a href="/mailing-lists-and-irc.html">Mailing Lists & IRC</a></li> <li><a href="/sources.html">Sources</a></li> <li><a href="/issue-tracking.html">Issue Tracking</a></li> <li><a href="/commercial-support.html">Commercial Support</a></li> </ul> <h5>Community</h5> <ul> <li><a href="/contribute.html">How to Contribute</a></li> <li><a href="/team.html">Team</a></li> <li><a href="/original-project-proposal.html">Original Project Proposal</a></li> <li><a href="/special-thanks.html" class="external-link" rel="nofollow">Special Thanks</a></li> </ul> <h5>About Apache</h5> <ul> <li><a href="https://www.apache.org/">Apache</a></li> <li><a href="https://www.apache.org/licenses/">License</a></li> <li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> <li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a></li> <li><a href="https://www.apache.org/security/">Security</a></li> </ul> </div> </div> <div id="rightColumn"> <h1 id="users-guide">Users guide</h1> Apache’s Java EE implementation of the <a href="https://www.simplecloud.info/">Simple Cross-domain Identity Management</a> (SCIM) version 2.0 specification as defined by the following RFCs: <ul> <li> <a href="https://tools.ietf.org/html/rfc7643">RFC7643 - SCIM: Core Schema</a> </li> <li> <a href="https://tools.ietf.org/html/rfc7644">RFC7644 - SCIM: Protocol</a> </li> <li> <a href="https://tools.ietf.org/html/rfc7642">RFC7642 - SCIM: Definitions, Overview, Concepts, and Requirements</a> </li> </ul> <h2 id="project">Project</h2> Please fork this project and contribute Pull-Requests via this project’s Github page. Issue tracking is being transitioned to the <a href="https://issues.apache.org/jira/browse/SCIMPLE">Apache Foundation’s Jira server</a>. <h2 id="features">Features</h2> <ul> <li>A full-featured Java SCIM client</li> <li>Declarative creation of new ResourceTypes and Extensions</li> <li>Dynamic generation of the Schema and ResourceType end-points.</li> <li>A suite of tools to allow the creation of SCIM resources that can then be verified against the appropriate schemas.</li> </ul> <h2 id="future-features">Future features</h2> <ul> <li>Example implementations of the server with various persistence paradigms.</li> <li>A set of verification tests to ensure the project meets the specification and to allow inter-operability testing.</li> </ul> <h2 id="example-code">Example code</h2> Examples of the project’s declarative syntax are shown below. The first example shows how a SCIM resource is declared: <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java">@Data @EqualsAndHashCode(callSuper = true) @ScimResourceType( id = ScimUser.RESOURCE_NAME, name = ScimUser.RESOURCE_NAME, schema = ScimUser.SCHEMA_URI, description = "Top level ScimUser", endpoint = "/Users" ) @XmlRootElement(name = ScimUser.RESOURCE_NAME) @XmlAccessorType(XmlAccessType.FIELD) public class ScimUser extends ScimResource { public static final String RESOURCE_NAME = "User"; public static final String SCHEMA_URI = "urn:ietf:params:scim:schemas:core:2.0:User"; @ScimAttribute( description="A Boolean value indicating the User's administrative status.", type=Type.BOOLEAN ) @XmlElement(name = "active") Boolean active = true; @ScimAttribute( type = Type.COMPLEX, description="A physical mailing address for this User, as described in ..." ) @XmlElement(name = "addresses") List<Address> addresses; </code></pre></div>In the example above, annotations are used at the class level and member level to declare a new SCIM resource and its attributes respectively. The example below shows the equivalent declaration for a resource Extension: <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java">@XmlRootElement @XmlAccessorType(XmlAccessType.NONE) @ScimExtensionType( required = false, name = "EnterpriseUser", id = EnterpriseExtension.URN, description = "Attributes commonly used in representing users that belong to, or act on behalf of, a business or enterprise." ) @Data public class EnterpriseExtension implements ScimExtension { public static final String URN = "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"; @XmlType @XmlAccessorType(XmlAccessType.NONE) @Data @Accessors(chain = true) public static class Manager { @ScimAttribute( description = "The \"id\" of the SCIM resource representing the user's manager. RECOMMENDED." ) @XmlElement private String value; @ScimAttribute( description = "The URI of the SCIM resource representing the User's manager. RECOMMENDED." ) @XmlElement private String $ref; </code></pre></div>This example shows how an extension is declared at the class level, but also provides an example of how complex SCIM types can be simply defined as suitably annotated inner classes. Implementations are fully customizable without altering the core server code. The example below shows how the implementation for a repository is declared: <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java">public class InMemoryUserService implements Respository<ScimUser> { </code></pre></div>Implementing the repository interface allows the customization of create, retrieve, update, and delete methods (as well as find). Customization is flexible - if your system implements soft deletes, create a delete method that simply sets a flag and alter the find and retrieve methods to only return “undeleted” resources. <h2 id="building--contributing">Building & Contributing</h2> Clone the code and build it! Prerequisites <ul> <li>Java 17+ to build Java 11+ at runtime.</li> </ul> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash">git clone https://github.com/apache/directory-scimple.git cd directory-scimple ./mvnw package # or on windows # mvnw.bat package </code></pre></div> </div> <div id="endContent"></div> </div> <div class="footer-wrapper"> <div id="footer"> © 2003-2025, <a href="https://www.apache.org">The Apache Software Foundation</a> - <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a> Apache Directory, ApacheDS, Apache Directory Server, Apache Directory Studio, Apache LDAP API, Apache Triplesec, Triplesec, Apache Mavibot, Mavibot, Apache eSCIMo, eSCIMo, Apache SCIMple, SCIMple, Fortress, Apache Fortress, EnMasse, Apache EnMasse, Apache Kerby, Kerby, Apache, the Apache feather logo, and the Apache Directory project logos are trademarks of The Apache Software Foundation. </div> </div> </div> <div class="top-bottom-spacer"></div> </body> </html>