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.
objectstringstringThe primary host name of the Organization. This should be used when constructing URLs for users of this Organization.
stringobjectThe replaced Organization
stringstringstringstringThe ID of this Organization's underlying marking. Organization guest access can be managed by updating the membership of this Marking.
stringThe primary host name of the Organization. This should be used when constructing URLs for users of this Organization.
1
2
3
4
5
curl -X PUT \
-H "Content-type: application/json" \
-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"}'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 Name | ||
|---|---|---|
Invalid | 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 | |
Replace | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not replace the Organization. | |
| Parameters | organizationRid | |
See Errors for a general overview of errors in the platform.