Class: Aws::ManagedGrafana::Types::SamlConfiguration

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 SamlConfiguration data as a hash:

{
  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"],
  },
}

A structure containing information about how this workspace works with SAML.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_organizationsArray<String>

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.

Returns:

  • (Array<String>)


827
828
829
830
831
832
833
834
835
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 827

class SamlConfiguration < Struct.new(
  :allowed_organizations,
  :assertion_attributes,
  :idp_metadata,
  :login_validity_duration,
  :role_values)
  SENSITIVE = []
  include Aws::Structure
end

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



827
828
829
830
831
832
833
834
835
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 827

class SamlConfiguration < Struct.new(
  :allowed_organizations,
  :assertion_attributes,
  :idp_metadata,
  :login_validity_duration,
  :role_values)
  SENSITIVE = []
  include Aws::Structure
end

#idp_metadataTypes::IdpMetadata

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

Returns:



827
828
829
830
831
832
833
834
835
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 827

class SamlConfiguration < Struct.new(
  :allowed_organizations,
  :assertion_attributes,
  :idp_metadata,
  :login_validity_duration,
  :role_values)
  SENSITIVE = []
  include Aws::Structure
end

#login_validity_durationInteger

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

Returns:

  • (Integer)


827
828
829
830
831
832
833
834
835
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 827

class SamlConfiguration < Struct.new(
  :allowed_organizations,
  :assertion_attributes,
  :idp_metadata,
  :login_validity_duration,
  :role_values)
  SENSITIVE = []
  include Aws::Structure
end

#role_valuesTypes::RoleValues

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

Returns:



827
828
829
830
831
832
833
834
835
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 827

class SamlConfiguration < Struct.new(
  :allowed_organizations,
  :assertion_attributes,
  :idp_metadata,
  :login_validity_duration,
  :role_values)
  SENSITIVE = []
  include Aws::Structure
end