List all usergroups

GET {{baseUrl}}/user-groups?organizationId=<string>&userId=<string>&number=0&size=10&filter=<string>&sort=<string>

Lists all usergroups

Request Params

KeyDatatypeRequiredDescription
organizationIdstring(Required) Specifies the ID of the organization
userIdstringSpecifies the ID of the relevant user
numbernumberIndex of page to be returned. Number of available pages is returned in response body property page.totalPages.
sizenumberSpecifies the number of elements in a page. Maximum number of resources to be returned per page. The service might return less resources.
filterstringJSON string allowing to filter for the following optional fields and operations.

JSON string can contain following fields:

  • id E.g.: {"id":275}
  • name E.g.: {"name":"CISCO"}
  • parentId E.g.: {"parentId":263}

In the following, an unencoded example filter value is shown, to return the connector instances for given asset and parameters.

{ 
  &quot;name&quot;:&quot;CISCO&quot;
}

| | sort | string | | Specifies the fields to sort the results by.

Ex: GET /resources?sort=-color,+name : Sorts the results based on descending color order and ascending name order. |

HEADERS

KeyDatatypeRequiredDescription
If-None-MatchstringSpecifies the ETag of the resource
x-user-rolestring(Required) Specifies the user role with which the user intends to perform the operation
Acceptstring

RESPONSES

status: OK

{&quot;userGroups&quot;:[{&quot;id&quot;:&quot;a1b2c3d4&quot;,&quot;name&quot;:&quot;service technicians&quot;,&quot;meta&quot;:{&quot;version&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}},{&quot;id&quot;:&quot;a1b2c3d4&quot;,&quot;name&quot;:&quot;service technicians&quot;,&quot;meta&quot;:{&quot;version&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}}],&quot;meta&quot;:{&quot;page&quot;:{&quot;totalPages&quot;:-20356445,&quot;number&quot;:96632399,&quot;size&quot;:66977943,&quot;elements&quot;:61441035,&quot;totalElements&quot;:68503819}}}