Replace Organization

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

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.

Replace the Organization with the specified rid.

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

Path parameters

organizationRid

string

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Request body

ReplaceOrganizationRequest

object

Hide child attributes

name

string

host

string

optional

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

description

string

optional

Response body

Organization

object

The replaced Organization

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!

curl -X PUT \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/admin/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa?preview=true" \
	-d '{"name":"Example Organization","host":"example.palantirfoundry.com"}'

Response

Copied!

{
  "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
`InvalidHostName`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	The provided hostname must be a valid domain name. The only allowed characters are letters, numbers, periods, and hyphens.
	Parameters	`invalidHostName`
`OrganizationNameAlreadyExists`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	An organization with the same name already exists.
	Parameters	`displayName`
`ReplaceOrganizationPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not replace the Organization.
	Parameters	`organizationRid`
`OrganizationNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given Organization could not be found.
	Parameters	`organizationRid`

See Errors for a general overview of errors in the platform.