Get All Organization Roles of a User Group

Request

GET <REST API URL>/usergroups/{user group id}/organizationroles?fields=string&$skip=int&$top=int&query=string&orderBy=string

Parameter	Description
`fields`	Optional. Returns only the specified subset of the fields for each OrganizationRole. Use Fields Syntax to define the subset.
`$skip`	Optional. Lets you set a number of OrganizationRoles to skip before returning the first one.
`$top`	Optional. Lets you set the maximum number of OrganizationRoles to return.
`query`	Optional. Lets you specify a search query to filter the returned results. See Query Syntax for the definition of supported logical operations syntax. For the OrganizationRoles, the following fields and tuples are supported: group: group — Organization roles owned by the given group id: value — Role in organization with the given ID organization: organization — Organization roles granted for the given organization permission: permission — Organization roles granted with the given permission project: project — Organization roles granted for the given project role: role — Organization roles granted with the given role user: user — Organization roles owned by the given user
`orderBy`	Optional. Returns the list of OrganizationRoles sorted by a specified field. See Sorting Syntax for details. OrganizationRoles support ordering by the following fields: organization, role

Response Code	Meaning
200 OK	Successful request.
400 Bad Request	At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response.
403 Forbidden	The requester has no access to the requested resource.
404 Not Found	The requested resource was not found.
500 Internal Server Error	Failed to process request because of the server error. For details, check the error message in the response.


  {
    "skip": int, 
    "top": int, 
    "total": int, 
    "organizationroles": [organizationRole, ...]
  }

Last modified: 22 October 2024