This is the configuration required for an Identity Provider for single sign on.
Overview of SamlIdPConfiguration goes here.
SamlIdPConfiguration
Field | Type | Inherited from | Description |
---|---|---|---|
CertificatesBase64Encoded | String[] | SamlIdPConfiguration | Gets or sets the CertificatesBase64Encoded value |
DefaultUserGroupIds | String[] | SamlIdPConfiguration | Gets or sets the DefaultUserGroupIds value |
Description | String | SamlIdPConfiguration | Gets or sets the Description value |
GroupAttributeNames | String[] | SamlIdPConfiguration | Array of custom attribute names in the SSO, the values of which are the Custom Group String (key)The array values are attribute names. The attribute values are used as the key in GroupMappings. For instance, the attributes may come in as { ‘For Admins’: [‘Operations Admin’], ‘For Managers’: [‘Manager’] } Review the GroupMappings example to see how the attribute values map to Feenics Groups Note: In order to exempt a user from being assigned the configured GroupMappings groups, pass an attribute with the name ExemptFromGrouping and any non-empty value |
GroupMappings | Dictionary<String> | SamlIdPConfiguration | Mapping the Custom Group String (key) to the groups to be assigned to the user (value) |
PartnerName | String | SamlIdPConfiguration | Gets or sets the PartnerName value |
SignAuthnRequest | Boolean | SamlIdPConfiguration | Gets or sets the SignAuthnRequest value |
SingleLogoutServiceUrl | String | SamlIdPConfiguration | Gets or sets the SingleLogoutServiceUrl value |
SingleSignOnServiceUrl | String | SamlIdPConfiguration | Gets or sets the SingleSignOnServiceUrl value |
{
"CertificatesBase64Encoded" : "String[]",
"DefaultUserGroupIds" : "String[]",
"Description" : "String",
"GroupAttributeNames" : "String[]",
"GroupMappings" : "Dictionary\<String\>",
"PartnerName" : "String",
"SignAuthnRequest" : "Boolean",
"SingleLogoutServiceUrl" : "String",
"SingleSignOnServiceUrl" : "String"
}
Example in C#
// Returns: nothing
await client.DeleteIdPConfigurationAsync();
Example in CURL
curl -X DELETE \
https://keepapi.feenicshosting.com/saml/admin/idpconfiguration \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json'
Example in C#
// Returns: SamlIdPConfiguration
var samlIdPConfiguration = await client.GetIdPConfigurationAsync();
Example in CURL
curl -X GET \
https://keepapi.feenicshosting.com/saml/admin/idpconfiguration \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json'
Example in C#
// Returns: nothing
await client.SetSamlIdentityProviderConfiguration(SamlIdPConfiguration configuration);
Example in CURL
curl -X POST \
https://keepapi.feenicshosting.com/saml/admin/idpconfiguration \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-D '{
"$type":"Feenics.Keep.WebApi.Model.SamlIdPConfiguration, Feenics.Keep.WebApi.Model",
"PartnerName":null,
"Description":null,
"SignAuthnRequest":false,
"SingleSignOnServiceUrl":null,
"SingleLogoutServiceUrl":null,
"CertificatesBase64Encoded":null,
"DefaultUserGroupIds":null,
"GroupAttributeNames":null,
"GroupMappings":null
}'