When replacing groups, you must send all attributes that begin with multipass: exactly as they appear when calling the Get Group endpoint.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-write.
objectstringThe name of the Group.
list<OrganizationRid>The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed.
stringA description of the Group.
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.
objectThe replaced Group
stringA Foundry Group ID.
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.
1
2
3
4
5
curl -X PUT \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/admin/groups/0d1fe74e-2b70-4a93-9b1a-80070637788b" \
-d '{"name":"Data Source Admins","organizations":["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"],"description":"Create and modify data sources in the platform","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"]}}'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
{
"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 Name | ||
|---|---|---|
Invalid | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | At least one Organization RID must be provided for a group | |
| Parameters | | |
Group | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | A group with this name already exists | |
| Parameters | groupName | |
Attributes | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | One or more attributes are not editable. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are not editable. | |
| Parameters | attributeNames | |
Replace | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not replace the Group. | |
| Parameters | groupId | |
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.