ALIYUN::CloudSSO::SAMLIdentityProvider は、Security Assertion Markup Language(SAML)ID プロバイダー(IdP)に関する情報を設定するために使用されます。
構文
{
"Type": "ALIYUN::CloudSSO::SAMLIdentityProvider",
"Properties": {
"EntityId": String,
"SSOStatus": String,
"DirectoryId": String,
"EncodedMetadataDocument": String,
"WantRequestSigned": Boolean,
"LoginUrl": String,
"X509Certificate": String
}
}プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
DirectoryId | String | はい | いいえ | ディレクトリ ID。 | なし。 |
EncodedMetadataDocument | String | いいえ | いいえ | IdP のメタデータファイル。このプロパティの値は Base64 でエンコードされています。 | ファイルは、SAML 2.0 をサポートする IdP によって提供されます。 |
EntityId | String | いいえ | いいえ | IdP のエンティティ ID。 | なし。 |
LoginUrl | String | いいえ | いいえ | IdP のログイン URL。 | なし。 |
SSOStatus | String | いいえ | いいえ | シングルサインオン(SSO)ログインのステータス。 | 有効な値:
|
WantRequestSigned | Boolean | いいえ | いいえ | CloudSSO が SAML リクエストに署名する必要があるかどうかを指定します。リクエストは、ユーザーが CloudSSO ユーザーポータルにログインして SAML ベースの SSO を開始するときに送信されます。 | 有効な値:
|
X509Certificate | String | いいえ | いいえ | Privacy Enhanced Mail(PEM)形式の X.509 証明書。 | このプロパティを指定すると、既存のすべての証明書が置き換えられます。 |
戻り値
Fn::GetAtt
なし。
例
YAML 形式
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
DirectoryId:
Description:
ja: ディレクトリの ID。
Required: true
Type: String
EncodedMetadataDocument:
Description:
ja: 'IdP のメタデータファイル。このパラメーターの値は Base64 でエンコードされています。
ファイルは、SAML 2.0 をサポートする IdP によって提供されます。'
Required: false
Type: String
EntityId:
Description:
ja: IdP のエンティティ ID。
Required: false
Type: String
LoginUrl:
Description:
ja: IdP のログイン URL。
Required: false
Type: String
SSOStatus:
AllowedValues:
- Enabled
- Disabled
Description:
ja: 'SSO ログインのステータス。有効な値:
- Enabled
- Disabled (デフォルト)'
Required: false
Type: String
WantRequestSigned:
Description:
ja: 'CloudSSO が SAML リクエストに署名する必要があるかどうかを指定します。リクエストは、ユーザーが CloudSSO ユーザーポータルにログインして SAML ベースの SSO を開始するときに送信されます。有効な値:
- true: はい
- false: いいえ (デフォルト)'
Required: false
Type: Boolean
X509Certificate:
Description:
ja: PEM 形式の X.509 証明書。このパラメーターを指定すると、既存のすべての証明書が置き換えられます。
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
JSON 形式
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"EntityId": {
"Type": "String",
"Description": {
"ja": "IdP のエンティティ ID。"
},
"Required": false
},
"SSOStatus": {
"Type": "String",
"Description": {
"ja": "SSO ログインのステータス。有効な値:\n- Enabled\n- Disabled (デフォルト)"
},
"AllowedValues": [
"Enabled",
"Disabled"
],
"Required": false
},
"DirectoryId": {
"Type": "String",
"Description": {
"ja": "ディレクトリの ID。"
},
"Required": true
},
"EncodedMetadataDocument": {
"Type": "String",
"Description": {
"ja": "IdP のメタデータファイル。このパラメーターの値は Base64 でエンコードされています。\nファイルは、SAML 2.0 をサポートする IdP によって提供されます。"
},
"Required": false
},
"WantRequestSigned": {
"Type": "Boolean",
"Description": {
"ja": "CloudSSO が SAML リクエストに署名する必要があるかどうかを指定します。リクエストは、ユーザーが CloudSSO ユーザーポータルにログインして SAML ベースの SSO を開始するときに送信されます。有効な値:\n- true: はい\n- false: いいえ (デフォルト)"
},
"Required": false
},
"LoginUrl": {
"Type": "String",
"Description": {
"ja": "IdP のログイン URL。"
},
"Required": false
},
"X509Certificate": {
"Type": "String",
"Description": {
"ja": "PEM 形式の X.509 証明書。このパラメーターを指定すると、既存のすべての証明書が置き換えられます。"
},
"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"
}
}
}
}
}