Show / Hide Table of Contents

Class SecuritySamlConfig

SAML policy is optionally used for Opensearch cluster to config SAML authentication

Inheritance
object
SecuritySamlConfig
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.OpensearchService.Models
Assembly: OCI.DotNetSDK.Opensearch.dll
Syntax
public class SecuritySamlConfig

Properties

AdminBackendRole

Declaration
[JsonProperty(PropertyName = "adminBackendRole")]
public string AdminBackendRole { get; set; }
Property Value
Type Description
string

The backend role of admins who have all permissions like local master user

IdpEntityId

Declaration
[Required(ErrorMessage = "IdpEntityId is required.")]
[JsonProperty(PropertyName = "idpEntityId")]
public string IdpEntityId { get; set; }
Property Value
Type Description
string

The unique name for a identity provider entity

Remarks

Required

IdpMetadataContent

Declaration
[Required(ErrorMessage = "IdpMetadataContent is required.")]
[JsonProperty(PropertyName = "idpMetadataContent")]
public string IdpMetadataContent { get; set; }
Property Value
Type Description
string

The content of identity provider metadata

Remarks

Required

IsEnabled

Declaration
[Required(ErrorMessage = "IsEnabled is required.")]
[JsonProperty(PropertyName = "isEnabled")]
public bool? IsEnabled { get; set; }
Property Value
Type Description
bool?

A flag determine whether SAML is enabled

Remarks

Required

OpendashboardUrl

Declaration
[JsonProperty(PropertyName = "opendashboardUrl")]
public string OpendashboardUrl { get; set; }
Property Value
Type Description
string

The endpoint of opendashboard

RolesKey

Declaration
[JsonProperty(PropertyName = "rolesKey")]
public string RolesKey { get; set; }
Property Value
Type Description
string

The roles key is sued to get backend roles from SAML assertion

SubjectKey

Declaration
[JsonProperty(PropertyName = "subjectKey")]
public string SubjectKey { get; set; }
Property Value
Type Description
string

The subject key is used to get username from SAML assertion. By default, it is NameID

In this article
Back to top