Update SAML Connection URL

Update SAML Connection by Metadata URL

PUT

https://test.stytch.com/v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/url

Used to update an existing SAML connection using an IDP metadata URL.

A newly created connection will not become active until all the following are provided:

idp_sso_url
idp_entity_id
x509_certificate
attribute_mapping (must be supplied using Update SAML 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 update Action on the stytch.sso Resource prior to honoring the request.

To learn more, see our RBAC guide.

Path parameters

organization_id string

connection_id string

Body parameters

metadata_url* string

Header parameters

X-Stytch-Member-Session string

X-Stytch-Member-SessionJWT string

Response fields

status_code int

request_id string

connection object

const stytch = require('stytch');

const client = new stytch.B2BClient({
  project_id: 'PROJECT_ID',
  secret: 'SECRET',
});

const params = {
  organization_id: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
  connection_id: "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
  metadata_url: "https://idp.example.com/app/51861cbc-d3b9-428b-9761-227f5fb12be9/sso/saml/metadata",
};

const options = {
  authorization: {
    session_token: 'mZAYn5aLEqKUlZ_Ad9U_fWr38GaAQ1oFAhT8ds245v7Q',
  },
};

client.sso.saml.updateByURL(params, options)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });

RESPONSE

{
  "connection": {
		"acs_url": "https://test.stytch.com/v1/b2b/sso/callback/saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
		"alternative_acs_url": "",
		"attribute_mapping": {
			"email": "email",
			"full_name": "name"
		},
		"audience_uri":  "https://test.stytch.com/v1/b2b/sso/callback/saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
		"connection_id": "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
		"display_name": "Example SAML Connection",
		"idp_entity_id": "https://idp.example.com/51861cbc-d3b9-428b-9761-227f5fb12be9",
		"idp_sso_url": "https://idp.example.com/51861cbc-d3b9-428b-9761-227f5fb12be9/sso/saml",
		"nameid_format": "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress",
		"organization_id": "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
		"signing_certificates": [
			{
				"certificate": "-----BEGIN CERTIFICATE-----\n...base64 blob...\n-----END CERTIFICATE",
				"created_at": "2023-01-01T00:00:00Z",
				"expires_at": "2033-01-01T00:00:00Z",
				"id": "",
				"issuer": "Stytch"
			}
		],
		"identity_provider": "generic",
		"status": "active",
		"verification_certificates": [
			{
				"certificate": "-----BEGIN CERTIFICATE-----\n...base64 blob...\n-----END CERTIFICATE",
				"created_at": "2023-01-01T00:00:00Z",
				"expires_at": "2033-01-01T00:00:00Z",
				"id": "saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701",
				"issuer": ""
			}
		],
		"idp_initiated_auth_disabled": false
	},
	"request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
	"status_code": 200
}

Delete

Organization

Discovery

Organization

Discovery

Discovery

Organization

Token

SAML

OIDC

External

Shared

Connection management

Token management

SCIM groups

Reset Options

One-time passcodes

Time-based one-time passcodes

Recovery codes

TOKEN

M2M Client

Rotate secret

Tokens

Configuration

Methods

Management

Update SAML Connection by Metadata URL

Path parameters

Body parameters

Header parameters

Response fields

Common Error Types