interface SamlConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Grafana.CfnWorkspace.SamlConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsgrafana#CfnWorkspace_SamlConfigurationProperty`
Java	`software.amazon.awscdk.services.grafana.CfnWorkspace.SamlConfigurationProperty`
Python	`aws_cdk.aws_grafana.CfnWorkspace.SamlConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_grafana` » `CfnWorkspace` » `SamlConfigurationProperty`

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_grafana as grafana } from 'aws-cdk-lib';
const samlConfigurationProperty: grafana.CfnWorkspace.SamlConfigurationProperty = {
  idpMetadata: {
    url: 'url',
    xml: 'xml',
  },

  // the properties below are optional
  allowedOrganizations: ['allowedOrganizations'],
  assertionAttributes: {
    email: 'email',
    groups: 'groups',
    login: 'login',
    name: 'name',
    org: 'org',
    role: 'role',
  },
  loginValidityDuration: 123,
  roleValues: {
    admin: ['admin'],
    editor: ['editor'],
  },
};

Properties

Name	Type	Description
idpMetadata	`IResolvable` `\|` `IdpMetadataProperty`	A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
allowedOrganizations?	`string[]`	Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace.
assertionAttributes?	`IResolvable` `\|` `AssertionAttributesProperty`	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.
loginValidityDuration?	`number`	How long a sign-on session by a SAML user is valid, before the user has to sign on again.
roleValues?	`IResolvable` `\|` `RoleValuesProperty`	A structure containing arrays that map group names in the SAML assertion to the Grafana `Admin` and `Editor` roles in the workspace.

idpMetadata

Type: IResolvable | IdpMetadataProperty

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

allowedOrganizations?

Type: string[] (optional)

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.

assertionAttributes?

Type: IResolvable | AssertionAttributesProperty (optional)

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.

loginValidityDuration?

Type: number (optional)

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

roleValues?

Type: IResolvable | RoleValuesProperty (optional)

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