O recurso ALIYUN::CloudSSO::SAMLIdentityProvider configura um provedor de identidade (IdP) SAML (Security Assertion Markup Language).
Sintaxe
{
"Type": "ALIYUN::CloudSSO::SAMLIdentityProvider",
"Properties": {
"EntityId": String,
"SSOStatus": String,
"DirectoryId": String,
"EncodedMetadataDocument": String,
"WantRequestSigned": Boolean,
"LoginUrl": String,
"X509Certificate": String
}
}Propriedades
|
Propriedade |
Tipo |
Obrigatório |
Editável |
Descrição |
Restrição |
|
DirectoryId |
String |
Sim |
Não |
ID do diretório. |
Nenhuma. |
|
EncodedMetadataDocument |
String |
Não |
Não |
Arquivo de metadados do IdP codificado em Base64. |
O IdP compatível com SAML 2.0 fornece este arquivo. |
|
EntityId |
String |
Não |
Não |
ID da entidade do IdP. |
Nenhuma. |
|
LoginUrl |
String |
Não |
Não |
URL de logon do IdP. |
Nenhuma. |
|
SSOStatus |
String |
Não |
Não |
Status do logon de single sign-on (SSO). |
Valores válidos:
|
|
WantRequestSigned |
Boolean |
Não |
Não |
Define se o CloudSSO assina as solicitações SAML enviadas durante o logon dos usuários no portal do usuário do CloudSSO para iniciar o SSO baseado em SAML. |
Valores válidos:
|
|
X509Certificate |
String |
Não |
Não |
Certificado X.509 no formato Privacy Enhanced Mail (PEM). |
A especificação desta propriedade substitui todos os certificados existentes. |
Valores de retorno
Fn::GetAtt
Nenhum.
Exemplos
Formato YAML
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
DirectoryId:
Description:
en: The ID of the directory.
Required: true
Type: String
EncodedMetadataDocument:
Description:
en: '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.'
Required: false
Type: String
EntityId:
Description:
en: The entity ID of the IdP.
Required: false
Type: String
LoginUrl:
Description:
en: The logon URL of the IdP.
Required: false
Type: String
SSOStatus:
AllowedValues:
- Enabled
- Disabled
Description:
en: 'The status of SSO logon. Valid values:
- Enabled
- Disabled (default)'
Required: false
Type: String
WantRequestSigned:
Description:
en: '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)'
Required: false
Type: Boolean
X509Certificate:
Description:
en: The X.509 certificate n the PEM format. If you specify this parameter, all
existing certificates are replaced.
Required: false
Type: String
Resources:
SAMLIdentityProvider:
Properties:
DirectoryId:
Ref: DirectoryId
EncodedMetadataDocument:
Ref: EncodedMetadataDocument
EntityId:
Ref: EntityId
LoginUrl:
Ref: LoginUrl
SSOStatus:
Ref: SSOStatus
WantRequestSigned:
Ref: WantRequestSigned
X509Certificate:
Ref: X509Certificate
Type: ALIYUN::CloudSSO::SAMLIdentityProvider
Formato JSON
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"EntityId": {
"Type": "String",
"Description": {
"en": "The entity ID of the IdP."
},
"Required": false
},
"SSOStatus": {
"Type": "String",
"Description": {
"en": "The status of SSO logon. Valid values:\n- Enabled\n- Disabled (default)"
},
"AllowedValues": [
"Enabled",
"Disabled"
],
"Required": false
},
"DirectoryId": {
"Type": "String",
"Description": {
"en": "The ID of the directory."
},
"Required": true
},
"EncodedMetadataDocument": {
"Type": "String",
"Description": {
"en": "The metadata file of the IdP. The value of this parameter is Base64-encoded.\nThe file is provided by the IdP that supports SAML 2.0."
},
"Required": false
},
"WantRequestSigned": {
"Type": "Boolean",
"Description": {
"en": "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:\n- true: yes\n- false: no (default)"
},
"Required": false
},
"LoginUrl": {
"Type": "String",
"Description": {
"en": "The logon URL of the IdP."
},
"Required": false
},
"X509Certificate": {
"Type": "String",
"Description": {
"en": "The X.509 certificate n the PEM format. If you specify this parameter, all existing certificates are replaced."
},
"Required": false
}
},
"Resources": {
"SAMLIdentityProvider": {
"Type": "ALIYUN::CloudSSO::SAMLIdentityProvider",
"Properties": {
"EntityId": {
"Ref": "EntityId"
},
"SSOStatus": {
"Ref": "SSOStatus"
},
"DirectoryId": {
"Ref": "DirectoryId"
},
"EncodedMetadataDocument": {
"Ref": "EncodedMetadataDocument"
},
"WantRequestSigned": {
"Ref": "WantRequestSigned"
},
"LoginUrl": {
"Ref": "LoginUrl"
},
"X509Certificate": {
"Ref": "X509Certificate"
}
}
}
}
}