Skip to content

SamlConfiguration

Source code in docs_src/capo_grafana/types/saml_configuration.py
class SamlConfiguration(TypedDict, closed=True):
    idp_metadata: "capo_grafana.types.idp_metadata.IdpMetadata"
    """<p>A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.</p>"""
    assertion_attributes: NotRequired[
        "capo_grafana.types.assertion_attributes.AssertionAttributes"
    ]
    """<p>A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.</p>"""
    role_values: NotRequired["capo_grafana.types.role_values.RoleValues"]
    """<p>A structure containing arrays that map group names in the SAML assertion to the Grafana <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>"""
    allowed_organizations: NotRequired[
        "capo_grafana.types.allowed_organizations.AllowedOrganizations"
    ]
    """<p>Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.</p>"""
    login_validity_duration: (
        "capo_grafana.types.login_validity_duration.LoginValidityDuration"
    )
    """<p>How long a sign-on session by a SAML user is valid, before the user has to sign on again.</p>"""

allowed_organizations instance-attribute

allowed_organizations: NotRequired[AllowedOrganizations]

Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.

assertion_attributes instance-attribute

assertion_attributes: NotRequired[AssertionAttributes]

A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.

idp_metadata instance-attribute

idp_metadata: IdpMetadata

A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.

login_validity_duration instance-attribute

login_validity_duration: LoginValidityDuration

How long a sign-on session by a SAML user is valid, before the user has to sign on again.

role_values instance-attribute

role_values: NotRequired[RoleValues]

A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.