SamlConnectionsService

A list of all methods in the SamlConnectionsService service. Click on the method name to view detailed information about that method.

Methods	Description
listSamlConnections	Returns a list of SAML connections. The connections are scoped by the current user and returned from Clerk
createSamlConnection	Creates a new SAML connection
getSamlConnectionById	Checks whether a user has a SAML connection and then hydrates the connection from Clerk
updateSamlConnectionById	Checks whether a user owns a SAML connection and then updates the SAML connection
deleteSamlConnectionById	Deletes a SAML connection by its ID

listSamlConnections

Returns a list of SAML connections. The connections are scoped by the current user and returned from Clerk

• HTTP Method: GET
• Endpoint: /samlConnection

Return Type

SamlConnections

Example Usage Code Snippet

import com.swagger.petstore.TestSdk;
import com.swagger.petstore.config.TestSdkConfig;
import com.swagger.petstore.models.SamlConnections;

fun main() {
	val config: TestSdkConfig = TestSdkConfig.builder()
			.accessToken("YOUR_ACCESS_TOKEN")
			.build();

    val testSdk: TestSdk = TestSdk(config);

    val response: SamlConnections = testSdk.samlConnections.listSamlConnections();
    
    println(response);
}

createSamlConnection

Creates a new SAML connection

• HTTP Method: POST
• Endpoint: /samlConnection

Parameters

Name	Type	Required	Description
samlConnectionParams	SamlConnectionParams	❌	Request Body

Return Type

SamlConnection

Example Usage Code Snippet

import com.swagger.petstore.TestSdk;
import com.swagger.petstore.config.TestSdkConfig;
import com.swagger.petstore.models.SamlConnection;
import com.swagger.petstore.models.SamlConnectionParams;

fun main() {
	val config: TestSdkConfig = TestSdkConfig.builder()
			.accessToken("YOUR_ACCESS_TOKEN")
			.build();

    val testSdk: TestSdk = TestSdk(config);

    val samlConnectionParams: SamlConnectionParams = SamlConnectionParams.builder()
			.name("name")
			.domain("domain")
			.idpEntityId("idp_entity_id")
			.idpSsoUrl("idp_sso_url")
			.idpCertificate("idp_certificate")
			.build();

    val response: SamlConnection = testSdk.samlConnections.createSamlConnection(samlConnectionParams);
    
    println(response);
}

getSamlConnectionById

Checks whether a user has a SAML connection and then hydrates the connection from Clerk

• HTTP Method: GET
• Endpoint: /samlConnection/{saml_connection_id}

Parameters

Name	Type	Required	Description
samlConnectionId	String	✅	The ID of the SAML connection to retrieve

Return Type

SamlConnection

Example Usage Code Snippet

import com.swagger.petstore.TestSdk;
import com.swagger.petstore.config.TestSdkConfig;
import com.swagger.petstore.models.SamlConnection;

fun main() {
	val config: TestSdkConfig = TestSdkConfig.builder()
			.accessToken("YOUR_ACCESS_TOKEN")
			.build();

    val testSdk: TestSdk = TestSdk(config);

    val response: SamlConnection = testSdk.samlConnections.getSamlConnectionById("saml_connection_id");
    
    println(response);
}

updateSamlConnectionById

Checks whether a user owns a SAML connection and then updates the SAML connection

• HTTP Method: PUT
• Endpoint: /samlConnection/{saml_connection_id}

Parameters

Name	Type	Required	Description
samlConnectionId	String	✅	The ID of the SAML connection to update
samlConnectionUpdateParams	SamlConnectionUpdateParams	✅	Request Body

Return Type

SamlConnection

Example Usage Code Snippet

import com.swagger.petstore.TestSdk;
import com.swagger.petstore.config.TestSdkConfig;
import com.swagger.petstore.models.SamlConnection;
import com.swagger.petstore.models.SamlConnectionUpdateParams;

fun main() {
	val config: TestSdkConfig = TestSdkConfig.builder()
			.accessToken("YOUR_ACCESS_TOKEN")
			.build();

    val testSdk: TestSdk = TestSdk(config);

    val samlConnectionUpdateParams: SamlConnectionUpdateParams = SamlConnectionUpdateParams.builder()
			.name("name")
			.domain("domain")
			.idpEntityId("idp_entity_id")
			.idpSsoUrl("idp_sso_url")
			.idpCertificate("idp_certificate")
			.active(true)
			.build();

    val response: SamlConnection = testSdk.samlConnections.updateSamlConnectionById("saml_connection_id", samlConnectionUpdateParams);
    
    println(response);
}

deleteSamlConnectionById

Deletes a SAML connection by its ID

• HTTP Method: DELETE
• Endpoint: /samlConnection/{saml_connection_id}

Parameters

Name	Type	Required	Description
samlConnectionId	String	✅	The ID of the SAML connection to update

Example Usage Code Snippet

import com.swagger.petstore.TestSdk;
import com.swagger.petstore.config.TestSdkConfig;

fun main() {
	val config: TestSdkConfig = TestSdkConfig.builder()
			.accessToken("YOUR_ACCESS_TOKEN")
			.build();

    val testSdk: TestSdk = TestSdk(config);

    testSdk.samlConnections.deleteSamlConnectionById("saml_connection_id");
}