Search documentation
karat

+

K

User Documentation ↗

Create Group

POST/api/v2/admin/groups
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.

Creates a new Group.

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

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Request body

CreateGroupRequest
object
Hide children

Hide children

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 children

Show children

OrganizationRid
string
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 children

Show children

AttributeName
string
AttributeValues
list<AttributeValue>
Show children

Show children

AttributeValue
string

Response body

Group
object

The created Group

Hide children

Hide children

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 children

Show children

OrganizationRid
string
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 children

Show children

AttributeName
string
AttributeValues
list<AttributeValue>
Show children

Show children

AttributeValue
string

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?preview=true" \ -d '{"name":"Data Source Admins","organizations":["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"],"description":"Create and modify data sources in the platform"}'

Response

Copied!
1 2 3 4 5 6 7 8 9 { "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", "id": "f05f8da4-b84c-4fca-9c77-8af0b13d11de" }