SecuritySamlConfig¶

class oci.opensearch.models.SecuritySamlConfig(**kwargs)¶

Bases: object

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

Methods

__init__(**kwargs) Initializes a new SecuritySamlConfig object with values from keyword arguments.

Attributes

`admin_backend_role`	Gets the admin_backend_role of this SecuritySamlConfig.
`idp_entity_id`	[Required] Gets the idp_entity_id of this SecuritySamlConfig.
`idp_metadata_content`	[Required] Gets the idp_metadata_content of this SecuritySamlConfig.
`is_enabled`	[Required] Gets the is_enabled of this SecuritySamlConfig.
`opendashboard_url`	Gets the opendashboard_url of this SecuritySamlConfig.
`roles_key`	Gets the roles_key of this SecuritySamlConfig.
`subject_key`	Gets the subject_key of this SecuritySamlConfig.

__init__(**kwargs)¶

Initializes a new SecuritySamlConfig object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

is_enabled (bool) – The value to assign to the is_enabled property of this SecuritySamlConfig.
idp_metadata_content (str) – The value to assign to the idp_metadata_content property of this SecuritySamlConfig.
idp_entity_id (str) – The value to assign to the idp_entity_id property of this SecuritySamlConfig.
opendashboard_url (str) – The value to assign to the opendashboard_url property of this SecuritySamlConfig.
admin_backend_role (str) – The value to assign to the admin_backend_role property of this SecuritySamlConfig.
subject_key (str) – The value to assign to the subject_key property of this SecuritySamlConfig.
roles_key (str) – The value to assign to the roles_key property of this SecuritySamlConfig.

admin_backend_role¶

Gets the admin_backend_role of this SecuritySamlConfig. The backend role of admins who have all permissions like local master user

Returns:	The admin_backend_role of this SecuritySamlConfig.
Return type:	str

idp_entity_id¶

[Required] Gets the idp_entity_id of this SecuritySamlConfig. The unique name for a identity provider entity

Returns:	The idp_entity_id of this SecuritySamlConfig.
Return type:	str

idp_metadata_content¶

[Required] Gets the idp_metadata_content of this SecuritySamlConfig. The content of identity provider metadata

Returns:	The idp_metadata_content of this SecuritySamlConfig.
Return type:	str

is_enabled¶

[Required] Gets the is_enabled of this SecuritySamlConfig. A flag determine whether SAML is enabled

Returns:	The is_enabled of this SecuritySamlConfig.
Return type:	bool

opendashboard_url¶

Gets the opendashboard_url of this SecuritySamlConfig. The endpoint of opendashboard

Returns:	The opendashboard_url of this SecuritySamlConfig.
Return type:	str

roles_key¶

Gets the roles_key of this SecuritySamlConfig. The roles key is sued to get backend roles from SAML assertion

Returns:	The roles_key of this SecuritySamlConfig.
Return type:	str

subject_key¶

Gets the subject_key of this SecuritySamlConfig. The subject key is used to get username from SAML assertion. By default, it is NameID

Returns:	The subject_key of this SecuritySamlConfig.
Return type:	str