Skip to main content

List a user's organizations and roles

GET 
/api/v1/users/{userId}/orgs

Returns the organizations the user belongs to, with the user's role in each, as a tree. The response is paged: totalCount counts root organizations, and each item lists its sub-organizations in children. skipCount and maxResultCount apply to root organizations. Sub-organizations under each root are always returned in full and are not limited by paging. Usage GET /users/{userId}/orgs?orgId={Guid}&orgName={string}

Parameters

  • userId (string, required): ID of the user.

Responses

  • 200 OK: list of organizations with associated roles for the user. When orgId, orgName or filter matches a sub-organization, the response includes that sub-organization and the organizations above it.
  • 403 Forbidden: caller does not have permission to access the user.
  • 404 Not Found: user not found.

Security

  • This API requires authentication.

Request​

Responses​

OK