Documentation IndexFetch the complete documentation index at: /docs/llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Contact support
cURL
curl --request GET \ --url http://localhost:3001/portal-api/sso_profiles/{profile_id} \ --header 'Authorization: <api-key>'
import requests url = "http://localhost:3001/portal-api/sso_profiles/{profile_id}" headers = {"Authorization": "<api-key>"} response = requests.get(url, headers=headers) print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}}; fetch('http://localhost:3001/portal-api/sso_profiles/{profile_id}', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err));
<?php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_PORT => "3001", CURLOPT_URL => "http://localhost:3001/portal-api/sso_profiles/{profile_id}", 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: <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 := "http://localhost:3001/portal-api/sso_profiles/{profile_id}" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "<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("http://localhost:3001/portal-api/sso_profiles/{profile_id}") .header("Authorization", "<api-key>") .asString();
require 'uri' require 'net/http' url = URI("http://localhost:3001/portal-api/sso_profiles/{profile_id}") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Get.new(url) request["Authorization"] = '<api-key>' response = http.request(request) puts response.read_body
{ "ID": "ldap_dev", "Name": "Developers@LocalAD", "OrgID": "1", "ActionType": "GenerateOrLoginDeveloperProfile", "MatchedPolicyID": "<string>", "Type": "redirect", "ProviderName": "ADProvider", "CustomEmailField": "<string>", "CustomUserIDField": "<string>", "ProviderConfig": {}, "IdentityHandlerConfig": {}, "ProviderConstraintsDomain": "<string>", "ProviderConstraintsGroup": "<string>", "ReturnURL": "http://localhost:3001/sso", "DefaultUserGroupID": "<string>", "CustomUserGroupField": "cn", "UserGroupMapping": { "TeamA": "9", "TeamB": "11" }, "UserGroupSeparator": "<string>", "SSOOnlyForRegisteredUsers": false }
{ "errors": [ "<string>" ] }
Get an SSO profile by ID
ID of the SSO profile
"ldap_dev"
OK
Unique identifier/key for the SSO profile
Name of the SSO profile
"Developers@LocalAD"
Organization ID
"1"
Type of action to perform
"GenerateOrLoginDeveloperProfile"
ID of the matched policy
Type of SSO profile
"redirect"
Name of the provider
"ADProvider"
Custom field for email mapping
Custom field for user ID mapping
JSON configuration for the provider
JSON configuration for identity handling
Domain constraints for the provider
Group constraints for the provider
URL to return to after SSO
"http://localhost:3001/sso"
Default group ID for new users
Custom field for user group mapping
"cn"
JSON mapping of user groups
{ "TeamA": "9", "TeamB": "11" }
Separator used in user group strings
Whether SSO is restricted to registered users only
Was this page helpful?