Este documento describe casos de uso, extremos y API para el servicio de inicio de sesión único de Adobe.
Revisión actual - 1.0.0
Ámbito scope
El servicio SSO de Adobe Pass permite una autenticación perfecta entre varios dispositivos y aplicaciones, lo que ofrece una experiencia de usuario unificada y, al mismo tiempo, mantiene los estándares de seguridad y conformidad. Este servicio responde a la creciente necesidad de autenticación multiplataforma en el panorama actual de la transmisión multidispositivo.
Información general overview
Qué es what-it-is
Una solución completa de inicio de sesión único que permite a los usuarios autenticarse una vez y administrar la transferencia de autenticación de forma informada a otros dispositivos
Retos actuales para la autenticación current-challenges
El usuario debe autenticarse con cada servicio de streaming al que esté suscrito
El usuario debe autenticarse por separado en cada dispositivo o aplicación
Debido a la dificultad para escribir una contraseña en el flujo de autenticación en algunas plataformas, esto puede provocar un aumento en las tasas de abandono
Oportunidad para un servicio SSO de Adobe Pass opportunity
Aumento del número de servicios de streaming que requieren su propia autenticación
Creciente demanda de experiencias entre dispositivos sin problemas
Aumento del número de dispositivos de transmisión por secuencias por hogar
Necesidad de autenticación unificada por hogar
Ventajas comerciales business-benefits
Proveedores de contenido content-providers
Mayor participación del usuario: La experiencia perfecta lleva a tiempos de sesión más largos
Fricción reducida: las barreras de autenticación más bajas aumentan el consumo de contenido
Retención mejorada: una mejor experiencia del usuario reduce la pérdida
Reducción de costos - Menos tickets de soporte relacionados con problemas de autenticación
Usuarios finales end-users
Experiencia perfecta - Autenticar una vez y acceder a todas partes
Ahorro de tiempo - No hay procesos de inicio de sesión repetidos
Flexibilidad del dispositivo - Cambiar entre dispositivos sin interrupción
Experiencia coherente: autenticación uniforme en todas las plataformas
IdPs (MVPD, telecomunicaciones, etc.) idps
Se puede informar a las MVPD de dispositivos adicionales mediante un SSO autenticado
Satisfacción mejorada del usuario: experiencia de autenticación mejorada
Carga de soporte reducida: menos llamadas de soporte relacionadas con la autenticación
Ventaja competitiva: Mejor experiencia de usuario que la competencia
Casos de uso use-cases
Asignación de identidad identity-mapping
El servicio crea la capacidad de vincular una cuenta de D2C y una de TVE en la misma aplicación.
Más servicios de streaming están construyendo paquetes para ser vendidos a un tercero (MVPD/virtual MVPD/Telco, etc.). Es posible que los usuarios tengan que gestionar varias cuentas en la misma aplicación. Para crear una experiencia de autenticación perfecta, un servicio debe vincular estas cuentas para simplificar el inicio de sesión.
El usuario se autenticará con su cuenta D2C y, a continuación, autenticará ONCE con una cuenta diferente (por ejemplo, MVPD). Con nuestro servicio, estas cuentas se vincularán, lo que significa que en adelante, las autenticaciones posteriores en diferentes dispositivos se pueden realizar solo con la cuenta D2C.
SSO entre dispositivos cross-device-sso
La autenticación en un dispositivo conectado a la TV puede ser más engorrosa que en un teléfono móvil. Una buena experiencia de usuario sería autenticarse por teléfono y luego pasar esa autenticación al televisor inteligente.
Componentes clave key-components
API de token de servicio: componente clave que administra de forma segura el mecanismo de inicio de sesión único
API de lista: la aplicación puede ayudar al usuario a comprender la lista de dispositivos en su ecosistema
API de vínculo: la aplicación permite al usuario agregar dispositivos adicionales en su ecosistema
Desvincular API: la aplicación permite al usuario quitar dispositivos de su ecosistema
Casos de uso detallados use-cases-detailed
SSO D2C-TVE d2c-tve-sso
Este caso de uso permite la vinculación entre las credenciales de D2C y TVE (MVPD) en un dispositivo y aprovechar ese perfil vinculado en otros dispositivos dentro de la misma aplicación.
SSO entre dispositivos cross-device-sso-detailed
Este caso de uso permite a los usuarios que ya se han autenticado en un dispositivo reutilizar el perfil autenticado en la misma aplicación D2C o TVE instalada en otros dispositivos (aplicación necesaria para implementar Adobe Pass REST V2 para la autenticación y autorización).
Cómo integrar Adobe SSO Service en una aplicación D2C-TVE integration
Paso 1: Obtención de un identificador común step-1
Para integrar el servicio SSO de Adobe, una implementación de aplicación debe establecer un ID único y persistente para utilizarlo como atributo SSO de identificador común en X-SSO-ID. Esto se puede obtener autenticando a un usuario con un servicio D2C y conservando un atributo sobre esta autenticación.
Paso 2: Obtención de un token de servicio step-2
El uso del identificador común en X-SSO-ID en el extremo POST /serviceToken recuperará un JWT firmado con la siguiente carga útil:
El token de servicio tiene una fecha de caducidad "iat" (emitida el y "exp") en la que el intervalo de validez del token de servicio es válido. En caso de caducidad, se puede obtener un nuevo JWT mediante el extremo GET /serviceToken con el token de servicio caducado.
Paso 3: Autenticación mediante la API de REST de Adobe Pass V2 con un MVPD de TVE step-3
El "código" es un código de vínculo de corta duración en forma de secuencia de 6 dígitos que el usuario introduce en una aplicación no autenticada en un dispositivo secundario
Paso 5: Recuperación de la autenticación de inicio de sesión único step-5
En un dispositivo diferente, una vez que el usuario introdujo el código, la aplicación puede:
recuperar identidad del servicio D2C
recuperar el perfil de MVPD de Adobe Pass con la API de REST V2
El perfil de MVPD será válido mediante SSO durante el período en el que se obtuvo la autenticación inicial.
En caso de que MVPD invalide el perfil o el usuario decida cerrar la sesión desde MVPD, la aplicación que utiliza la API de REST de Adobe Pass V2 dejará de tener un registro de perfil y deberá exigir al usuario que vuelva a autenticarse con MVPD.
Paso 6: Administración del inicio de sesión único en otros dispositivos step-6
Una aplicación puede obtener información sobre todos los demás dispositivos vinculados con el mismo identificador común mediante la API /list.
En cualquier momento, se puede eliminar un dispositivo del inicio de sesión único desvinculando ese dispositivo con la API /unlink.
API apis
API de token de servicio service-token-api
Descripción service-token-description
La API de token de servicio se puede utilizar para solicitar y administrar tokens de servicio que habilitan la funcionalidad de inicio de sesión único (SSO) entre varias aplicaciones o dispositivos. Estos tokens de servicio identifican perfiles autenticados (perfiles SSO) y son esenciales para establecer y mantener conexiones SSO.
WARNING
Los tokens de servicio contienen información de autenticación confidencial. Las aplicaciones deben gestionar estos tokens de forma segura y nunca exponerlos a partes que no son de confianza.
La API de token de servicio proporciona dos extremos principales:
POST /api/{serviceProvider}/serviceToken: obtenga un token de servicio JWS recién creado
GET /api/{serviceProvider}/serviceToken: actualice un token de servicio JWS existente
En caso de que la solicitud de API de token de servicio no se haya podido atender debido a un error de los servicios de autenticación de Adobe Pass, se incluirá información de error adicional como parte de la respuesta de la API.
POST: serviceToken post-service-token
Solicitud post-service-token-request
HTTP
ruta
/api/{serviceProvider}/serviceToken
método
PUBLICAR
Parámetros de ruta
serviceProvider
Identificador del proveedor de servicios para el que se solicita el token.
obligatorio
Encabezados
Autorización
La generación de la carga útil del token de portador se describe en la documentación del encabezado Autorización.
obligatorio
AP-Device-Identifier
La generación de la carga del identificador de dispositivo se describe en la documentación del encabezado AP-Device-Identifier.
Este identificador se utiliza como identificador SSO predeterminado cuando no se proporciona X-SSO-ID.
obligatorio
X-Device-Info
La información del dispositivo especificada en la documentación del encabezado X-Device-Info.
Recomendamos que se use cuando la plataforma de dispositivo de la aplicación permita proporcionar valores válidos de forma explícita.
El backend de autenticación de Adobe Pass combinará valores establecidos explícitamente con valores extraídos implícitamente. Cuando no se proporciona, se utilizan los valores extraídos predeterminados.
obligatorio
X-SSO-LINK
El código de vínculo que asocia esta solicitud con un perfil autenticado existente. Cuando se proporciona, la respuesta incluye un token de servicio para SSO con el perfil que generó el código de vínculo.
Esto suele utilizarse cuando una aplicación o dispositivo secundario desea conectarse a un perfil autenticado desde una aplicación o dispositivo principal.
obligatorio si no se proporciona x-sso-id
X-SSO-ID
El identificador común en el que la aplicación solicita basar el SSO.
Cuando se proporcione, este identificador se utilizará para establecer un perfil de SSO común entre dispositivos o aplicaciones.
obligatorio si no se proporciona x-sso-link
Aceptar
El tipo de medio aceptado por la aplicación cliente.
Si se especifica, debe ser application/json.
opcional
User-Agent
El agente de usuario de la aplicación cliente.
opcional
Respuesta post-service-token-response
Código
Texto
Descripción
201
Creado
El token de servicio se generó correctamente y se devolvió en el cuerpo de respuesta.
400
Solicitud incorrecta
La solicitud no es válida, el cliente debe corregirla e intentarlo de nuevo. El cuerpo de respuesta puede contener información de error que se adhiera a la documentación de Códigos de error mejorados.
El lado del servidor ha encontrado un problema. El cuerpo de respuesta puede contener información de error que se adhiera a la documentación de Códigos de error mejorados.
Correcto success-post-service-token
Encabezados
Estado
201
obligatorio
Content-Type
application/json
obligatorio
Cuerpo
status
Estado HTTP (por ejemplo, "CREATED")
obligatorio
jws
Una firma web JSON (JWS) codificada en Base64 que contiene el token de servicio. Este token se puede utilizar en llamadas de API posteriores para identificar el perfil autenticado y habilitar la funcionalidad de SSO.
obligatorio
notBefore
Epoch ms o 0 si hay error
obligatorio
notAfter
Epoch ms o 0 si hay error
obligatorio
Error error-post-service-token
Encabezados
Estado
400, 401, 500
obligatorio
Content-Type
application/json
obligatorio
Cuerpo
El cuerpo de respuesta puede proporcionar información de error adicional que se adhiera a la documentación de Códigos de error mejorados.
obligatorio
Muestras samples-post-service-token
1. Solicite un nuevo token de servicio (con ID de SSO)
Identificador del proveedor de servicios para el que se solicita el token.
obligatorio
Encabezados
Autorización
La generación de la carga útil del token de portador se describe en la documentación del encabezado Autorización.
obligatorio
AD-Service-Token
Un token de servicio obtenido anteriormente que debe actualizarse.
Este token debe ser válido o haber caducado recientemente para poder actualizarlo.
obligatorio
Aceptar
El tipo de medio aceptado por la aplicación cliente.
Si se especifica, debe ser application/json.
opcional
User-Agent
El agente de usuario de la aplicación cliente.
opcional
Respuesta get-service-token-response
Código
Texto
Descripción
200
OK
El token de servicio se actualizó correctamente y se devolvió en el cuerpo de respuesta.
400
Solicitud incorrecta
La solicitud no es válida, el cliente debe corregirla e intentarlo de nuevo. El cuerpo de respuesta puede contener información de error que se adhiera a la documentación de Códigos de error mejorados.
401
No autorizado
El token de acceso o el token de servicio no es válido. El cliente debe obtener un nuevo token de acceso o token de servicio e intentarlo de nuevo. Para obtener más información, consulte la Información general sobre el registro de clientes dinámicos.
500
Error interno del servidor
El lado del servidor ha encontrado un problema. El cuerpo de respuesta puede contener información de error que se adhiera a la documentación de Códigos de error mejorados.
Correcto success-get-service-token
Encabezados
Estado
200
obligatorio
Content-Type
application/json
obligatorio
Cuerpo
status
Estado HTTP (por ejemplo, "OK")
obligatorio
jws
Firma web JSON (JWS) codificada en Base64 que contiene el token de servicio actualizado. Este token se puede utilizar en llamadas de API posteriores para identificar el perfil autenticado y habilitar la funcionalidad de SSO.
obligatorio
notBefore
Epoch ms o 0 si hay error
obligatorio
notAfter
Epoch ms o 0 si hay error
obligatorio
Error error-get-service-token
Encabezados
Estado
400, 401, 500
obligatorio
Content-Type
application/json
obligatorio
Cuerpo
El cuerpo de respuesta puede proporcionar información de error adicional que se adhiera a la documentación de Códigos de error mejorados.
La API de vínculo se puede utilizar para solicitar un código de vínculo (o código QR) que pueda habilitar el inicio de sesión único (SSO) entre varias aplicaciones o dispositivos. Este código de vínculo permite a los usuarios conectar una nueva aplicación o dispositivo a un perfil autenticado existente (perfil SSO), lo que proporciona una experiencia SSO perfecta entre aplicaciones o dispositivos.
La API de vínculo requiere que se proporcione un token de servicio válido en el encabezado AD-Service-Token.
El código de vínculo generado generalmente se muestra a los usuarios de una aplicación o dispositivo principal y se introduce en una aplicación o dispositivo secundario para establecer la conexión SSO. El código de vínculo tiene un periodo de validez limitado (normalmente de 5 a 30 minutos) y está diseñado para utilizarse una sola vez.
En caso de que la solicitud de API de vínculo no se haya podido atender debido a un error de los servicios de autenticación de Adobe Pass, se incluirá información de error adicional como parte del resultado de la respuesta de la API de vínculo.
POST: vínculo post-link
Solicitud post-link-request
HTTP
ruta
/api/{serviceProvider}/link
método
PUBLICAR
Parámetros de ruta
serviceProvider
Identificador del proveedor de servicios para el que se solicita el token.
obligatorio
Encabezados
Autorización
La generación de la carga útil del token de portador se describe en la documentación del encabezado Autorización.
obligatorio
AP-Device-Identifier
La generación de la carga del identificador de dispositivo se describe en la documentación del encabezado AP-Device-Identifier.
obligatorio
AD-Service-Token
La generación del token de servicio se describe en la documentación de la API del token de servicio.
Este token de servicio identifica el perfil autenticado para el que se generará el código de vínculo.
obligatorio
Aceptar
El tipo de medio aceptado por la aplicación cliente.
Si se especifica, debe ser application/json.
opcional
User-Agent
El agente de usuario de la aplicación cliente.
opcional
Respuesta post-link-response
Código
Texto
Descripción
201
Creado
El código de vínculo se generó correctamente y se devolvió en el cuerpo de respuesta.
400
Solicitud incorrecta
La solicitud no es válida, el cliente debe corregirla e intentarlo de nuevo. El cuerpo de respuesta puede contener información de error que se adhiera a la documentación de Códigos de error mejorados.
El lado del servidor ha encontrado un problema. El cuerpo de respuesta puede contener información de error que se adhiera a la documentación de Códigos de error mejorados.
Correcto success-post-link
Encabezados
Estado
201
obligatorio
Content-Type
application/json
obligatorio
Cuerpo
status
Estado HTTP (por ejemplo, "CREATED")
obligatorio
vincular
Código numérico o alfanumérico corto que se puede utilizar en una aplicación o dispositivo secundario para establecer una conexión SSO.
obligatorio
notBefore
La marca de tiempo (en milisegundos desde la época) cuando el código de vínculo se vuelve válido.
obligatorio
notAfter
La marca de tiempo (en milisegundos desde la época) cuando caduca el código de vínculo.
obligatorio
Error error-post-link
Encabezados
Estado
400, 401, 500
obligatorio
Content-Type
application/json
obligatorio
Cuerpo
El cuerpo de respuesta puede proporcionar información de error adicional que se adhiera a la documentación de Códigos de error mejorados.
obligatorio
Muestras samples-post-link
1. Solicite un código de vínculo para un perfil autenticado existente
La API de desvinculación se puede utilizar para solicitar la eliminación de uno o varios dispositivos de un perfil autenticado (perfil SSO). Esta API permite a los usuarios desconectar dispositivos de su configuración de SSO, lo que permite controlar qué dispositivos tienen acceso a su perfil autenticado.
WARNING
La API de desvinculación requiere que se proporcione un token de servicio válido en el encabezado AD-Service-Token.
En caso de que la solicitud de API de desvinculación no se haya podido atender debido a un error de los servicios de autenticación de Adobe Pass, se incluirá información de error adicional como parte del resultado de la respuesta de API de desvinculación.
POST: desvincular post-unlink
Solicitud post-unlink-request
HTTP
ruta
/api/{serviceProvider}/unlink
método
PUBLICAR
Parámetros de ruta
serviceProvider
El identificador del proveedor de servicios.
obligatorio
Parámetros de cuerpo
dispositivos
Matriz de identificadores de dispositivo para desvincular.
Ejemplo: ["deviceid1", "deviceid2", "deviceid3"]
obligatorio
Encabezados
Autorización
La generación de la carga útil del token de portador se describe en la documentación del encabezado Autorización.
obligatorio
Content-Type
El tipo de medio aceptado para los recursos que se envían.
Debe ser application/json.
obligatorio
AP-Device-Identifier
La generación de la carga del identificador de dispositivo se describe en la documentación del encabezado AP-Device-Identifier.
obligatorio
AD-Service-Token
La generación del token de servicio se describe en la documentación de la API del token de servicio.
Este token de servicio identifica el perfil autenticado para el que se desvincularán los dispositivos.
obligatorio
Aceptar
El tipo de medio aceptado por la aplicación cliente.
Si se especifica, debe ser application/json.
opcional
User-Agent
El agente de usuario de la aplicación cliente.
opcional
Respuesta post-unlink-response
Código
Texto
Descripción
200
OK
Los dispositivos solicitados se han desvinculado correctamente de la configuración de SSO.
400
Solicitud incorrecta
La solicitud no es válida, el cliente debe corregirla e intentarlo de nuevo. El cuerpo de respuesta puede contener información de error que se adhiera a la documentación de Códigos de error mejorados.
El método HTTP no es válido, el cliente debe utilizar un método HTTP permitido para el recurso solicitado e intentarlo de nuevo.
500
Error interno del servidor
El lado del servidor ha encontrado un problema. El cuerpo de respuesta puede contener información de error que se adhiera a la documentación de Códigos de error mejorados.
Correcto success-post-unlink
Encabezados
Estado
200
obligatorio
Content-Type
application/json
obligatorio
Cuerpo
status
Información sobre el resultado de la operación: "OK"
obligatorio
unlinkedDevices
Lista de dispositivos desvinculados correctamente.
Ejemplo: ["deviceid1", "deviceid2", "deviceid3"]
obligatorio
Error error-post-unlink
Encabezados
Estado
400, 401, 405, 500
obligatorio
Content-Type
application/json
obligatorio
Cuerpo
El cuerpo de respuesta puede proporcionar información de error adicional que se adhiera a la documentación de Códigos de error mejorados.
obligatorio
Muestras samples-post-unlink
1. Solicite desvincular dispositivos de un perfil SSO
La API de lista se puede utilizar para obtener una lista de dispositivos conectados actualmente a un perfil autenticado (perfil SSO). Esta API permite a los usuarios y las aplicaciones ver qué dispositivos forman parte de su configuración de SSO, lo que proporciona visibilidad y capacidades de administración para su experiencia autenticada en varios dispositivos.
WARNING
La API de lista requiere que se proporcione un token de servicio válido en el encabezado AD-Service-Token.
La API de lista devuelve detalles sobre cada dispositivo en el perfil autenticado (perfil SSO), incluidos los identificadores de dispositivo y los metadatos que pueden ayudar a los usuarios a reconocer sus dispositivos. Esta información se puede utilizar para ayudar a los usuarios a tomar decisiones informadas sobre qué dispositivos deben permanecer en su configuración de SSO.
En caso de que la solicitud de API de lista no se haya podido atender debido a un error de los servicios de autenticación de Adobe Pass, se incluirá información de error adicional como parte del resultado de la respuesta de API de lista.
GET: lista get-list
Solicitud get-list-request
HTTP
ruta
/api/{serviceProvider}/list
método
GET
Parámetros de ruta
serviceProvider
El identificador del proveedor de servicios.
obligatorio
Encabezados
Autorización
La generación de la carga útil del token de portador se describe en la documentación del encabezado Autorización.
obligatorio
AP-Device-Identifier
La generación de la carga del identificador de dispositivo se describe en la documentación del encabezado AP-Device-Identifier.
obligatorio
AD-Service-Token
La generación del token de servicio se describe en la documentación de la API del token de servicio.
Este token de servicio identifica el perfil autenticado para el que se recuperará la lista de dispositivos.
obligatorio
Aceptar
El tipo de medio aceptado por la aplicación cliente.
Si se especifica, debe ser application/json.
opcional
User-Agent
El agente de usuario de la aplicación cliente.
opcional
Respuesta get-list-response
Código
Texto
Descripción
200
OK
La lista de dispositivos en la configuración de SSO se recuperó correctamente y se devolvió en el cuerpo de la respuesta.
400
Solicitud incorrecta
La solicitud no es válida, el cliente debe corregirla e intentarlo de nuevo. El cuerpo de respuesta puede contener información de error que se adhiera a la documentación de Códigos de error mejorados.
El método HTTP no es válido, el cliente debe utilizar un método HTTP permitido para el recurso solicitado e intentarlo de nuevo.
500
Error interno del servidor
El lado del servidor ha encontrado un problema. El cuerpo de respuesta puede contener información de error que se adhiera a la documentación de Códigos de error mejorados.
Correcto success-get-list
Encabezados
Estado
200
obligatorio
Content-Type
application/json
obligatorio
Cuerpo
dispositivos
JSON que contiene un mapa de pares de clave y valor.
Clave: deviceId: la carga del identificador del dispositivo tal como se describe en la documentación del encabezado AP-Device-Identifier
Valor: atributos - JSON que contiene un mapa de atributos de metadatos de dispositivo, incluidos:
tipo de dispositivo
plataforma
agente de usuario
otros metadatos relevantes que ayuden a identificar el dispositivo
Los valores de los atributos pueden ser simples (cadena, entero, booleano, etc.)
obligatorio
Error error-get-list
Encabezados
Estado
400, 401, 405, 500
obligatorio
Content-Type
application/json
obligatorio
Cuerpo
El cuerpo de respuesta puede proporcionar información de error adicional que se adhiera a la documentación de Códigos de error mejorados.
obligatorio
Muestras samples-get-list
1. Solicitud para enumerar dispositivos en un perfil SSO