Assign Tenants To Environment

Adds tenants to an environment of the organization resolved from the access token.

Additive despite being a PUT: the tenants already in the environment stay in it, and a tenant omitted from tenantIds is not removed. There is no way to unassign a tenant or move it to another environment over this API, so a tenant that already belongs to an environment is rejected with 409 rather than moved.

Every tenant named must be one of the organization's own unassigned tenants — read GET /tenants and look for a null environmentId. The request is resolved and checked in full before anything is written, so a request naming one ineligible tenant assigns none of them.

Which tenants may share an environment is constrained:

  • one management product per environment — Jamf Pro, Jamf School or Jamf
    Now, but not two of them
  • one tenant per product family, so Jamf Pro with Jamf Protect and Jamf
    Security Cloud is fine while a second Jamf Protect is not
  • every tenant in the environment's metaRegion, with Jamf Security
    Cloud exempt because it is global. An environment created without a
    metaRegion is global and constrains nothing

The rules are applied to the tenants already in the environment plus the earlier tenants of the same request, so one request cannot introduce a combination two requests would be refused. A 409 names the rule that refused it in code.

The response has no body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 64

Jamf-assigned identifier of the environment, as returned in the id field of an environment. Treat it as an opaque string.

Body Params

The tenants to add to the environment.

The tenants to add to an environment. Additive: the tenants already in the environment are kept.

tenantIds
array of strings
required
length ≥ 1

Identifiers of the tenants to add, as returned in the id field of a tenant. Every one must be an unassigned tenant of the organization, and no identifier may be repeated.

tenantIds*

Identifier of one of the organization's unassigned tenants.

Responses
204

The tenants were added to the environment. The response has no body.

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json