Search documentation
karat

+

K

User Documentation ↗
Version 2.0

List Current Groups

GET/api/v2/admin/groups/listCurrent
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Returns all Groups which contain the current user as a direct or transitive member. For example if the current user is a member of Group A and Group A is a member of Group B, this endpoint will return Group A and Group B.

Unlike the list Group Memberships endpoint which requires the api:admin-read scope, this endpoint does not require any particular scopes and can be used by any authenticated user to retrieve their own group memberships.

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Response body

ListCurrentGroupsResponse
object
Hide child attributes

Hide child attributes

data
list<Group>
optional
Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/admin/groups/listCurrent?preview=true"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 { "data": [ { "name": "Data Source Admins", "organizations": [ "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa" ], "description": "Create and modify data sources in the platform", "realm": "palantir-internal-realm", "attributes": { "multipass:givenName": [ "John" ], "multipass:familyName": [ "Smith" ], "multipass:email:primary": [ "jsmith@example.com" ], "multipass:realm": [ "eab0a251-ca1a-4a84-a482-200edfb8026f" ], "multipass:organization-rid": [ "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa" ], "department": [ "Finance" ], "jobTitle": [ "Accountant" ] }, "id": "0d1fe74e-2b70-4a93-9b1a-80070637788b" } ] }

Error responses

Error Name
ListCurrentGroupsPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not listCurrent the Group.
Parameters