Update SCIM Connection

// PUT /v1/b2b/scim/{organization_id}/connection/{connection_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: "scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc",
  display_name: "Example SCIM connection",
};

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

client.SCIM.Connection.Update(params, options)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });

// PUT /v1/b2b/scim/{organization_id}/connection/{connection_id}
package main

import (
	"context"
	"log"

	"github.com/stytchauth/stytch-go/v18/stytch/b2b/b2bstytchapi"
	"github.com/stytchauth/stytch-go/v18/stytch/b2b/scim/connection"
	"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 := &connection.UpdateParams{
		OrganizationID: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
		ConnectionID:   "scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc",
		DisplayName:    "Example SCIM connection",
	}

	options := &connection.UpdateParamsOptions{
		Authorization: methodoptions.Authorization{
			SessionToken: "${sessionToken}",
		},
	}

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

	log.Println(resp)
}

// PUT /v1/b2b/scim/{organization_id}/connection/{connection_id}
package com.example;

import com.stytch.java.b2b.models.scimconnection.UpdateRequest;
import com.stytch.java.b2b.models.scimconnection.UpdateRequestOptions;
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}");

        UpdateRequest params = new UpdateRequest();
        params.setOrganizationId("organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931");
        params.setConnectionId("scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc");
        params.setDisplayName("Example SCIM connection");

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

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

// PUT /v1/b2b/scim/{organization_id}/connection/{connection_id}
package com.example

import com.stytch.java.b2b.StytchB2BClient
import com.stytch.java.b2b.models.scimconnection.UpdateRequest
import com.stytch.java.b2b.models.scimconnection.UpdateRequestOptions
import com.stytch.java.common.methodoptions.Authorization

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

    when (
        val result =
            StytchB2BClient.scim.connection.update(
                UpdateRequest(
                    organizationId = "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
                    connectionId = "scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc",
                    displayName = "Example SCIM connection",
                ),
                UpdateRequestOptions(
                    Authorization(
                        sessionToken = "${sessionToken}",
                    ),
                ),
            )
    ) {
        is StytchResult.Success -> println(result.value)
        is StytchResult.Error -> println(result.exception)
    }
}

// PUT /v1/b2b/scim/{organization_id}/connection/{connection_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: "scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc",
  display_name: "Example SCIM connection",
};

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

client.scim.connection.update(params, options)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });

$response = $client->scim->connection->update([
    'organization_id' => 'organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931',
    'connection_id' => 'scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc',
    'display_name' => 'Example SCIM connection',
], [
        'authorization' => ['session_token' => '${sessionToken}'],

]);

# PUT /v1/b2b/scim/{organization_id}/connection/{connection_id}
from stytch import B2BClient
from stytch.b2b.models.scim_connection import UpdateRequestOptions
from stytch.shared.method_options import Authorization

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

resp = client.scim.connection.update(
    organization_id="organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
    connection_id="scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc",
    display_name="Example SCIM connection",
    method_options=UpdateRequestOptions(
        authorization=Authorization(
            session_token="${sessionToken}",
        ),
    ),
)

print(resp)

# frozen_string_literal: true

# PUT /v1/b2b/scim/{organization_id}/connection/{connection_id}
require 'stytch'

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

resp = client.scim.connection.update(
  organization_id: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
  connection_id: "scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc",
  display_name: "Example SCIM connection",
  method_options: StytchB2B::SCIM::Connection::UpdateRequestOptions.new(
    authorization: Stytch::MethodOptions::Authorization.new(session_token: '${sessionToken}')
  )
)

puts resp

// PUT /v1/b2b/scim/{organization_id}/connection/{connection_id}
use stytch::b2b::client::Client;
use stytch::b2b::scim_connection::UpdateRequest;

fn main() {
    let client = Client::new("${projectId}", "${secret}").unwrap();
    let resp = client.scim.connection.update(
        UpdateRequest{
            organization_id: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
            connection_id: "scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc",
            display_name: Some(String::from("Example SCIM connection")),
            ..Default::default()
        }
    ).await;
    println!("The response is {:?}", resp);
}

# PUT /v1/b2b/scim/{organization_id}/connection/{connection_id}
curl --request PUT \
  --url https://test.stytch.com/v1/b2b/scim/organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931/connection/scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc \
  -u '${projectId}:${secret}' \
  -H 'Content-Type: application/json' \
  -H "X-Stytch-Member-Session: ${sessionToken}" \
  -d '{
    "display_name": "Example SCIM connection"
  }'

{
  "request_id": "<string>",
  "status_code": 123,
  "connection": {
    "organization_id": "<string>",
    "connection_id": "<string>",
    "status": "<string>",
    "display_name": "<string>",
    "identity_provider": "<string>",
    "base_url": "<string>",
    "bearer_token_last_four": "<string>",
    "scim_group_implicit_role_assignments": [
      {
        "role_id": "<string>",
        "group_id": "<string>",
        "group_name": "<string>"
      }
    ],
    "next_bearer_token_last_four": "<string>",
    "bearer_token_expires_at": "<string>",
    "next_bearer_token_expires_at": "<string>"
  }
}

{
  "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"
}

PUT

b2b

scim

{organization_id}

connection

{connection_id}

// PUT /v1/b2b/scim/{organization_id}/connection/{connection_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: "scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc",
  display_name: "Example SCIM connection",
};

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

client.SCIM.Connection.Update(params, options)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });

// PUT /v1/b2b/scim/{organization_id}/connection/{connection_id}
package main

