Skip to navigation

List user groups for a user

Requires attribute-based access control to be enabled for your account.

Authentication

AuthorizationApi-Key

Type “Api-Key” followed by a space and the project API key.

Path parameters

user_uuidstringRequired
User UUID

Query parameters

page_sizeintegerOptional1-200Defaults to 50

The maximum number of items in one page. The SDK method returns a pager. In Python, .items holds only the first page. In TypeScript, .data holds only the first page. To read every page, iterate the pager: use for or list(...) in Python, or for await in TypeScript. In Go, the method returns one page, and Iterator() reads all pages.

cursorstringOptional
Opaque page cursor

Response

OK
itemslist of objectsOptional
The user groups on this page.
next_cursorstringOptional

The cursor to pass as the next request’s cursor to fetch the following page; absent when no further pages remain.

total_sizeintegerOptional
The total number of matching user groups, counted at the time of this response. It does not indicate whether more pages remain.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error