Skip to main content
GET
/
v1
/
sso_connections
/
{connectionId}
/
mappings
Get SSO Connection Mappings
curl --request GET \
  --url https://api.us.lexful.app/v1/sso_connections/{connectionId}/mappings \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-ID: <api-key>'
import requests

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

headers = {
    "Authorization": "Bearer <token>",
    "X-Account-ID": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'X-Account-ID': '<api-key>'}
};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Account-ID", "<api-key>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.us.lexful.app/v1/sso_connections/{connectionId}/mappings")
  .header("Authorization", "Bearer <token>")
  .header("X-Account-ID", "<api-key>")
  .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::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Account-ID"] = '<api-key>'

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

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)