SAMLOptionsProperty Struct
Container for information about the SAML configuration for OpenSearch Dashboards.
Example
ts
const domain = new Domain(this, 'Domain', {
version: EngineVersion.OPENSEARCH_1_0,
enforceHttps: true,
nodeToNodeEncryption: true,
encryptionAtRest: {
enabled: true,
},
fineGrainedAccessControl: {
masterUserName: 'master-user',
samlAuthenticationEnabled: true,
samlAuthenticationOptions: {
idpEntityId: 'entity-id',
idpMetadataContent: 'metadata-content-with-quotes-escaped',
},
},
});
Properties
The unique entity ID of the application in the SAML identity provider.
idpMetadataContentstringidp_metadata_contentstridpMetadataContentStringIdpMetadataContentstringIdpMetadataContent*stringrequired#The metadata of the SAML application, in XML format.
masterBackendRoleoptionalstringmaster_backend_roleoptionalstrmasterBackendRoleoptionalStringMasterBackendRoleoptionalstringMasterBackendRoleoptional*string#The backend role that the SAML master user is mapped to.
Default: The master user is not mapped to a backend role
Any users with this backend role receives full permission in OpenSearch Dashboards/Kibana. To use a SAML master backend role, configure the rolesKey property.
masterUserNameoptionalstringmaster_user_nameoptionalstrmasterUserNameoptionalStringMasterUserNameoptionalstringMasterUserNameoptional*string#The SAML master username, which is stored in the domain's internal user database.
Default: No master user name is configured
This SAML user receives full permission in OpenSearch Dashboards/Kibana. Creating a new master username does not delete any existing master usernames.
rolesKeyoptionalstringroles_keyoptionalstrrolesKeyoptionalStringRolesKeyoptionalstringRolesKeyoptional*string= roles#Element of the SAML assertion to use for backend roles.
sessionTimeoutMinutesoptionalnumbersession_timeout_minutesoptionalint | floatsessionTimeoutMinutesoptionalNumberSessionTimeoutMinutesoptionaldoubleSessionTimeoutMinutesoptional*float64= 60#The duration, in minutes, after which a user session becomes inactive.
subjectKeyoptionalstringsubject_keyoptionalstrsubjectKeyoptionalStringSubjectKeyoptionalstringSubjectKeyoptional*string#Element of the SAML assertion to use for the user name.
Default: NameID element of the SAML assertion fot the user name