Uploaded image for project: 'Crowd Data Center'
  1. Crowd Data Center
  2. CWD-5431

How to obtain the groupid parameter in Group Leave Administration specific REST APIs is not clearly explained

XMLWordPrintable

    • Icon: Suggestion Suggestion
    • Resolution: Unresolved
    • None
    • Documentation
    • None
    • 10

    • 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.

      Since Crowd 3.3.0, Group Level Administration was introduced in Crowd Data Center. This included the introduction of new Rest API endpoints that cater for this functionality.
      This includes the following end points.
      /admin/1.0/group-level-admin
      and
      /admin/1.0/groups/

      Some of the new APIs include the groupid parameter. The documentation, however, does not explain how to obtain this nor there is any REST function that helps in obtaining the ID.

      This causes a confusion, where users who would like to use these endpoints think that this groupid is actually the groupid from the database.

      This is not the case, however, as based on the discussion with the Crowd product team, the groupid is obtained by combining the User Directory the group belongs to and the group name. The group name should be in the base64 URL safe encoding format.

      So for example if directory id is 163841 and the group name's encoding is Y29uZmx1ZW5jZS11c2Vycw then the REST will look like something like this.

      • rest/admin/1.0/groups/163841-Y29uZmx1ZW5jZS11c2Vycw

      To convert the group name to Base 64 Encoder URL safe format users will need to code their own converter or use online tools such as

      Proposed Resolution:

      Explain the process of obtaining the groupid in the official REST API documentation.

            [CWD-5431] How to obtain the groupid parameter in Group Leave Administration specific REST APIs is not clearly explained

            SET Analytics Bot made changes -
            Support reference count New: 10
            Katherine Yabut made changes -
            Workflow Original: JAC Suggestion Workflow [ 3362666 ] New: JAC Suggestion Workflow 3 [ 3631044 ]
            Monique Khairuliana (Inactive) made changes -
            Workflow Original: Simplified Crowd Development Workflow v2 [ 3302984 ] New: JAC Suggestion Workflow [ 3362666 ]
            Issue Type Original: New Feature [ 2 ] New: Suggestion [ 10000 ]
            Status Original: Open [ 1 ] New: Gathering Interest [ 11772 ]
            Ahmad Faridi made changes -
            Remote Link New: This issue links to "Page (Confluence)" [ 437500 ]
            Ahmad Faridi made changes -
            Description Original: Since Crowd 3.3.0, Group Level Administration was introduced in Crowd Data Center. This included the introduction of new Rest API endpoints that cater for this functionality.
             This includes the following end points.
             /admin/1.0/group-level-admin
             and
             /admin/1.0/groups/

            Some of the new APIs include the {{groupid}} parameter. The documentation, however, does not explain how to obtain this nor there is any REST function that helps in obtaining the ID.

            This causes a confusion, where users who would like to use these endpoints think that this groupid is actually the groupid from the database.

            This is not the case, however, as based on the discussion with the Crowd product team, the groupid is obtained by combining the User Directory the group belongs to and the group name. The group name should be in the base64 URL safe encoding format.

            So for example if directory id is 163841 and the group name's encoding is Y29uZmx1ZW5jZS11c2Vycw then the REST will look like something like this.
             * {{rest/admin/1.0/groups/163841-Y29uZmx1ZW5jZS11c2Vycw}}

            To convert the group name to Base 64 Encoder URL safe format users will need to code their own converter or use online tools such as
             * [Base 64 Encoder (100% client-side) :: OpinionatedGeek|https://opinionatedgeek.com/Codecs/Base64Encoder]

            Resolution:
            Explain the process of obtaining the groupid in the official REST API documentation.             		New: Since Crowd 3.3.0, Group Level Administration was introduced in Crowd Data Center. This included the introduction of new Rest API endpoints that cater for this functionality.
             This includes the following end points.
             /admin/1.0/group-level-admin
             and
             /admin/1.0/groups/

            Some of the new APIs include the {{groupid}} parameter. The documentation, however, does not explain how to obtain this nor there is any REST function that helps in obtaining the ID.

            This causes a confusion, where users who would like to use these endpoints think that this groupid is actually the groupid from the database.

            This is not the case, however, as based on the discussion with the Crowd product team, the groupid is obtained by combining the User Directory the group belongs to and the group name. The group name should be in the base64 URL safe encoding format.

            So for example if directory id is 163841 and the group name's encoding is Y29uZmx1ZW5jZS11c2Vycw then the REST will look like something like this.
             * {{rest/admin/1.0/groups/163841-Y29uZmx1ZW5jZS11c2Vycw}}

            To convert the group name to Base 64 Encoder URL safe format users will need to code their own converter or use online tools such as
             * [Base 64 Encoder (100% client-side) :: OpinionatedGeek|https://opinionatedgeek.com/Codecs/Base64Encoder]

            h3. Proposed Resolution:

            Explain the process of obtaining the groupid in the official REST API documentation.
            Ahmad Faridi made changes -
            Description Original: Since Crowd 3.3.0, Group Level Administration was introduced in Crowd Data Center. This included the introduction of new Rest API endpoints that cater for this functionality.
             This includes the following end points.
             /admin/1.0/group-level-admin
             and
             /admin/1.0/groups/

            Some of the new APIs include the {{groupid}} parameter. The documentation, however, does not explain how to obtain this nor there is any REST function that helps in obtaining the ID.

            This causes a confusion, where users who would like to use these endpoints think that this groupid is actually the groupid from the database.

            This is not the case, however, as based on the discussion with the Crowd product team, the groupid is obtained by combining the User Directory the group belongs to and the group name. The group name should be in the base64 URL safe encoding format.

            So for example if directory id is 163841 and the group name's encoding is Y29uZmx1ZW5jZS11c2Vycw then the REST will look like something like this.
             * {{rest/admin/1.0/groups/163841-Y29uZmx1ZW5jZS11c2Vycw}}

            To convert the group name to Base 64 Encoder URL safe format users will need to code their own converter or use online tools such as
             * [Base 64 Encoder (100% client-side) :: OpinionatedGeek
            |https://opinionatedgeek.com/Codecs/Base64Encoder]

            Resolution:
            Explain the process of obtaining the groupid in the official REST API documentation.             		New: Since Crowd 3.3.0, Group Level Administration was introduced in Crowd Data Center. This included the introduction of new Rest API endpoints that cater for this functionality.
             This includes the following end points.
             /admin/1.0/group-level-admin
             and
             /admin/1.0/groups/

            Some of the new APIs include the {{groupid}} parameter. The documentation, however, does not explain how to obtain this nor there is any REST function that helps in obtaining the ID.

            This causes a confusion, where users who would like to use these endpoints think that this groupid is actually the groupid from the database.

            This is not the case, however, as based on the discussion with the Crowd product team, the groupid is obtained by combining the User Directory the group belongs to and the group name. The group name should be in the base64 URL safe encoding format.

            So for example if directory id is 163841 and the group name's encoding is Y29uZmx1ZW5jZS11c2Vycw then the REST will look like something like this.
             * {{rest/admin/1.0/groups/163841-Y29uZmx1ZW5jZS11c2Vycw}}

            To convert the group name to Base 64 Encoder URL safe format users will need to code their own converter or use online tools such as
             * [Base 64 Encoder (100% client-side) :: OpinionatedGeek|https://opinionatedgeek.com/Codecs/Base64Encoder]

            Resolution:
            Explain the process of obtaining the groupid in the official REST API documentation.
            Ahmad Faridi created issue -

              Unassigned Unassigned
              afaridi Ahmad Faridi
              Votes:
              6 Vote for this issue
              Watchers:
              7 Start watching this issue

                Created:
                Updated: