use ALIYUN::RAM::SAMLProvider to create an IdP for role-based SSO - Resource Orchestration Service

ALIYUN::RAM::SAMLProvider is used to create an identity provider (IdP) for role-based single sign-on (SSO).

Syntax

{
  "Type": "ALIYUN::RAM::SAMLProvider",
  "Properties": {
    "SAMLProviderName": String,
    "Description": String,
    "SAMLMetadataDocumentURL": String,
    "SAMLMetadataDocument": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
SAMLProviderName	String	Yes	No	The IdP name.	The name can be up to 128 characters in length, and can contain letters, digits, periods (.), hyphens (-), and underscores (_). It cannot start or end with a period (.), a hyphen (-), or an underscore (_).
Description	String	No	Yes	The description.	None.
SAMLMetadataDocumentURL	String	No	Yes	The URL of the metadata file.	The URL must be 1 to 1,024 bytes in length. You must specify only one of SAMLMetadataDocumentURL and SAMLMetadataDocument.
SAMLMetadataDocument	String	No	Yes	The content of the metadata file.	The content must be 1 to 102,400 bytes in length. You must specify only one of SAMLMetadataDocumentURL and SAMLMetadataDocument.
EncodedSAMLMetadataDocument	String	No	Yes	The metadata file that is Base64-encoded.	The file is provided by an IdP that supports Security Assertion Markup Language (SAML) 2.0.

Return values

Fn::GetAtt

SAMLProviderName: the IdP name.
Arn: the Alibaba Cloud Resource Name (ARN) of the IdP.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  SAMLProvider:
    Type: ALIYUN::RAM::SAMLProvider
    Properties:
      SAMLProviderName: TestSAMLProvider
Outputs:
  SAMLProviderName:
    Description: IdP Name.
    Value:
      Fn::GetAtt:
        - SAMLProvider
        - SAMLProviderName
  Arn:
    Description: ARN.
    Value:
      Fn::GetAtt:
        - SAMLProvider
        - Arn

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "SAMLProvider": {
      "Type": "ALIYUN::RAM::SAMLProvider",
      "Properties": {
        "SAMLProviderName": "TestSAMLProvider"
      }
    }
  },
  "Outputs": {
    "SAMLProviderName": {
      "Description": "IdP Name.",
      "Value": {
        "Fn::GetAtt": [
          "SAMLProvider",
          "SAMLProviderName"
        ]
      }
    },
    "Arn": {
      "Description": "ARN.",
      "Value": {
        "Fn::GetAtt": [
          "SAMLProvider",
          "Arn"
        ]
      }
    }
  }
}