Skip to content

SAMLIdentityProviderProps

Properties for defining a SAMLIdentityProvider.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-cloudsso-samlidentityprovider

Initializer 

import { SAMLIdentityProviderProps } from '@alicloud/ros-cdk-cloudsso'
const sAMLIdentityProviderProps: SAMLIdentityProviderProps = { ... }

Properties

Name Type Description
directoryId string | @alicloud/ros-cdk-core.IResolvable Property directoryId: The ID of the directory.
encodedMetadataDocument string | @alicloud/ros-cdk-core.IResolvable Property encodedMetadataDocument: The metadata file of the IdP.
entityId string | @alicloud/ros-cdk-core.IResolvable Property entityId: The entity ID of the IdP.
loginUrl string | @alicloud/ros-cdk-core.IResolvable Property loginUrl: The logon URL of the IdP.
ssoStatus string | @alicloud/ros-cdk-core.IResolvable Property ssoStatus: The status of SSO logon.
wantRequestSigned boolean | @alicloud/ros-cdk-core.IResolvable Property wantRequestSigned: Specifies whether CloudSSO needs to sign SAML requests.
x509Certificate string | @alicloud/ros-cdk-core.IResolvable Property x509Certificate: The X.509 certificate n the PEM format. If you specify this parameter, all existing certificates are replaced.

directoryIdRequired 

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

Property directoryId: The ID of the directory.

encodedMetadataDocumentOptional 

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

Property encodedMetadataDocument: The metadata file of the IdP.

The value of this parameter is Base64-encoded. The file is provided by the IdP that supports SAML 2.0.

entityIdOptional 

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

Property entityId: The entity ID of the IdP.

loginUrlOptional 

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

Property loginUrl: The logon URL of the IdP.

ssoStatusOptional 

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

Property ssoStatus: The status of SSO logon.

Valid values: - Enabled - Disabled (default)

wantRequestSignedOptional 

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

Property wantRequestSigned: Specifies whether CloudSSO needs to sign SAML requests.

The requests are sent when users log on to the CloudSSO user portal to initiate SAML-based SSO. Valid values: - true: yes - false: no (default)

x509CertificateOptional 

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

Property x509Certificate: The X.509 certificate n the PEM format. If you specify this parameter, all existing certificates are replaced.