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

Unique identifier/key for the SSO profile

Example:

"ldap_dev"

​
Name
string

Name of the SSO profile

Example:

"Developers@LocalAD"

​
OrgID
string

Organization ID

Example:

"1"

​
ActionType
string

Type of action to perform

Example:

"GenerateOrLoginDeveloperProfile"

​
MatchedPolicyID
string

ID of the matched policy

​
Type
string

Type of SSO profile

Example:

"redirect"

​
ProviderName
string

Name of the provider

Example:

"ADProvider"

​
CustomEmailField
string

Custom field for email mapping

​
CustomUserIDField
string

Custom field for user ID mapping

​
ProviderConfig
object

JSON configuration for the provider

​
IdentityHandlerConfig
object

JSON configuration for identity handling

​
ProviderConstraintsDomain
string

Domain constraints for the provider

​
ProviderConstraintsGroup
string

Group constraints for the provider

​
ReturnURL
string

URL to return to after SSO

Example:

"http://localhost:3001/sso"

​
DefaultUserGroupID
string

Default group ID for new users

​
CustomUserGroupField
string

Custom field for user group mapping

Example:

"cn"

​
UserGroupMapping
object

JSON mapping of user groups

Example:
{ "TeamA": "9", "TeamB": "11" }
​
UserGroupSeparator
string

Separator used in user group strings

​
SSOOnlyForRegisteredUsers
boolean
default:false

Whether SSO is restricted to registered users only

Response

Created