Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ Identity and Access Management/ Referencia de la API/ API/ Gestión de autenticación de identidades federadas/ Protocolos/ Registro de un protocolo

Actualización más reciente 2024-08-01 GMT+08:00

Ver PDF

Registro de un protocolo

Función

Esta API se proporciona para que el administrador asocie un protocolo con un proveedor de identidad después de crear el proveedor de identidad.

Se puede invocar a la API utilizando tanto el punto de conexión global como los puntos de conexión específicos de la región. Para los puntos de conexión de IAM, consulte Regiones y puntos de conexión.

URI

PUT /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}

**Tabla 1** Parámetros de URI
Parámetro	Obligatorio	Tipo	Descripción
idp_id	Sí	String	Nombre del proveedor de identidad.
protocol_id	Sí	String	ID del protocolo a registrar El valor de este campo puede ser saml u oidc.

Parámetros de solicitud

**Tabla 2** Parámetros en el encabezado de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	Token de acceso emitido a un usuario para acreditar su identidad y sus permisos. Para obtener más información sobre los permisos requeridos por el token, consulte Acciones.

**Tabla 3** Parámetros en el cuerpo de la solicitud
Parámetro	Obligatorio	Tipo	Descripción
protocol	Sí	Object	Información de protocolos.

**Tabla 4** protocol
Parámetro	Obligatorio	Tipo	Descripción
mapping_id	No	String	ID de asignación.

Parámetros de respuesta

**Tabla 5** Parámetros en el cuerpo de respuesta
Parámetro	Tipo	Descripción
protocol	Object	Información de protocolos.

**Tabla 6** protocol
Parámetro	Tipo	Descripción
id	String	El valor de este campo puede ser saml u oidc.
mapping_id	String	ID de asignación.
links	Object	Información de enlace de recursos de protocolo.

**Tabla 7** protocol.links
Parámetro	Tipo	Descripción
identity_provider	String	Enlace de recurso del proveedor de identidad.
self	String	Enlace de recurso.

Ejemplo de solicitud

Solicitud de registro de un protocolo

PUT https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}

{
    "protocol": {
        "mapping_id": "ACME"
    }
}

Ejemplo de respuesta

Código de estado: 201

La solicitud se ha realizado correctamente.

{
    "protocol": {
        "mapping_id": "ACME",
        "id": "saml",
        "links": {
            "self": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME/protocols/saml",
            "identity_provider": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME"
        }
    }
}

Códigos de estado

Código de estado	Descripción
201	La solicitud se ha realizado correctamente.
400	Parámetros no válidos.
401	Error de autenticación.
403	Acceso denegado.
404	No se puede encontrar el recurso solicitado.
405	El método especificado en la solicitud no está permitido para el recurso solicitado.
413	La entidad solicitada es demasiado grande.
500	Error de servidor interno.
503	Servicio no disponible.