Search documentation
karat

+

K

User Documentation ↗

Create Group

POST/api/v2/admin/groups

Creates a new Group.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-write.

Request body

CreateGroupRequest
object
Hide child attributes

Hide child attributes

name
string

The name of the Group.

organizations
list<OrganizationRid>
optional

The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed.

Show child attributes

Show child attributes

description
string
optional

A description of the Group.

attributes
map<AttributeName, AttributeValues>
optional

A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change.

Show child attributes

Show child attributes

Response body

Group
object

The created Group

Hide child attributes

Hide child attributes

id
string

The ID of a Foundry Group or User.

name
string

The name of the Group.

description
string
optional

A description of the Group.

realm
string

Identifies 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.

organizations
list<OrganizationRid>
optional

The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed.

Show child attributes

Show child attributes

attributes
map<AttributeName, AttributeValues>
optional

A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change.

Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 4 5 curl -X POST \ -H "Content-type: application/json" \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/admin/groups" \ -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"]}}'

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 { "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": "f05f8da4-b84c-4fca-9c77-8af0b13d11de" }