Skip to content

UpdateWorkspaceAuthenticationRequest

Source code in docs_src/capo_grafana/types/update_workspace_authentication_request.py 
15
16
17
18
19
20
21
22
23
24
25
class UpdateWorkspaceAuthenticationRequest(TypedDict, closed=True):
    workspace_id: "capo_grafana.types.workspace_id.WorkspaceId"
    """<p>The ID of the workspace to update the authentication for.</p>"""
    authentication_providers: (
        "capo_grafana.types.authentication_providers.AuthenticationProviders"
    )
    """<p>Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html">User authentication in Amazon Managed Grafana</a>.</p>"""
    saml_configuration: NotRequired[
        "capo_grafana.types.saml_configuration.SamlConfiguration"
    ]
    """<p>If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the <code>Admin</code> and <code>Editor</code> roles in the workspace.</p>"""

authentication_providers instance-attribute 

authentication_providers: AuthenticationProviders

Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

saml_configuration instance-attribute 

saml_configuration: NotRequired[SamlConfiguration]

If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace.

workspace_id instance-attribute 

workspace_id: WorkspaceId

The ID of the workspace to update the authentication for.