Skip to content

SAMLProviderProps

Properties for defining a SAMLProvider.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ram-samlprovider

Initializer 

import { SAMLProviderProps } from '@alicloud/ros-cdk-ram'
const sAMLProviderProps: SAMLProviderProps = { ... }

Properties

Name Type Description
samlProviderName string | @alicloud/ros-cdk-core.IResolvable Property samlProviderName: IdP Name.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description can contain a maximum of 256 characters.
encodedSamlMetadataDocument string | @alicloud/ros-cdk-core.IResolvable Property encodedSamlMetadataDocument: SAML metadata document.Base64 encoded. Provided by an identity provider that supports the SAML2.0 protocol. Only one of the three properties SAMLMetadataDocument, SAMLMetadataDocumentURL, EncodedSAMLMetadataDocument can be set.
samlMetadataDocument string | @alicloud/ros-cdk-core.IResolvable Property samlMetadataDocument: SAML metadata document.
samlMetadataDocumentUrl string | @alicloud/ros-cdk-core.IResolvable Property samlMetadataDocumentUrl: The URL for the file that contains the SAML metadata document.

samlProviderNameRequired 

public readonly samlProviderName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property samlProviderName: IdP Name.

The IdP name can contain a maximum of 128 characters and only letters, numbers, and the following special characters are accepted: hyphens (-), periods (.), and underscores (_). It cannot start or end with a special character.

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: The description can contain a maximum of 256 characters.

encodedSamlMetadataDocumentOptional 

public readonly encodedSamlMetadataDocument: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property encodedSamlMetadataDocument: SAML metadata document.Base64 encoded. Provided by an identity provider that supports the SAML2.0 protocol. Only one of the three properties SAMLMetadataDocument, SAMLMetadataDocumentURL, EncodedSAMLMetadataDocument can be set.

samlMetadataDocumentOptional 

public readonly samlMetadataDocument: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property samlMetadataDocument: SAML metadata document.

The content must be 1 to 102,400 bytes in length. Only one of the three properties SAMLMetadataDocument, SAMLMetadataDocumentURL, EncodedSAMLMetadataDocument can be set.

samlMetadataDocumentUrlOptional 

public readonly samlMetadataDocumentUrl: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property samlMetadataDocumentUrl: The URL for the file that contains the SAML metadata document.

The URL must point to a document located in an HTTP or HTTPS web server or an Alibaba Cloud OSS bucket. Examples: oss:\/\/ros\/document\/demo and oss:\/\/ros\/document\/demo?RegionId=cn-hangzhou. The URL can be up to 1,024 bytes in length. Only one of the three properties SAMLMetadataDocument, SAMLMetadataDocumentURL, EncodedSAMLMetadataDocument can be set.