import (
	"context"
	"log"

	"github.com/stytchauth/stytch-go/v18/stytch/b2b/b2bstytchapi"
	"github.com/stytchauth/stytch-go/v18/stytch/b2b/scim/connection"
	"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 := &connection.UpdateParams{
		OrganizationID: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
		ConnectionID:   "scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc",
		DisplayName:    "Example SCIM connection",
	}

	options := &connection.UpdateParamsOptions{
		Authorization: methodoptions.Authorization{
			SessionToken: "${sessionToken}",
		},
	}

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

	log.Println(resp)
}

// PUT /v1/b2b/scim/{organization_id}/connection/{connection_id}
package com.example;

import com.stytch.java.b2b.models.scimconnection.UpdateRequest;
import com.stytch.java.b2b.models.scimconnection.UpdateRequestOptions;
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}");

        UpdateRequest params = new UpdateRequest();
        params.setOrganizationId("organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931");
        params.setConnectionId("scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc");
        params.setDisplayName("Example SCIM connection");

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

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

// PUT /v1/b2b/scim/{organization_id}/connection/{connection_id}
package com.example

import com.stytch.java.b2b.StytchB2BClient
import com.stytch.java.b2b.models.scimconnection.UpdateRequest
import com.stytch.java.b2b.models.scimconnection.UpdateRequestOptions
import com.stytch.java.common.methodoptions.Authorization

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

    when (
        val result =
            StytchB2BClient.scim.connection.update(
                UpdateRequest(
                    organizationId = "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
                    connectionId = "scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc",
                    displayName = "Example SCIM connection",
                ),
                UpdateRequestOptions(
                    Authorization(
                        sessionToken = "${sessionToken}",
                    ),
                ),
            )
    ) {
        is StytchResult.Success -> println(result.value)
        is StytchResult.Error -> println(result.exception)
    }
}

// PUT /v1/b2b/scim/{organization_id}/connection/{connection_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: "scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc",
  display_name: "Example SCIM connection",
};

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

client.scim.connection.update(params, options)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });

$response = $client->scim->connection->update([
    'organization_id' => 'organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931',
    'connection_id' => 'scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc',
    'display_name' => 'Example SCIM connection',
], [
        'authorization' => ['session_token' => '${sessionToken}'],

]);

# PUT /v1/b2b/scim/{organization_id}/connection/{connection_id}
from stytch import B2BClient
from stytch.b2b.models.scim_connection import UpdateRequestOptions
from stytch.shared.method_options import Authorization

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

resp = client.scim.connection.update(
    organization_id="organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
    connection_id="scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc",
    display_name="Example SCIM connection",
    method_options=UpdateRequestOptions(
        authorization=Authorization(
            session_token="${sessionToken}",
        ),
    ),
)

print(resp)

# frozen_string_literal: true

# PUT /v1/b2b/scim/{organization_id}/connection/{connection_id}
require 'stytch'

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

resp = client.scim.connection.update(
  organization_id: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
  connection_id: "scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc",
  display_name: "Example SCIM connection",
  method_options: StytchB2B::SCIM::Connection::UpdateRequestOptions.new(
    authorization: Stytch::MethodOptions::Authorization.new(session_token: '${sessionToken}')
  )
)

puts resp

// PUT /v1/b2b/scim/{organization_id}/connection/{connection_id}
use stytch::b2b::client::Client;
use stytch::b2b::scim_connection::UpdateRequest;

fn main() {
    let client = Client::new("${projectId}", "${secret}").unwrap();
    let resp = client.scim.connection.update(
        UpdateRequest{
            organization_id: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
            connection_id: "scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc",
            display_name: Some(String::from("Example SCIM connection")),
            ..Default::default()
        }
    ).await;
    println!("The response is {:?}", resp);
}

# PUT /v1/b2b/scim/{organization_id}/connection/{connection_id}
curl --request PUT \
  --url https://test.stytch.com/v1/b2b/scim/organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931/connection/scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc \
  -u '${projectId}:${secret}' \
  -H 'Content-Type: application/json' \
  -H "X-Stytch-Member-Session: ${sessionToken}" \
  -d '{
    "display_name": "Example SCIM connection"
  }'

{
  "request_id": "<string>",
  "status_code": 123,
  "connection": {
    "organization_id": "<string>",
    "connection_id": "<string>",
    "status": "<string>",
    "display_name": "<string>",
    "identity_provider": "<string>",
    "base_url": "<string>",
    "bearer_token_last_four": "<string>",
    "scim_group_implicit_role_assignments": [
      {
        "role_id": "<string>",
        "group_id": "<string>",
        "group_name": "<string>"
      }
    ],
    "next_bearer_token_last_four": "<string>",
    "bearer_token_expires_at": "<string>",
    "next_bearer_token_expires_at": "<string>"
  }
}

{
  "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.

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

Globally unique UUID that identifies a specific Organization. The organization_id is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.

connection_id

string

required

The ID of the SCIM connection.

Body

application/json

Request type

display_name

string

A human-readable display name for the connection.

identity_provider

enum<string>

Available options:

generic,

okta,

microsoft-entra,

cyberark,

jumpcloud,

onelogin,

pingfederate,

rippling

scim_group_implicit_role_assignments

object[]

An array of SCIM group implicit role assignments. Each object in the array must contain a group_id and a role_id.

Show child attributes

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.

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.

connection

object

The SCIM Connection Object.

Show child attributes

⌘I