SetExternalSAMLIdentityProvider - CloudSSO - Centro de documentación de Alibaba Cloud

Configura un proveedor de identidad (IdP) de Security Assertion Markup Language (SAML).

Descripción de la operación

Durante el inicio de sesión único (SSO) basado en SAML 2.0, CloudSSO actúa como proveedor de servicios (SP) y el sistema de gestión de identidades de una empresa actúa como IdP.

Puede utilizar uno de los siguientes métodos para configurar un IdP SAML. Puede obtener el archivo de metadatos o los valores de parámetros necesarios de su IdP.

Uso del archivo de metadatos: Puede especificar el parámetro EncodedMetadataDocument para cargar el archivo de metadatos.
Configuración manual del IdP: Puede especificar manualmente los siguientes parámetros para su IdP: EntityId, LoginUrl, WantRequestSigned y X509Certificate.

Si ya ha configurado un IdP SAML, las configuraciones existentes se reemplazan después de llamar a esta operación.

Si el IdP se configura mediante el archivo de metadatos, todas las configuraciones existentes se reemplazan con las nuevas configuraciones.
Si el IdP se configura manualmente, se reemplazan los valores de parámetros originales que difieren de los nuevos valores de parámetros.

Nota

Si el inicio de sesión SSO está habilitado, las nuevas configuraciones surten efecto inmediatamente. Tenga en cuenta los impactos en el entorno de producción.

Este tema proporciona un ejemplo de cómo configurar un IdP mediante el archivo de metadatos dentro del directorio d-00fc2p61****.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

cloudsso:SetExternalSAMLIdentityProvider

update

*Directory

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DirectoryId	string	Sí	El ID del directorio.	d-00fc2p61****
EncodedMetadataDocument	string	No	El archivo de metadatos del IdP. El valor de este parámetro está codificado en Base64. El archivo lo proporciona el IdP compatible con SAML 2.0.	PD94bWwgdmVyc2lvbj0iMS4****
SSOStatus	string	No	El estado del inicio de sesión SSO. Valores válidos: Enabled Disabled (valor predeterminado)	Disabled
EntityId	string	No	El ID de entidad del IdP.	http://www.okta.com/exk3qwgtjhetR2Od****
LoginUrl	string	No	La URL de inicio de sesión del IdP.	https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml
WantRequestSigned	boolean	No	Especifica si CloudSSO necesita firmar las solicitudes SAML. Las solicitudes se envían cuando los usuarios inician sesión en el portal de usuarios de CloudSSO para iniciar el SSO basado en SAML. Valores válidos: true false (valor predeterminado)	false
X509Certificate	string	No	El certificado X.509 en formato PEM. Si especifica este parámetro, se reemplazan todos los certificados existentes.	MIIC8DCCAdigAwIBAgIQP9eomUYGeoND****
BindingType	string	No	El enlace para enviar solicitudes SAML. Valores válidos: Post: Enlaces HTTP Post. Redirect: Enlaces HTTP Redirect.	Redirect

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
RequestId	string	El ID de la solicitud.	63160579-2E1B-57B0-8273-B27427172385
SAMLIdentityProviderConfiguration	object	Las configuraciones del IdP.
EntityId	string	El ID de entidad del IdP.	http://www.okta.com/exk3qwgtjhetR2Od****
SSOStatus	string	El estado del inicio de sesión SSO. Valores válidos: Enabled Disabled	Disabled
DirectoryId	string	El ID del directorio.	d-00fc2p61****
EncodedMetadataDocument	string	El archivo de metadatos del IdP. El valor de este parámetro está codificado en Base64.	PD94bWwgdmVyc2lvbj0iMS4****
CreateTime	string	La hora en que se configuró el IdP por primera vez.	2021-11-10T02:57:16Z
WantRequestSigned	boolean	Indica si CloudSSO necesita firmar las solicitudes SAML. Las solicitudes se envían cuando los usuarios inician sesión en el portal de usuarios de CloudSSO para iniciar el SSO basado en SAML. Valores válidos: true false (valor predeterminado)	false
UpdateTime	string	La hora en que se modificaron por última vez las configuraciones del IdP.	2021-11-10T02:57:16Z
CertificateIds	array	Los ID de los certificados de firma SAML.
	string	El ID del certificado de firma SAML. Varios ID se separan con comas (,).	[ "idp-c-00buzdx63z8ewtdf**", "idp-c-00gmuxnr2mrek3t2**" ]
LoginUrl	string	La URL de inicio de sesión del IdP.	https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml
BindingType	string	El enlace para enviar solicitudes SAML. Valores válidos: Post: Enlaces HTTP Post. Redirect: Enlaces HTTP Redirect.	Redirect

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.