Get the Group with the specified id.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-read.
objectstringThe ID of a Foundry Group or User.
stringThe name of the Group.
stringA description of the Group.
stringIdentifies which Realm a User or Group is a member of.
The palantir-internal-realm is used for Users or Groups that are created in Foundry by administrators and not associated with any SSO provider.
list<OrganizationRid>The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed.
map<AttributeName, AttributeValues>A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change.
1curl \
2 -H "Authorization: Bearer $TOKEN" \
3 "https://$HOSTNAME/api/v2/admin/groups/f05f8da4-b84c-4fca-9c77-8af0b13d11de"1{
2 "name": "Data Source Admins",
3 "organizations": [
4 "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
5 ],
6 "description": "Create and modify data sources in the platform",
7 "realm": "palantir-internal-realm",
8 "attributes": {
9 "multipass:givenName": [
10 "John"
11 ],
12 "multipass:familyName": [
13 "Smith"
14 ],
15 "multipass:email:primary": [
16 "jsmith@example.com"
17 ],
18 "multipass:realm": [
19 "eab0a251-ca1a-4a84-a482-200edfb8026f"
20 ],
21 "multipass:organization-rid": [
22 "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
23 ],
24 "department": [
25 "Finance"
26 ],
27 "jobTitle": [
28 "Accountant"
29 ]
30 },
31 "id": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"
32}| Error Name | ||
|---|---|---|
Group | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given Group could not be found. | |
| Parameters | groupId | |
See Errors for a general overview of errors in the platform.