CreateOIDCProvider - Resource Access Management - Centro de documentación de Alibaba Cloud

Crea un proveedor de identidades (IdP) de OpenID Connect (OIDC) para configurar una relación de confianza entre Alibaba Cloud y un IdP externo. Este tema proporciona un ejemplo sobre cómo crear un IdP denominado TestOIDCProvider para configurar una relación de confianza entre el IdP externo Okta y Alibaba Cloud.

Descripción de la operación

Requisitos previos

Antes de llamar a esta operación, asegúrese de haber obtenido la información necesaria de un IdP externo, como Google Workspace u Okta, incluida la URL del emisor, las huellas digitales de los certificados de autoridad de certificación (CA) HTTPS y los ID de cliente.

Límites

Puede crear un máximo de 100 IdP OIDC en una cuenta de Alibaba Cloud.
Puede agregar un máximo de 50 ID de cliente a un IdP OIDC.
Puede agregar un máximo de cinco huellas digitales a un IdP OIDC.

Descripción de la operación

Este tema proporciona un ejemplo sobre cómo crear un IdP denominado TestOIDCProvider para configurar una relación de confianza entre el IdP externo y Alibaba Cloud.

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

ram:CreateOIDCProvider

create

*All Resource

*

ram:OidcIssuerUrl

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
OIDCProviderName	string	No	El nombre del IdP OIDC. El nombre puede contener letras, dígitos y caracteres especiales, y no puede comenzar ni terminar con dichos caracteres especiales. Los caracteres especiales son `puntos (.), guiones (-) y guiones bajos (_)`.`` El nombre puede tener una longitud máxima de 128 caracteres.	TestOIDCProvider
IssuerUrl	string	No	La URL del emisor, proporcionada por el IdP externo. La URL del emisor debe ser única dentro de una cuenta de Alibaba Cloud. La URL del emisor debe comenzar con `https` y tener un formato de URL válido. La URL no puede contener parámetros de consulta después de un signo de interrogación (`?`) ni información de inicio de sesión identificada por arrobas (`@`). La URL no puede ser una URL de fragmento que contenga almohadillas (`#`). La URL puede tener una longitud máxima de 255 caracteres.	https://xxxxxx.example.com
Description	string	No	La descripción del IdP OIDC. La descripción puede tener una longitud máxima de 256 caracteres.	This is an OIDC Provider
ClientIds	string	No	El ID del cliente, proporcionado por el IdP externo. Si desea especificar varios ID de cliente, sepárelos con comas (,). El ID de cliente puede contener letras, dígitos y caracteres especiales, y no puede comenzar con dichos caracteres especiales. Los caracteres especiales son `puntos (.), guiones (-), guiones bajos (_), dos puntos (:) y barras diagonales (/)`.`` El ID de cliente puede tener una longitud máxima de 128 caracteres.	498469743454717****
Fingerprints	string	No	La huella digital del certificado de CA HTTPS, proporcionada por el IdP externo. Si desea especificar varias huellas digitales, sepárelas con comas (,). La huella digital puede contener letras y dígitos. La huella digital puede tener una longitud máxima de 128 caracteres.	902ef2deeb3c5b13ea4c3d5193629309e231****
IssuanceLimitTime	integer	No	La hora más temprana en la que un IdP externo puede emitir un token de ID. Si el valor del campo iat en el token de ID es posterior a la hora actual, la solicitud se rechaza. Unidad: horas. Valores válidos: de 1 a 168.	6

Para obtener más información sobre los parámetros de solicitud comunes, consulte Referencia de API.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
RequestId	string	El ID de la solicitud.	64B11B41-636D-51E3-A39B-C8703CD2218C
OIDCProvider	object	La información sobre el IdP OIDC.
UpdateDate	string	La hora en la que se modificó el IdP OIDC. La hora se muestra en formato UTC.	2021-11-11T06:56:03Z
Description	string	La descripción del IdP OIDC.	This is an OIDC Provider
OIDCProviderName	string	El nombre del IdP OIDC.	TestOIDCProvider
CreateDate	string	La hora en la que se creó el IdP OIDC. La hora se muestra en formato UTC.	2021-11-11T06:56:03Z
Arn	string	El nombre de recurso de Alibaba Cloud (ARN) del IdP OIDC.	acs:ram::177242285274****:oidc-provider/TestOIDCProvider
IssuerUrl	string	La URL del emisor.	https://xxxxxx.example.com
Fingerprints	string	La huella digital del certificado HTTPS.	902ef2deeb3c5b13ea4c3d5193629309e231****
ClientIds	string	El ID del cliente.	498469743454717****
GmtCreate	string	La marca de tiempo en la que se creó el IdP OIDC.	1636613763000
GmtModified	string	La marca de tiempo en la que se modificó el IdP OIDC.	1636613763000
IssuanceLimitTime	integer	La hora más temprana en la que un IdP externo puede emitir un token de ID. Si el valor del campo iat en el token de ID es posterior a la hora actual, la solicitud se rechaza. Unidad: horas. Valores válidos: de 1 a 168.	6

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "64B11B41-636D-51E3-A39B-C8703CD2218C",
  "OIDCProvider": {
    "UpdateDate": "2021-11-11T06:56:03Z",
    "Description": "This is an OIDC Provider.",
    "OIDCProviderName": "TestOIDCProvider",
    "CreateDate": "2021-11-11T06:56:03Z",
    "Arn": "acs:ram::177242285274****:oidc-provider/TestOIDCProvider",
    "IssuerUrl": "https://xxxxxx.example.com",
    "Fingerprints": "902ef2deeb3c5b13ea4c3d5193629309e231****",
    "ClientIds": "498469743454717****",
    "GmtCreate": "1636613763000",
    "GmtModified": "1636613763000",
    "IssuanceLimitTime": 6
  }
}

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.