• Icon: Suggestion Suggestion
    • Resolution: Fixed
    • 2.1
    • REST
    • None
    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

      Crowd needs a REST endpoint that client applications can use. Currently client applications can only use the SOAP endpoint to communicate with Crowd.

      Here are some examples of using the new REST API.

      To search for a particular user, perform a GET request at:

      http://YOUR-CROWD-SERVER:8095/rest/usermanagement/1/user?username=<username>

      To get all attributes of a particular user, perform a GET request at:

      http://YOUR-CROWD-SERVER:8095/rest/usermanagement/1/user/attribute?username=<username>

      To add a user, perform a POST request to:

      http://YOUR-CROWD-SERVER:8095/rest/usermanagement/1/user

      To search for a particular group, perform a GET request at:

      http://YOUR-CROWD-SERVER:8095/rest/usermanagement/1/group?groupname=<groupname>

            [CWD-1912] REST API for client applications

            Are there any plans to undeprecate some of the admin resources? Specifically the 'directory' sections as those are not present in the current crowd API.

            Deleted Account (Inactive) added a comment - Are there any plans to undeprecate some of the admin resources? Specifically the 'directory' sections as those are not present in the current crowd API.

            joe added a comment -

            Only the 'admin' resources are deprecated. 'usermanagement' is fully supported and documented here: Crowd REST APIs.

            joe added a comment - Only the 'admin' resources are deprecated. 'usermanagement' is fully supported and documented here: Crowd REST APIs .

            As this seems to be Resolved, can someone please add a link to a documentation page, one that is not deprecated?

            Sorin Sbarnea added a comment - As this seems to be Resolved, can someone please add a link to a documentation page, one that is not deprecated?

            Bob, I believe that if you have an application which has two different directories and you add a group, both directories will get the group. Also, I think the same holds true for the user. I don't know if it's possible to specify a particular group get created under a specific directory if more than one directory is assigned to the application.

            I agree with you though, that would be excellent functionality to have in a future API release.

            Brian Nicely added a comment - Bob, I believe that if you have an application which has two different directories and you add a group, both directories will get the group. Also, I think the same holds true for the user. I don't know if it's possible to specify a particular group get created under a specific directory if more than one directory is assigned to the application. I agree with you though, that would be excellent functionality to have in a future API release.

            Bob Swift added a comment -

            The new APIs are really different than the 2.0 deprecated APIs. The 2.0 apis centered around directories and I can't even find a reference to directory in the new APIs. What gives here? So, how about getting directories, adding/updating users/groups in a directory? If I add a new user/group, what directory does it go in? How do you add a user to a specific group in a specific directory?

            Bob Swift added a comment - The new APIs are really different than the 2.0 deprecated APIs . The 2.0 apis centered around directories and I can't even find a reference to directory in the new APIs. What gives here? So, how about getting directories, adding/updating users/groups in a directory? If I add a new user/group, what directory does it go in? How do you add a user to a specific group in a specific directory?

            For those interested in the new REST API, we have released Crowd 2.1.0-beta4.

            Information about the new API is available in the Crowd 2.1.0 Beta 2 Release Notes.

            For other new features in beta4 have a look at the Crowd 2.1.0 Beta 4 Release Notes.

            Please note that this is a beta release so the usual warnings about NOT using it in production systems apply.

            James Wong added a comment - For those interested in the new REST API, we have released Crowd 2.1.0-beta4. Information about the new API is available in the Crowd 2.1.0 Beta 2 Release Notes . For other new features in beta4 have a look at the Crowd 2.1.0 Beta 4 Release Notes . Please note that this is a beta release so the usual warnings about NOT using it in production systems apply.

            SarahA added a comment -

            The new REST API does not provide a way of assigning a user to more than one group in one go. That would be a good thing to add as a feature request.

            SarahA added a comment - The new REST API does not provide a way of assigning a user to more than one group in one go. That would be a good thing to add as a feature request.

            DES Tools added a comment -

            Would the POST method also help to assign a user to a particular or multiple groups.
            A feature that allows to assign a user to multiple groups in one go, is more desirable since it's never a case that a user is a member of only a single group, in our setup.

            DES Tools added a comment - Would the POST method also help to assign a user to a particular or multiple groups. A feature that allows to assign a user to multiple groups in one go, is more desirable since it's never a case that a user is a member of only a single group, in our setup.

            SarahA added a comment -

            Deprecation of Crowd experimental REST APIs and foretaste of new APIs

            This is a copy of a forum announcement posted on 12 August 2010 in the Crowd forum and Crowd announcements forum.

            Crowd 2.0 introduced the experimental 'admin' REST APIs. In the upcoming release of Crowd 2.1, we will replace these with a new set of REST APIs for use by applications connecting to Crowd.

            We are now deprecating the experimental REST APIs introduced in Crowd 2.0.

            The new REST APIs, to be introduced in Crowd 2.1, will offer the following advantages:
            1. They will be cleaner and easier to program against, especially when developing a custom application connector.
            2. They include a fully functional, comprehensive search API.

            Here is a summary of the functionality that will be available in the new REST APIs in Crowd 2.1:

            • Implementation of applications that take advantage of SSO.
            • User authentication.
            • Retrieving, adding, updating and removing users.
            • Retrieving, adding, updating and removing custom user attributes.
            • Retrieving, adding, updating and removing groups.
            • Retrieving, adding, updating and removing custom group attributes.
            • Retrieving, adding, updating and removing group memberships.
            • Retrieving, adding and removing nested group memberships.
            • A fully functional, comprehensive search API. Initially, the search API will be quite terse in construction as the queries will be an XML/JSON serialisation of our internal search objects. We will provide a Java client that assists in constructing the queries.

            The following functions are currently available in the Crowd 2.0 REST APIs, but will not be available in the new REST APIs:

            • Retrieving a list of directories.
            • Retrieving basic directory information.
            • Executing operations per directory. You can mimic this by creating an application that maps only to the desired directory.

            The experimental APIs, now deprecated, are documented here:
            http://confluence.atlassian.com/display/CROWDDEV/Crowd+REST+APIs

            We will develop documentation for the new REST APIs within the next few weeks. Please watch that space.

            We will be delighted to have your feedback on this JIRA issue.

            SarahA added a comment - Deprecation of Crowd experimental REST APIs and foretaste of new APIs This is a copy of a forum announcement posted on 12 August 2010 in the Crowd forum and Crowd announcements forum . Crowd 2.0 introduced the experimental 'admin' REST APIs. In the upcoming release of Crowd 2.1, we will replace these with a new set of REST APIs for use by applications connecting to Crowd. We are now deprecating the experimental REST APIs introduced in Crowd 2.0. The new REST APIs, to be introduced in Crowd 2.1, will offer the following advantages: 1. They will be cleaner and easier to program against, especially when developing a custom application connector. 2. They include a fully functional, comprehensive search API. Here is a summary of the functionality that will be available in the new REST APIs in Crowd 2.1: Implementation of applications that take advantage of SSO. User authentication. Retrieving, adding, updating and removing users. Retrieving, adding, updating and removing custom user attributes. Retrieving, adding, updating and removing groups. Retrieving, adding, updating and removing custom group attributes. Retrieving, adding, updating and removing group memberships. Retrieving, adding and removing nested group memberships. A fully functional, comprehensive search API. Initially, the search API will be quite terse in construction as the queries will be an XML/JSON serialisation of our internal search objects. We will provide a Java client that assists in constructing the queries. The following functions are currently available in the Crowd 2.0 REST APIs, but will not be available in the new REST APIs: Retrieving a list of directories. Retrieving basic directory information. Executing operations per directory. You can mimic this by creating an application that maps only to the desired directory. The experimental APIs, now deprecated, are documented here: http://confluence.atlassian.com/display/CROWDDEV/Crowd+REST+APIs We will develop documentation for the new REST APIs within the next few weeks. Please watch that space. We will be delighted to have your feedback on this JIRA issue.

              Unassigned Unassigned
              justin@atlassian.com Justin Koke
              Votes:
              2 Vote for this issue
              Watchers:
              10 Start watching this issue

                Created:
                Updated:
                Resolved: