Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get Organization

GET/api/v2/admin/organizations/{organizationRid}

Get the Organization with the specified rid.

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

Path parameters

organizationRid
string

Response body

Organization
object
Hide child attributes

Hide child attributes

rid
string
name
string
description
string
optional
markingId
string

The ID of this Organization's underlying marking. Organization guest access can be managed by updating the membership of this Marking.

host
string
optional

The primary host name of the Organization. This should be used when constructing URLs for users of this Organization.

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/admin/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"

Response

Copied!
1 2 3 4 5 6 { "name": "Example Organization", "host": "example.palantirfoundry.com", "rid": "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa", "markingId": "18212f9a-0e63-4b79-96a0-aae04df23336" }

Error responses

Error Name
OrganizationNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given Organization could not be found.
ParametersorganizationRid