How to handle GOAWAY response

[Constantin Noll]

Hello,

I use the Jira ReST API to collect all users with their groups and roles.

Therefore, I call the search[1] to get all users and then I call each single user detail page[2] to get the roles and groups for the user. (If there is a better way, please tell me.)
From time to time, I get a GOAWAY response from the server.

When I do a retry, I get through in most cases.
But sometimes I don't.

I cannot figure out when a GOAWAY is supposed to happen from the API docs.

Is retrying the expected handling for a GOAWAY?
Then, I could increase the retry count.
I'd like to fix it the right way.

Kind regards
Constantin

[1] https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-users/#api-rest-api-2-users-search-get
[2] https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-users/#api-rest-api-2-user-get

[Hugo Navia]

Hi Constantin,

May I ask you to provide a bit more information?

It would be useful to know why do you need the groups and roles. Also, any chance you get access to the DB? It might be easier and faster this way.

Finally, I see on the side that this is for an OnPrem instance but the links you just shared are for Cloud instance. I'll wait for your reply.

By the way, the Rest API for Server/DC is this one:

https://docs.atlassian.com/software/jira/docs/api/REST/9.8.1/

Kind regards,

Hugo.

[Constantin Noll]

Hello Hugo,

thanks for your fast reply :)

I collect the data for our UAM tool.
This UAM tool queries more than 100 different systems and stores some basic account information. One of these systems is Jira, other are Servicedesk, Confluence, gitlab and so on.
We need to do so to get an overview which employees can access which systems and which rights do they have there in an automated way.

AFAIK the groups and roles contain this information for Jira and Servicedesk.

For servicedesk I also collect the organizations, this is a bit easier.
For organizations I can do a list all organizations, then get the members of each organization and map them.
The same would be possible for the groups.
But I don't see an endpoint to list the members of a role.
So I decided to query the user detail page to get the roles and as the page contains the groups, too. I also read the groups from there.

Obviously, this procedure creates a lot of requests.

I expected to get an 429 Too Many Requests response.
Some endpoints documented this. But I didn't.
Therfore I get a GOAWAY, which I cannot see in the documentation, maybe it's the same.



I had also preferred to get a direct DB access, but the other side preferred me to use the API :)

Thank you for the hint with the onPrem API documentation.
I corrected this in our documentation.
It seems that the endpoints we used stayed the same.

Kind regards
Constantin

[Hugo Navia]

Ok that clarifies things up.

So, the situation is a bit complex because of this:

1. Roles are objects created for the system that projects will use
2. Users and groups are assigned to roles per project and not in the system configuration
   • This means that you need to get the users and their roles per project
3. Groups might be assigned to roles which means that all users assigned to a specific group with specific roles will get the same role as long as they are part of the group.

Now, what you can use is a combination of the following APIs:

• Get project roles

GET /rest/api/2/project/{projectIdOrKey}/role

This one will returns all roles in the given project Id or key, with links to full details on each role.

Using this API you can trim the link and leave only the ID of each role. This is how it looks (id's might differ as this is how it looks in my VM):

{
"Developers": "http://localhost:8080/rest/api/2/project/12250/role/10001",
"Administrators": "http://localhost:8080/rest/api/2/project/12250/role/10002",
"Users": "http://localhost:8080/rest/api/2/project/12250/role/10000"
}

• Now that you get the roles ID's existing in a project, the following API will return all the users and groups assigned to each of the roles per ID:

GET /rest/api/2/project/{projectIdOrKey}/role/{id}

 This will return the details for a given project role in a project.

The result should look something like this:

{
"self": "http://localhost:8080/rest/api/2/project/12250/role/10001",
"name": "Developers",
"id": 10001,
"description": "A project role that represents developers in a project",
"actors": Array[5][
{
"id": 17780,
"displayName": "Group 1",
"type": "atlassian-group-role-actor",
"name": "GroupName",
"avatarUrl": "http://localhost:8080/secure/useravatar?size=xsmall&avatarId=10153"
}
{
"id": 16491,
"displayName": "User 1",
"type": "atlassian-user-role-actor",
"name": "username1",
"avatarUrl": "http://localhost:8080/secure/useravatar?size=xsmall&ownerId=ahpanganiban&avatarId=10330"
}

I think you should be able to build the rest as you will have the group names and user names assigned to different roles and, from there, use other API's to identify the users in each group.

I hope this is clear enough for you. Else, let me know and I will try to provide an example script, although it might take me a bit of time.

Kind regards.

Hugo.