Delete SAML Verification Certificate

// DELETE /v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/verification_certificates/{certificate_id}
const stytch = require('stytch');

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

const params = {
  organization_id: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
  connection_id: "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
  certificate_id: "saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701",
};

const options = {
  authorization: {
    session_token: '${sessionToken}',
  },
};

client.SSO.SAML.DeleteVerificationCertificate(params, options)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });

// DELETE /v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/verification_certificates/{certificate_id}
package main

import (
	"context"
	"log"

	"github.com/stytchauth/stytch-go/v18/stytch/b2b/b2bstytchapi"
	"github.com/stytchauth/stytch-go/v18/stytch/b2b/sso/saml"
	"github.com/stytchauth/stytch-go/v18/stytch/methodoptions"
)

func main() {
	client, err := b2bstytchapi.NewClient(
		"${projectId}",
		"${secret}",
	)
	if err != nil {
		log.Fatalf("error instantiating client: %v", err)
	}

	params := &saml.DeleteVerificationCertificateParams{
		OrganizationID: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
		ConnectionID:   "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
		CertificateID:  "saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701",
	}

	options := &saml.DeleteVerificationCertificateParamsOptions{
		Authorization: methodoptions.Authorization{
			SessionToken: "${sessionToken}",
		},
	}

	resp, err := client.SSO.SAML.DeleteVerificationCertificate(context.Background(), params, options)
	if err != nil {
		log.Fatalf("error in method call: %v", err)
	}

	log.Println(resp)
}

// DELETE /v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/verification_certificates/{certificate_id}
package com.example;

import com.stytch.java.b2b.models.ssosaml.DeleteVerificationCertificateRequest;
import com.stytch.java.b2b.models.ssosaml.DeleteVerificationCertificateRequestOptions;
import com.stytch.java.b2b.StytchB2BClient;
import com.stytch.java.common.methodoptions.Authorization;
import com.stytch.java.common.StytchResult;

public class Main {
    public static void main(String[] args) {
        StytchB2BClient.configure("${projectId}", "${secret}");

        DeleteVerificationCertificateRequest params = new DeleteVerificationCertificateRequest();
        params.setOrganizationId("organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931");
        params.setConnectionId("saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9");
        params.setCertificateId("saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701");

        DeleteVerificationCertificateRequestOptions options = new DeleteVerificationCertificateRequestOptions();
        Authorization authorization = new Authorization();
        authorization.setSessionToken("${sessionToken}");
        options.setAuthorization(authorization);

        Object result = StytchB2BClient.getSSO().getSAML().deleteVerificationCertificate(params, options);
        if (result instanceof StytchResult.Success) {
          System.out.println(((StytchResult.Success) result).getValue());
        } else {
          System.out.println(((StytchResult.Error) result).getException());
        }
    }
}

// DELETE /v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/verification_certificates/{certificate_id}
package com.example

import com.stytch.java.b2b.StytchB2BClient
import com.stytch.java.b2b.models.ssosaml.DeleteVerificationCertificateRequest
import com.stytch.java.b2b.models.ssosaml.DeleteVerificationCertificateRequestOptions
import com.stytch.java.common.methodoptions.Authorization

fun main() {
    StytchB2BClient.configure(
        projectId = "${projectId}",
        secret = "${secret}",
    )

    when (
        val result =
            StytchB2BClient.sso.saml.deleteVerificationCertificate(
                DeleteVerificationCertificateRequest(
                    organizationId = "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
                    connectionId = "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
                    certificateId = "saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701",
                ),
                DeleteVerificationCertificateRequestOptions(
                    Authorization(
                        sessionToken = "${sessionToken}",
                    ),
                ),
            )
    ) {
        is StytchResult.Success -> println(result.value)
        is StytchResult.Error -> println(result.exception)
    }
}

// DELETE /v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/verification_certificates/{certificate_id}
const stytch = require('stytch');

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

const params = {
  organization_id: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
  connection_id: "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
  certificate_id: "saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701",
};

const options = {
  authorization: {
    session_token: '${sessionToken}',
  },
};

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

$response = $client->sso->saml->delete_verification_certificate([
    'organization_id' => 'organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931',
    'connection_id' => 'saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9',
    'certificate_id' => 'saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701',
], [
        'authorization' => ['session_token' => '${sessionToken}'],

]);

# DELETE /v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/verification_certificates/{certificate_id}
from stytch import B2BClient
from stytch.b2b.models.sso_saml import DeleteVerificationCertificateRequestOptions
from stytch.shared.method_options import Authorization

client = B2BClient(
    project_id="${projectId}",
    secret="${secret}",
)

resp = client.sso.saml.delete_verification_certificate(
    organization_id="organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
    connection_id="saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
    certificate_id="saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701",
    method_options=DeleteVerificationCertificateRequestOptions(
        authorization=Authorization(
            session_token="${sessionToken}",
        ),
    ),
)

print(resp)

# frozen_string_literal: true

# DELETE /v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/verification_certificates/{certificate_id}
require 'stytch'

client = StytchB2B::Client.new(
  project_id: "${projectId}",
  secret: "${secret}"
)

