Multi-tenancy authentication API reference - create external connection

Create External Connection

POSThttps://test.stytch.com/v1/b2b/sso/external/{organization_id}

Create a new External SSO Connection.

RBAC Enforced API

When a Member Session is passed in the Authorization headers, Stytch will enforce that the Member has permission to take the create Action on the stytch.sso Resource prior to honoring the request.

To learn more, see our RBAC guide.

Path parameters

organization_id* string

Body parameters

display_name string

external_organization_id* string

external_connection_id* string

Header parameters

X-Stytch-Member-Session string

X-Stytch-Member-SessionJWT string

Response fields

status_code int

request_id string

connection object

curl --request POST \
  --url https://test.stytch.com/v1/b2b/sso/external/organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931 \
  -u 'PROJECT_ID:SECRET' \
  -H 'Content-Type: application/json' \
  -H "X-Stytch-Member-Session: mZAYn5aLEqKUlZ_Ad9U_fWr38GaAQ1oFAhT8ds245v7Q" \
  -d '{
    "external_organization_id": "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
    "external_connection_id": "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
    "display_name": "Example External connection"
  }'

RESPONSE

{
	"connection": {
		"connection_id": "external-connection-test-5c44cc6a-8af7-48d6-8da7-ea821342f5a6",
		"display_name": "Example External Connection",
		"organization_id": "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
		"external_organization_id": "organization-test-ca6dbe77-10e5-4403-805a-b117c55c24c6",
		"external_connection_id": "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
		"status": "active",
	},
	"request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
	"status_code": 200
}

Common Error Types

duplicate_external_sso_connection