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

CROWD REST API for /rest/admin/1.0/group-level-admin/ are unclear and need more clarity on usage

XMLWordPrintable

    • Icon: Suggestion Suggestion
    • Resolution: Unresolved
    • None
    • Documentation, REST
    • None
    • 2

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

      Problem

      Some of the CROWD REST apis specified from the official document do not have explanation on how to use them. 

      For example, from the official document : https://docs.atlassian.com/atlassian-crowd/4.4.1/REST/#admin/1.0/group-level-admin-addGroupAdministrators

      Also the POST data shared in the document are schema details and are not the payload details that are required to be passed in the API. 

      Suggested Solution

      Would like to request more information on these documents and provide an example for each call so that users can understand the usage better.

      Why This Is Important

      Since users are unable to use the REST api features correctly due to lack of information.

      Workaround

      This operation can be performed manually through the UI.

            [CWD-5788] CROWD REST API for /rest/admin/1.0/group-level-admin/ are unclear and need more clarity on usage

            SET Analytics Bot made changes -
            Support reference count New: 2

            remi.grenier@airbus.com added a comment -

            Hi,

            I'm interested by this problem because I have the same!

            Did you find a solution ?

            remi.grenier@airbus.com added a comment - Hi, I'm interested by this problem because I have the same! Did you find a solution ?

            Dave Thomas added a comment -

            Adding to the confusion: One would expect that a group admin would be able to use the REST api to add/remove people from the group. Apparently that's not the case? You have to be a full system admin in crowd in order to exercise the relevant REST api endpoints? @Atlassian - If you're not going to fix this, please at least document the half-baked functions you've already delivered.

            Dave Thomas added a comment - Adding to the confusion: One would expect that a group admin would be able to use the REST api to add/remove people from the group. Apparently that's not the case? You have to be a full system admin in crowd in order to exercise the relevant REST api endpoints? @Atlassian - If you're not going to fix this, please at least document the half-baked functions you've already delivered.

            DaveT added a comment -

            Leaving this link here since Atlassian can't be bothered to fix the documentation or even drop a clue in the description of this issue.

            https://community.atlassian.com/t5/Crowd-questions/How-do-you-get-the-groupId-required-by-the-Crowd-group-level/qaq-p/1127534

            DaveT added a comment - Leaving this link here since Atlassian can't be bothered to fix the documentation or even drop a clue in the description of this issue. https://community.atlassian.com/t5/Crowd-questions/How-do-you-get-the-groupId-required-by-the-Crowd-group-level/qaq-p/1127534
            Sathya Ganeshan made changes -
            Description Original: h3. Problem

            Some of the CROWD REST apis specified from the official document do not have explanation on how to use them. 

            For example, from the official document : [https://docs.atlassian.com/atlassian-crowd/4.4.1/REST/#admin/1.0/group-level-admin-addGroupAdministrators]
            h3. Suggested Solution

            Would like to request more information on these documents and provide an example for each call so that users can understand the usage better.
            h3. Why This Is Important

            _Since users are unable to use the REST api features correctly due to lack of information._
            h3. Workaround

            _This operation can be performed manually through the UI._             		New: h3. Problem

            Some of the CROWD REST apis specified from the official document do not have explanation on how to use them. 

            For example, from the official document : [https://docs.atlassian.com/atlassian-crowd/4.4.1/REST/#admin/1.0/group-level-admin-addGroupAdministrators]

            Also the POST data shared in the document are schema details and are not the payload details that are required to be passed in the API. 
            h3. Suggested Solution

            Would like to request more information on these documents and provide an example for each call so that users can understand the usage better.
            h3. Why This Is Important

            _Since users are unable to use the REST api features correctly due to lack of information._
            h3. Workaround

            _This operation can be performed manually through the UI._
            Sathya Ganeshan made changes -
            Description Original: h3. Problem

            Some of the CROWD REST apis specified from the official document do not have explanation on how to use them. 

            For example, from the official document : [https://docs.atlassian.com/atlassian-crowd/4.4.1/REST/#admin/1.0/group-level-admin-addGroupAdministrators]

            The following is the syntax to include a group administrator:

            POST /rest/admin/1.0/group-level-admin/\{groupId}/admins 

            Post Body:

            { "id": "https://docs.atlassian.com/jira/REST/schema/list-of-directory-entity-rest#", "title": "List of Directory Entity Rest", "type": "array", "items": { "title": "Directory Entity Rest", "type": "object", "properties": { "id":

            { "title": "Directory Entity Id", "type": "object" }

            , "type":

            { "type": "string", "enum": [ "USER", "GROUP" ] }

            }, "additionalProperties": false }
            }
            h3. Suggested Solution

            Would like to request more information on these documents and provide an example for each call so that users can understand the usage better.
            h3. Why This Is Important

            _Since users are unable to use the REST api features correctly due to lack of information._
            h3. Workaround

            _This operation can be performed manually through the UI._             		New: h3. Problem

            Some of the CROWD REST apis specified from the official document do not have explanation on how to use them. 

            For example, from the official document : [https://docs.atlassian.com/atlassian-crowd/4.4.1/REST/#admin/1.0/group-level-admin-addGroupAdministrators]
            h3. Suggested Solution

            Would like to request more information on these documents and provide an example for each call so that users can understand the usage better.
            h3. Why This Is Important

            _Since users are unable to use the REST api features correctly due to lack of information._
            h3. Workaround

            _This operation can be performed manually through the UI._
            Sathya Ganeshan made changes -
            Description Original: h3. Problem

            Some of the CROWD REST apis specified from the official document do not appear to return the expected results or there is no correct explanation of how to use them

            For example, from the official document : [https://docs.atlassian.com/atlassian-crowd/4.4.1/REST/#admin/1.0/group-level-admin-addGroupAdministrators]

            The following is the syntax to include a group administrator:

            POST /rest/admin/1.0/group-level-admin/\{groupId}/admins 

            Post Body:

            { "id": "https://docs.atlassian.com/jira/REST/schema/list-of-directory-entity-rest#", "title": "List of Directory Entity Rest", "type": "array", "items": { "title": "Directory Entity Rest", "type": "object", "properties": { "id":

            { "title": "Directory Entity Id", "type": "object" }

            , "type":

            { "type": "string", "enum": [ "USER", "GROUP" ] }

            }, "additionalProperties": false }
            }
            h3. Suggested Solution

            Would like to request more information on these documents and provide an example for each call so that users can understand the usage better.
            h3. Why This Is Important

            _Since users are unable to use the REST api features correctly due to lack of information._
            h3. Workaround

            _This operation can be performed manually through the UI._             		New: h3. Problem

            Some of the CROWD REST apis specified from the official document do not have explanation on how to use them. 

            For example, from the official document : [https://docs.atlassian.com/atlassian-crowd/4.4.1/REST/#admin/1.0/group-level-admin-addGroupAdministrators]

            The following is the syntax to include a group administrator:

            POST /rest/admin/1.0/group-level-admin/\{groupId}/admins 

            Post Body:

            { "id": "https://docs.atlassian.com/jira/REST/schema/list-of-directory-entity-rest#", "title": "List of Directory Entity Rest", "type": "array", "items": { "title": "Directory Entity Rest", "type": "object", "properties": { "id":

            { "title": "Directory Entity Id", "type": "object" }

            , "type":

            { "type": "string", "enum": [ "USER", "GROUP" ] }

            }, "additionalProperties": false }
            }
            h3. Suggested Solution

            Would like to request more information on these documents and provide an example for each call so that users can understand the usage better.
            h3. Why This Is Important

            _Since users are unable to use the REST api features correctly due to lack of information._
            h3. Workaround

            _This operation can be performed manually through the UI._
            Sathya Ganeshan made changes -
            Description Original: h3. Problem

            Some of the CROWD REST apis specified from the official document do not appear to return the right results or there is no correct explanation of how to use them

            For example, from the official document : [https://docs.atlassian.com/atlassian-crowd/4.4.1/REST/#admin/1.0/group-level-admin-addGroupAdministrators]

            The following is the syntax to include a group administrator:

            POST /rest/admin/1.0/group-level-admin/\{groupId}/admins 

            Post Body:

            { "id": "https://docs.atlassian.com/jira/REST/schema/list-of-directory-entity-rest#", "title": "List of Directory Entity Rest", "type": "array", "items": { "title": "Directory Entity Rest", "type": "object", "properties": { "id":

            { "title": "Directory Entity Id", "type": "object" }

            , "type":

            { "type": "string", "enum": [ "USER", "GROUP" ] }

            }, "additionalProperties": false }
            }

            But using this results in : 
            Can not deserialize instance of java.util.ArrayList out of START_OBJECT token
            Similarly, there are other calls that do not have the right usage syntax or returns error when using with the syntax provided in the document.
            h3. Suggested Solution

            Would like to request more clarity on these documents and provide an example for each call so that users can understand the usage better.
            h3. Why This Is Important

            _Since users are unable to use the REST api features correctly due to lack of information._
            h3. Workaround

            _This operation can be performed manually through the UI._             		New: h3. Problem

            Some of the CROWD REST apis specified from the official document do not appear to return the expected results or there is no correct explanation of how to use them

            For example, from the official document : [https://docs.atlassian.com/atlassian-crowd/4.4.1/REST/#admin/1.0/group-level-admin-addGroupAdministrators]

            The following is the syntax to include a group administrator:

            POST /rest/admin/1.0/group-level-admin/\{groupId}/admins 

            Post Body:

            { "id": "https://docs.atlassian.com/jira/REST/schema/list-of-directory-entity-rest#", "title": "List of Directory Entity Rest", "type": "array", "items": { "title": "Directory Entity Rest", "type": "object", "properties": { "id":

            { "title": "Directory Entity Id", "type": "object" }

            , "type":

            { "type": "string", "enum": [ "USER", "GROUP" ] }

            }, "additionalProperties": false }
            }
            h3. Suggested Solution

            Would like to request more information on these documents and provide an example for each call so that users can understand the usage better.
            h3. Why This Is Important

            _Since users are unable to use the REST api features correctly due to lack of information._
            h3. Workaround

            _This operation can be performed manually through the UI._
            Sathya Ganeshan made changes -
            Description Original: h3. Problem

            Many of the CROWD REST apis specified from the official document do not work or there is no proper explanation of how to use them

            For example, from the official document : [https://docs.atlassian.com/atlassian-crowd/4.4.1/REST/#admin/1.0/group-level-admin-addGroupAdministrators]

            The following is the syntax to include a group administrator:

            POST /rest/admin/1.0/group-level-admin/\{groupId}/admins 

            Post Body:

            { "id": "https://docs.atlassian.com/jira/REST/schema/list-of-directory-entity-rest#", "title": "List of Directory Entity Rest", "type": "array", "items": { "title": "Directory Entity Rest", "type": "object", "properties": { "id":

            { "title": "Directory Entity Id", "type": "object" }

            , "type":

            { "type": "string", "enum": [ "USER", "GROUP" ] }

            }, "additionalProperties": false }
            }

            But using this results in : 
            Can not deserialize instance of java.util.ArrayList out of START_OBJECT token
            Similarly, there are other calls that do not have the right usage syntax or returns error when using with the syntax provided in the document.
            h3. Suggested Solution

            Would like to request more clarity on these documents and provide an example for each call so that users can understand the usage better.
            h3. Why This Is Important

            _Since users are unable to use the REST api features correctly due to lack of information._
            h3. Workaround

            _This operation can be performed manually through the UI._             		New: h3. Problem

            Some of the CROWD REST apis specified from the official document do not appear to return the right results or there is no correct explanation of how to use them

            For example, from the official document : [https://docs.atlassian.com/atlassian-crowd/4.4.1/REST/#admin/1.0/group-level-admin-addGroupAdministrators]

            The following is the syntax to include a group administrator:

            POST /rest/admin/1.0/group-level-admin/\{groupId}/admins 

            Post Body:

            { "id": "https://docs.atlassian.com/jira/REST/schema/list-of-directory-entity-rest#", "title": "List of Directory Entity Rest", "type": "array", "items": { "title": "Directory Entity Rest", "type": "object", "properties": { "id":

            { "title": "Directory Entity Id", "type": "object" }

            , "type":

            { "type": "string", "enum": [ "USER", "GROUP" ] }

            }, "additionalProperties": false }
            }

            But using this results in : 
            Can not deserialize instance of java.util.ArrayList out of START_OBJECT token
            Similarly, there are other calls that do not have the right usage syntax or returns error when using with the syntax provided in the document.
            h3. Suggested Solution

            Would like to request more clarity on these documents and provide an example for each call so that users can understand the usage better.
            h3. Why This Is Important

            _Since users are unable to use the REST api features correctly due to lack of information._
            h3. Workaround

            _This operation can be performed manually through the UI._
            Sathya Ganeshan made changes -
            Description Original: h3. Problem

            Many of the CROWD REST apis specified from the official document do not work or there is no proper explanation of how to use them

            For example, from the official document : [https://docs.atlassian.com/atlassian-crowd/4.4.1/REST/#admin/1.0/group-level-admin-addGroupAdministrators]

            The following is the syntax to include a group administrator:

            POST /rest/admin/1.0/group-level-admin/\{groupId}/admins 

            Post Body:

            { "id": "https://docs.atlassian.com/jira/REST/schema/list-of-directory-entity-rest#", "title": "List of Directory Entity Rest", "type": "array", "items": { "title": "Directory Entity Rest", "type": "object", "properties": { "id":

            { "title": "Directory Entity Id", "type": "object" }

            , "type":

            { "type": "string", "enum": [ "USER", "GROUP" ] }

            }, "additionalProperties": false }
            }

            But using this results in : 
            Can not deserialize instance of java.util.ArrayList out of START_OBJECT token
            Similarly, there are other calls that do not have the right usage syntax or returns error when using with the syntax provided in the document.
            h3. Suggested Solution

            Would like to request the documentation, dev teams to provide more clarity on these documents and provide an example for each call so that users can understand their usage better.
            h3. Why This Is Important

            _Since users are unable to use the REST api features correctly due to lack of information._
            h3. Workaround

            _This operation can be performed manually through the UI._             		New: h3. Problem

            Many of the CROWD REST apis specified from the official document do not work or there is no proper explanation of how to use them

            For example, from the official document : [https://docs.atlassian.com/atlassian-crowd/4.4.1/REST/#admin/1.0/group-level-admin-addGroupAdministrators]

            The following is the syntax to include a group administrator:

            POST /rest/admin/1.0/group-level-admin/\{groupId}/admins 

            Post Body:

            { "id": "https://docs.atlassian.com/jira/REST/schema/list-of-directory-entity-rest#", "title": "List of Directory Entity Rest", "type": "array", "items": { "title": "Directory Entity Rest", "type": "object", "properties": { "id":

            { "title": "Directory Entity Id", "type": "object" }

            , "type":

            { "type": "string", "enum": [ "USER", "GROUP" ] }

            }, "additionalProperties": false }
            }

            But using this results in : 
            Can not deserialize instance of java.util.ArrayList out of START_OBJECT token
            Similarly, there are other calls that do not have the right usage syntax or returns error when using with the syntax provided in the document.
            h3. Suggested Solution

            Would like to request more clarity on these documents and provide an example for each call so that users can understand the usage better.
            h3. Why This Is Important

            _Since users are unable to use the REST api features correctly due to lack of information._
            h3. Workaround

            _This operation can be performed manually through the UI._

              Unassigned Unassigned
              sganeshan@atlassian.com Sathya Ganeshan
              Votes:
              5 Vote for this issue
              Watchers:
              9 Start watching this issue

                Created:
                Updated: