Update Connection

put

https://{region}.api.jamfcloud.com/sso/v1/connections/{connectionId}

Replaces the settings of a connection and reapplies which domains and products it serves, so a change to either takes effect in the same call. Returns the updated connection as GET /connections/{connectionId} would.

The request body is the same as POST /connections and is a full replacement, not a patch: omitting a field clears it rather than leaving it unchanged, so read the connection first and send back the complete settings. connectionType and connection.region must match the existing connection — this endpoint cannot move a connection to another provider type or region.

Omit clientSecret to leave the stored secret in place; supply it to rotate it. Removing a domain from domains stops users on that domain being redirected to this provider.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

connectionId

string

required

length between 1 and 64

Identifier of the connection, as returned in the id field of a connection.

Body Params

The complete connection settings, and what it is enabled for.

A connection to create or replace, together with the domains and products it serves.

connectionType

string

enum

required

Provider type, which selects the settings expected in connection.

Allowed:

connection

required

Provider settings, in the shape matching connectionType.

domains

array of strings

required

length ≥ 1

Verified domains the connection signs users in for. Every domain must already be verified for the organization.

domains*

A verified domain.

enabledProducts

array of objects

required

Products, and the tenants of those products, the connection is enabled for. Send an empty array to enable the connection for no tenant-scoped product.

enabledProducts*

enabledEnvironments

array of objects | null

Products scoped by environment rather than by tenant, if any. Omit unless a product requires it.

enabledEnvironments

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

200The updated connection.

400Bad Request. A field failed validation (FIELD_VALIDATION, with field naming it), the request was rejected for another reason the caller can correct (BAD_REQUEST), or the body could not be parsed as JSON (MALFORMED_REQUEST_BODY).

401Unauthorized. The access token is missing, invalid, or expired. The API Gateway rejects the request before it reaches the service.

403Forbidden. The token is not an external M2M token, or it does not carry the privilege required to reach this endpoint.

404Not Found. No connection with this identifier is configured for the organization.

500Internal Server Error. The organization in the token could not be resolved, or an upstream dependency failed. The description is deliberately generic; quote traceId when reporting the failure.