Create connector

post

https://{region}.api.jamfcloud.com/securitycloud/uem-connect/v1/connectors

Creates a new connector for the tenant. On success returns the identifier of the created
connector together with an href locating it, as a path relative to the base URL the
request was made against.

A tenant may hold only one connector, with the single exception that Jamf Pro and Wizy may
coexist. Requesting any other second connector fails with 409 CONNECTOR_CONFIG_ALREADY_EXISTS.

Creation runs a connection test against the supplied URL and credentials. A failing test
yields 400 UEM_CONNECTION_FAILED, and a UEM platform running an unsupported version yields
409 UNSUPPORTED_UEM_VERSION.

Required Permissions: uem-connect:create

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Connector creation request for Jamf Pro.

The authStrategy field selects how JSC authenticates to Jamf Pro and determines which
further fields are required:

JAMF_PRO_OAUTH — provide deviceSyncAuth.clientId and deviceSyncAuth.clientSecret
(Jamf Pro API-role OAuth client credentials).
BASIC — provide deviceSyncAuth.username and deviceSyncAuth.password.
M2M — provide tenantId; deviceSyncAuth must be omitted (JSC authenticates through the
shared machine-to-machine trust rather than per-connector credentials).

The credential fields (deviceSyncAuth.password, deviceSyncAuth.clientSecret) are
write-only. tenantId is likewise write-only: it is accepted on creation but not returned
in responses. Write-only fields are never echoed back in any response.

vendor

string

enum

required

UEM vendor discriminator

Allowed:

url

string

required

length ≥ 1

Jamf Pro server URL

isoCountry

string

ISO country code for the UEM instance, when applicable

authStrategy

string

enum

required

Authentication strategy used to connect to Jamf Pro. See the schema description for the
fields each strategy requires.

Allowed:

deviceSyncAuth

object

Jamf Pro connection credentials. Provide the OAuth pair (clientId + clientSecret) when
authStrategy is JAMF_PRO_OAUTH, or the basic pair (username + password) when
authStrategy is BASIC. Omit entirely for M2M.

tenantId

string

Jamf Pro tenant identifier. Required when authStrategy is M2M; must be omitted for
the other strategies.

Headers

X-Tenant-Id

uuid

required

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The tenant UUID identifier.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Connector created successfully

400Bad request — the connector configuration was well-formed but could not be established against the UEM platform. Error code: UEM_CONNECTION_FAILED — the connection test against the supplied URL and credentials failed.

406Not acceptable — the request Accept header cannot be satisfied by this operation, which only produces application/json. Error code: NOT_ACCEPTABLE.

415Unsupported media type — the request body Content-Type is not one this operation accepts, or it was omitted. Send application/json. Error code: UNSUPPORTED_MEDIA_TYPE.