Skip to main content
PATCH
/
v1
/
sso_connections
/
{connectionId}
/
mappings
Update SSO Connection Mappings
curl --request PATCH \
  --url https://api.us.lexful.app/v1/sso_connections/{connectionId}/mappings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-ID: <api-key>' \
  --data '
{
  "default_role": "<string>",
  "default_organization_scopes": [
    "<string>"
  ],
  "role_mapping": {
    "attribute_name": "<string>",
    "mappings": [
      {
        "idp_value": "<string>"
      }
    ]
  },
  "group_mapping": {
    "attribute_name": "<string>",
    "mappings": [
      {
        "idp_value": "<string>",
        "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ]
  }
}
'
import requests

url = "https://api.us.lexful.app/v1/sso_connections/{connectionId}/mappings"

payload = {
"default_role": "<string>",
"default_organization_scopes": ["<string>"],
"role_mapping": {
"attribute_name": "<string>",
"mappings": [{ "idp_value": "<string>" }]
},
"group_mapping": {
"attribute_name": "<string>",
"mappings": [
{
"idp_value": "<string>",
"group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
}
headers = {
"Authorization": "Bearer <token>",
"X-Account-ID": "<api-key>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-Account-ID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
default_role: '<string>',
default_organization_scopes: ['<string>'],
role_mapping: {attribute_name: '<string>', mappings: [{idp_value: '<string>'}]},
group_mapping: {
attribute_name: '<string>',
mappings: [{idp_value: '<string>', group_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}]
}
})
};

fetch('https://api.us.lexful.app/v1/sso_connections/{connectionId}/mappings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.us.lexful.app/v1/sso_connections/{connectionId}/mappings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'default_role' => '<string>',
'default_organization_scopes' => [
'<string>'
],
'role_mapping' => [
'attribute_name' => '<string>',
'mappings' => [
[
'idp_value' => '<string>'
]
]
],
'group_mapping' => [
'attribute_name' => '<string>',
'mappings' => [
[
'idp_value' => '<string>',
'group_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Account-ID: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.us.lexful.app/v1/sso_connections/{connectionId}/mappings"

payload := strings.NewReader("{\n \"default_role\": \"<string>\",\n \"default_organization_scopes\": [\n \"<string>\"\n ],\n \"role_mapping\": {\n \"attribute_name\": \"<string>\",\n \"mappings\": [\n {\n \"idp_value\": \"<string>\"\n }\n ]\n },\n \"group_mapping\": {\n \"attribute_name\": \"<string>\",\n \"mappings\": [\n {\n \"idp_value\": \"<string>\",\n \"group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n }\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Account-ID", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.us.lexful.app/v1/sso_connections/{connectionId}/mappings")
.header("Authorization", "Bearer <token>")
.header("X-Account-ID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"default_role\": \"<string>\",\n \"default_organization_scopes\": [\n \"<string>\"\n ],\n \"role_mapping\": {\n \"attribute_name\": \"<string>\",\n \"mappings\": [\n {\n \"idp_value\": \"<string>\"\n }\n ]\n },\n \"group_mapping\": {\n \"attribute_name\": \"<string>\",\n \"mappings\": [\n {\n \"idp_value\": \"<string>\",\n \"group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.us.lexful.app/v1/sso_connections/{connectionId}/mappings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Account-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"default_role\": \"<string>\",\n \"default_organization_scopes\": [\n \"<string>\"\n ],\n \"role_mapping\": {\n \"attribute_name\": \"<string>\",\n \"mappings\": [\n {\n \"idp_value\": \"<string>\"\n }\n ]\n },\n \"group_mapping\": {\n \"attribute_name\": \"<string>\",\n \"mappings\": [\n {\n \"idp_value\": \"<string>\",\n \"group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n }\n}"

response = http.request(request)
puts response.read_body
{
  "default_role": "<string>",
  "default_organization_scopes": [
    "<string>"
  ],
  "role_mapping": {
    "attribute_name": "<string>",
    "mappings": [
      {
        "idp_value": "<string>"
      }
    ]
  },
  "group_mapping": {
    "attribute_name": "<string>",
    "mappings": [
      {
        "idp_value": "<string>",
        "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ]
  }
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer token

X-Account-ID
string
header
required

Account ID

Path Parameters

connectionId
string
required

SSO connection ID

Body

application/json
default_role
string

Default role assigned to users provisioned via this SSO connection

default_organization_scopes
string[]

Default organization scopes for SSO users. Use ["*"] for all organizations.

role_mapping
object | null

Map IDP attribute values to internal roles (first match wins)

group_mapping
object | null

Map IDP attribute values to internal groups (all matches)

Response

Default Response

default_role
string

Default role assigned to users provisioned via this SSO connection

default_organization_scopes
string[]

Default organization scopes for SSO users. Use ["*"] for all organizations.

role_mapping
object | null

Map IDP attribute values to internal roles (first match wins)

group_mapping
object | null

Map IDP attribute values to internal groups (all matches)