Tüm Ürünler
Search

Bu Ürün

    :SetExternalSAMLIdentityProvider

    Belge Merkezi

    :SetExternalSAMLIdentityProvider

    Son Güncelleme:Sep 30, 2026

    Bir Güvenlik Onayı İşaretleme Dili (SAML) kimlik sağlayıcısını (IdP) yapılandırır.

    Operation description

    SAML 2.0 tabanlı tek oturum açma (SSO) işlemi sırasında CloudSSO bir hizmet sağlayıcı (SP), bir işletmenin kimlik yönetim sistemi ise bir IdP'dir.

    Bir SAML IdP'sini yapılandırmak için aşağıdaki yöntemlerden birini kullanabilirsiniz. Gerekli meta veri dosyasını veya parametre değerlerini IdP'nizden alabilirsiniz.

    • Meta veri dosyasını kullanma: Meta veri dosyasını yüklemek için EncodedMetadataDocument parametresini belirtebilirsiniz.

    • IdP'yi manuel olarak yapılandırma: IdP'niz için EntityId, LoginUrl, WantRequestSigned ve X509Certificate parametrelerini manuel olarak belirtebilirsiniz.

    Halihazırda bir SAML IdP'si yapılandırdıysanız, bu işlemi çağırdığınızda mevcut yapılandırmalar değiştirilir.

    • IdP meta veri dosyası kullanılarak yapılandırıldıysa, tüm mevcut yapılandırmaların yerine yeni yapılandırmalar geçer.

    • IdP manuel olarak yapılandırıldıysa, yeni parametre değerlerinden farklı olan orijinal parametre değerleri değiştirilir.

    Not

    SSO oturum açma etkinleştirilmişse, yeni yapılandırmalar hemen yürürlüğe girer. Üretim ortamı üzerindeki etkilerine dikkat edin.

    Bu konu, d-00fc2p61**** dizini içindeki meta veri dosyasını kullanarak bir IdP'nin nasıl yapılandırılacağına dair bir örnek sunar.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    cloudsso:SetExternalSAMLIdentityProvider

    update

    *Directory

    acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DirectoryId

    string

    Yes

    Dizin kimliği.

    d-00fc2p61****
    EncodedMetadataDocument

    string

    No

    IdP'nin meta veri dosyası. Bu parametrenin değeri Base64 ile kodlanmıştır.

    Dosya, SAML 2.0'ı destekleyen IdP tarafından sağlanır.

    PD94bWwgdmVyc2lvbj0iMS4****
    SSOStatus

    string

    No

    SSO oturum açma durumu. Geçerli değerler:

    • Enabled

    • Disabled (varsayılan)

    Disabled
    EntityId

    string

    No

    IdP'nin varlık kimliği.

    http://www.okta.com/exk3qwgtjhetR2Od****
    LoginUrl

    string

    No

    IdP'nin oturum açma URL'si.

    https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml
    WantRequestSigned

    boolean

    No

    CloudSSO'nun SAML isteklerini imzalaması gerekip gerekmediğini belirtir. İstekler, kullanıcılar SAML tabanlı SSO başlatmak üzere CloudSSO kullanıcı portalında oturum açtığında gönderilir. Geçerli değerler:

    • true

    • false (varsayılan)

    false
    X509Certificate

    string

    No

    PEM formatındaki X.509 sertifikası. Bu parametreyi belirtirseniz, mevcut tüm sertifikalar değiştirilir.

    MIIC8DCCAdigAwIBAgIQP9eomUYGeoND****
    BindingType

    string

    No

    SAML isteklerini göndermek için kullanılan bağlama. Geçerli değerler:

    • Post: HTTP Post bağlamaları.

    • Redirect: HTTP Redirect bağlamaları.

    Redirect

    Response elements

    Element

    Type

    Description

    Example

    object

    Yanıt parametreleri.

    RequestId

    string

    İstek kimliği.

    63160579-2E1B-57B0-8273-B27427172385
    SAMLIdentityProviderConfiguration

    object

    IdP yapılandırmaları.

    EntityId

    string

    IdP'nin varlık kimliği.

    http://www.okta.com/exk3qwgtjhetR2Od****
    SSOStatus

    string

    SSO oturum açma durumu. Geçerli değerler:

    • Enabled

    • Disabled

    Disabled
    DirectoryId

    string

    Dizin kimliği.

    d-00fc2p61****
    EncodedMetadataDocument

    string

    IdP'nin meta veri dosyası. Bu parametrenin değeri Base64 ile kodlanmıştır.

    PD94bWwgdmVyc2lvbj0iMS4****
    CreateTime

    string

    IdP'nin ilk kez yapılandırıldığı zaman.

    2021-11-10T02:57:16Z
    WantRequestSigned

    boolean

    CloudSSO'nun SAML isteklerini imzalaması gerekip gerekmediğini gösterir. İstekler, kullanıcılar SAML tabanlı SSO başlatmak üzere CloudSSO kullanıcı portalında oturum açtığında gönderilir. Geçerli değerler:

    • true

    • false (varsayılan)

    false
    UpdateTime

    string

    IdP yapılandırmalarının en son değiştirildiği zaman.

    2021-11-10T02:57:16Z
    CertificateIds

    array

    SAML imzalama sertifikalarının kimlikleri.

    string

    SAML imzalama sertifikasının kimliği.

    Birden fazla kimlik virgül (,) ile ayrılır.

    [ "idp-c-00buzdx63z8ewtdf****", "idp-c-00gmuxnr2mrek3t2****" ]
    LoginUrl

    string

    IdP'nin oturum açma URL'si.

    https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml
    BindingType

    string

    SAML isteklerini göndermek için kullanılan bağlama. Geçerli değerler:

    • Post: HTTP Post bağlamaları.

    • Redirect: HTTP Redirect bağlamaları.

    Redirect

    Examples

    Success response

    JSON format

    {
  "RequestId": "63160579-2E1B-57B0-8273-B27427172385",
  "SAMLIdentityProviderConfiguration": {
    "EntityId": "http://www.okta.com/exk3qwgtjhetR2Od****",
    "SSOStatus": "Disabled",
    "DirectoryId": "d-00fc2p61****",
    "EncodedMetadataDocument": "PD94bWwgdmVyc2lvbj0iMS4****",
    "CreateTime": "2021-11-10T02:57:16Z",
    "WantRequestSigned": false,
    "UpdateTime": "2021-11-10T02:57:16Z",
    "CertificateIds": [
      "[ \"idp-c-00buzdx63z8ewtdf****\", \"idp-c-00gmuxnr2mrek3t2****\" ]"
    ],
    "LoginUrl": "https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml",
    "BindingType": "Redirect"
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.