Skip to main content
POST
/
sso_profiles
Create a new SSO profile
curl --request POST \
  --url http://localhost:3001/portal-api/sso_profiles \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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
}'
This response does not have an example.

Authorizations

​
Authorization
string
header
required

Body

application/json
​
ID
string
Example:
​
Name
string
Example:
​
OrgID
string
Example:
​
ActionType
string
Example:
​
MatchedPolicyID
string
​
Type
string
Example:
​
ProviderName
string
Example:
​
CustomEmailField
string
​
CustomUserIDField
string
​
ProviderConfig
object
​
IdentityHandlerConfig
object
​
ProviderConstraintsDomain
string
​
ProviderConstraintsGroup
string
​
ReturnURL
string
Example:
​
DefaultUserGroupID
string
​
CustomUserGroupField
string
Example:
​
UserGroupMapping
object
Example:
​
UserGroupSeparator
string
​
SSOOnlyForRegisteredUsers
boolean
default:false

Response