AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ManagedGrafana::Types::UpdateWorkspaceAuthenticationRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb

Overview

Note:

When making an API call, you may pass UpdateWorkspaceAuthenticationRequest data as a hash:

{
  authentication_providers: ["AWS_SSO"], # required, accepts AWS_SSO, SAML
  saml_configuration: {
    allowed_organizations: ["AllowedOrganization"],
    assertion_attributes: {
      email: "AssertionAttribute",
      groups: "AssertionAttribute",
      login: "AssertionAttribute",
      name: "AssertionAttribute",
      org: "AssertionAttribute",
      role: "AssertionAttribute",
    },
    idp_metadata: { # required
      url: "IdpMetadataUrl",
      xml: "String",
    },
    login_validity_duration: 1,
    role_values: {
      admin: ["RoleValue"],
      editor: ["RoleValue"],
    },
  },
  workspace_id: "WorkspaceId", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_providersArray<String>

Specifies whether this workspace uses SAML 2.0, Amazon Web Services Single Sign On, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

Returns:

  • (Array<String>)


1076
1077
1078
1079
1080
1081
1082
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1076

class UpdateWorkspaceAuthenticationRequest < Struct.new(
  :authentication_providers,
  :saml_configuration,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#saml_configurationTypes::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.



1076
1077
1078
1079
1080
1081
1082
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1076

class UpdateWorkspaceAuthenticationRequest < Struct.new(
  :authentication_providers,
  :saml_configuration,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_idString

The ID of the workspace to update the authentication for.

Returns:

  • (String)


1076
1077
1078
1079
1080
1081
1082
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1076

class UpdateWorkspaceAuthenticationRequest < Struct.new(
  :authentication_providers,
  :saml_configuration,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end