ALIYUN::RAM::SAMLProvider - 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 name of the IdP.	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 of the IdP.	None.
SAMLMetadataDocumentURL	String	No	Yes	The URL of the metadata document.	The URL must be 1 to 1,024 bytes in size. You must specify one of the SAMLMetadataDocumentURL and SAMLMetadataDocument parameters.
SAMLMetadataDocument	String	No	Yes	The content of the metadata document.	The document content must be 1 to 102,400 bytes in size. You must specify one of the SAMLMetadataDocumentURL and SAMLMetadataDocument parameters.

Response parameters

Fn::GetAtt

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

Examples

YAMLformat

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

JSONformat

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