resp = client.sso.saml.delete_verification_certificate(
  organization_id: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
  connection_id: "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
  certificate_id: "saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701",
  method_options: StytchB2B::SSO::SAML::DeleteVerificationCertificateRequestOptions.new(
    authorization: Stytch::MethodOptions::Authorization.new(session_token: '${sessionToken}')
  )
)

puts resp

// DELETE /v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/verification_certificates/{certificate_id}
use stytch::b2b::client::Client;
use stytch::b2b::sso_saml::DeleteVerificationCertificateRequest;

fn main() {
    let client = Client::new("${projectId}", "${secret}").unwrap();
    let resp = client.sso.saml.delete_verification_certificate(
        DeleteVerificationCertificateRequest{
            organization_id: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
            connection_id: "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
            certificate_id: "saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701",
            ..Default::default()
        }
    ).await;
    println!("The response is {:?}", resp);
}

# DELETE /v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/verification_certificates/{certificate_id}
curl --request DELETE \
  --url https://test.stytch.com/v1/b2b/sso/saml/organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931/connections/saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9/verification_certificates/saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701 \
  -u '${projectId}:${secret}' \
  -H 'Content-Type: application/json' \
  -H "X-Stytch-Member-Session: ${sessionToken}"

{
  "request_id": "<string>",
  "certificate_id": "<string>",
  "status_code": 123
}

{
  "status_code": 401,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "error_type": "unauthorized_credentials",
  "error_message": "Unauthorized credentials.",
  "error_url": "https://stytch.com/docs/api/errors/401"
}

{
  "status_code": 429,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "error_type": "too_many_requests",
  "error_message": "Too many requests have been made.",
  "error_url": "https://stytch.com/docs/api/errors/429"
}

{
  "status_code": 500,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "error_type": "internal_server_error",
  "error_message": "Oops, something seems to have gone wrong, please reach out to support@stytch.com to let us know what went wrong.",
  "error_url": "https://stytch.com/docs/api/errors/500"
}

DELETE

b2b

sso

saml

{organization_id}

connections

{connection_id}

verification_certificates

{certificate_id}

// DELETE /v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/verification_certificates/{certificate_id}
const stytch = require('stytch');

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

const params = {
  organization_id: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
  connection_id: "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
  certificate_id: "saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701",
};

const options = {
  authorization: {
    session_token: '${sessionToken}',
  },
};

client.SSO.SAML.DeleteVerificationCertificate(params, options)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });

// DELETE /v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/verification_certificates/{certificate_id}
package main

import (
	"context"
	"log"

	"github.com/stytchauth/stytch-go/v18/stytch/b2b/b2bstytchapi"
	"github.com/stytchauth/stytch-go/v18/stytch/b2b/sso/saml"
	"github.com/stytchauth/stytch-go/v18/stytch/methodoptions"
)

func main() {
	client, err := b2bstytchapi.NewClient(
		"${projectId}",
		"${secret}",
	)
	if err != nil {
		log.Fatalf("error instantiating client: %v", err)
	}

	params := &saml.DeleteVerificationCertificateParams{
		OrganizationID: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
		ConnectionID:   "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
		CertificateID:  "saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701",
	}

	options := &saml.DeleteVerificationCertificateParamsOptions{
		Authorization: methodoptions.Authorization{
			SessionToken: "${sessionToken}",
		},
	}

	resp, err := client.SSO.SAML.DeleteVerificationCertificate(context.Background(), params, options)
	if err != nil {
		log.Fatalf("error in method call: %v", err)
	}

	log.Println(resp)
}

// DELETE /v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/verification_certificates/{certificate_id}
package com.example;

import com.stytch.java.b2b.models.ssosaml.DeleteVerificationCertificateRequest;
import com.stytch.java.b2b.models.ssosaml.DeleteVerificationCertificateRequestOptions;
import com.stytch.java.b2b.StytchB2BClient;
import com.stytch.java.common.methodoptions.Authorization;
import com.stytch.java.common.StytchResult;

public class Main {
    public static void main(String[] args) {
        StytchB2BClient.configure("${projectId}", "${secret}");

        DeleteVerificationCertificateRequest params = new DeleteVerificationCertificateRequest();
        params.setOrganizationId("organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931");
        params.setConnectionId("saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9");
        params.setCertificateId("saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701");

        DeleteVerificationCertificateRequestOptions options = new DeleteVerificationCertificateRequestOptions();
        Authorization authorization = new Authorization();
        authorization.setSessionToken("${sessionToken}");
        options.setAuthorization(authorization);

        Object result = StytchB2BClient.getSSO().getSAML().deleteVerificationCertificate(params, options);
        if (result instanceof StytchResult.Success) {
          System.out.println(((StytchResult.Success) result).getValue());
        } else {
          System.out.println(((StytchResult.Error) result).getException());
        }
    }
}

// DELETE /v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/verification_certificates/{certificate_id}
package com.example

import com.stytch.java.b2b.StytchB2BClient
import com.stytch.java.b2b.models.ssosaml.DeleteVerificationCertificateRequest
import com.stytch.java.b2b.models.ssosaml.DeleteVerificationCertificateRequestOptions
import com.stytch.java.common.methodoptions.Authorization

