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 Organization.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-write.
objectlist<PrincipalId>The initial administrators of the Organization. At least one principal must be provided.
stringThe RID of the Enrollment that this Organization belongs to. This must be provided.
stringstringThe primary host name of the Organization. This should be used when constructing URLs for users of this Organization.
stringobjectThe created 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 POST \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/admin/organizations?preview=true" \
-d '{"enrollmentRid":"ri.control-panel.main.customer.466f812b-f974-4478-9d4f-90402cd3def6","name":"Example Organization","host":"example.palantirfoundry.com","administrators":["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]}'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 | ||
|---|---|---|
Create | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | At least one organization:administrator role grant must be provided when creating a organization. | |
| Parameters | | |
Organization | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | An organization with the same name already exists. | |
| Parameters | displayName | |
Principal | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | A principal (User or Group) with the given PrincipalId could not be found | |
| Parameters | principalId | |
Create | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not create the Organization. | |
| Parameters | | |
Enrollment | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given Enrollment could not be found. | |
| Parameters | enrollmentRid | |
Organization | 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.