fun main() {
    StytchB2BClient.configure(
        projectId = "${projectId}",
        secret = "${secret}",
    )

    when (
        val result =
            StytchB2BClient.sso.saml.deleteVerificationCertificate(
                DeleteVerificationCertificateRequest(
                    organizationId = "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
                    connectionId = "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
                    certificateId = "saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701",
                ),
                DeleteVerificationCertificateRequestOptions(
                    Authorization(
                        sessionToken = "${sessionToken}",
                    ),
                ),
            )
    ) {
        is StytchResult.Success -> println(result.value)
        is StytchResult.Error -> println(result.exception)
    }
}

// DELETE /v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/verification_certificates/{certificate_id}
const stytch = require('stytch');

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

const params = {
  organization_id: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
  connection_id: "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
  certificate_id: "saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701",
};

const options = {
  authorization: {
    session_token: '${sessionToken}',
  },
};

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

$response = $client->sso->saml->delete_verification_certificate([
    'organization_id' => 'organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931',
    'connection_id' => 'saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9',
    'certificate_id' => 'saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701',
], [
        'authorization' => ['session_token' => '${sessionToken}'],

]);

# DELETE /v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/verification_certificates/{certificate_id}
from stytch import B2BClient
from stytch.b2b.models.sso_saml import DeleteVerificationCertificateRequestOptions
from stytch.shared.method_options import Authorization

client = B2BClient(
    project_id="${projectId}",
    secret="${secret}",
)

resp = client.sso.saml.delete_verification_certificate(
    organization_id="organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
    connection_id="saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
    certificate_id="saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701",
    method_options=DeleteVerificationCertificateRequestOptions(
        authorization=Authorization(
            session_token="${sessionToken}",
        ),
    ),
)

print(resp)

# frozen_string_literal: true

# DELETE /v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/verification_certificates/{certificate_id}
require 'stytch'

client = StytchB2B::Client.new(
  project_id: "${projectId}",
  secret: "${secret}"
)

resp = client.sso.saml.delete_verification_certificate(
  organization_id: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
  connection_id: "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
  certificate_id: "saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701",
  method_options: StytchB2B::SSO::SAML::DeleteVerificationCertificateRequestOptions.new(
    authorization: Stytch::MethodOptions::Authorization.new(session_token: '${sessionToken}')
  )
)

puts resp

// DELETE /v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/verification_certificates/{certificate_id}
use stytch::b2b::client::Client;
use stytch::b2b::sso_saml::DeleteVerificationCertificateRequest;

fn main() {
    let client = Client::new("${projectId}", "${secret}").unwrap();
    let resp = client.sso.saml.delete_verification_certificate(
        DeleteVerificationCertificateRequest{
            organization_id: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
            connection_id: "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
            certificate_id: "saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701",
            ..Default::default()
        }
    ).await;
    println!("The response is {:?}", resp);
}

# DELETE /v1/b2b/sso/saml/{organization_id}/connections/{connection_id}/verification_certificates/{certificate_id}
curl --request DELETE \
  --url https://test.stytch.com/v1/b2b/sso/saml/organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931/connections/saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9/verification_certificates/saml-verification-key-test-5ccbc642-9373-42b8-928f-c1646c868701 \
  -u '${projectId}:${secret}' \
  -H 'Content-Type: application/json' \
  -H "X-Stytch-Member-Session: ${sessionToken}"

{
  "request_id": "<string>",
  "certificate_id": "<string>",
  "status_code": 123
}

{
  "status_code": 401,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "error_type": "unauthorized_credentials",
  "error_message": "Unauthorized credentials.",
  "error_url": "https://stytch.com/docs/api/errors/401"
}

{
  "status_code": 429,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "error_type": "too_many_requests",
  "error_message": "Too many requests have been made.",
  "error_url": "https://stytch.com/docs/api/errors/429"
}

{
  "status_code": 500,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "error_type": "internal_server_error",
  "error_message": "Oops, something seems to have gone wrong, please reach out to support@stytch.com to let us know what went wrong.",
  "error_url": "https://stytch.com/docs/api/errors/500"
}

RBAC Enforced APIIf a Member Session is passed in the Authorization headers, Stytch will enforce that the Member has permission to take the Action on the Resource prior to honoring the request.To learn more, see the RBAC guide.

You may need to do this when rotating certificates from your IdP, since Stytch allows a maximum of 5 certificates per connection. There must always be at least one certificate per active connection.

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

X-Stytch-Member-Session

string

A Stytch session that can be used to run the request with the given member's permissions.

X-Stytch-Member-SessionJWT

string

A Stytch Session JSON Web Token (JWT) that can be used to run the request with the given member's permissions.

Path Parameters

organization_id

string

required

The organization ID that the SAML connection belongs to. You may also use the organization_slug or organization_external_id here as a convenience.

connection_id

string

required

The ID of the SAML connection.

certificate_id

string

required

The ID of the certificate to be deleted.

Response

Successful response

request_id

string

required

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.

certificate_id

string

required

The ID of the certificate that was deleted.

status_code

integer<int32>

required

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.

⌘I