DocumentaciónAdobe PassAdobe Pass Authentication

Crear y recuperar perfiles mediante una respuesta de autenticación de socio create-and-retrieve-profile-using-partner-authentication-response

Last update: Fri Mar 07 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
IMPORTANT
El contenido de esta página se proporciona únicamente con fines informativos. El uso de esta API requiere una licencia actual de Adobe. No se permite el uso no autorizado.
IMPORTANT
La implementación de la API REST V2 está limitada por la documentación de Mecanismo de limitación.

Solicitud request

HTTP
ruta
/api/v2/{serviceProvider}/profiles/sso/{partner}
método
PUBLICAR
Parámetros de ruta
serviceProvider
El identificador único interno asociado con el proveedor de servicios durante el proceso de incorporación.
obligatorio
socio
El nombre del socio (por ejemplo, Apple) que proporciona el marco de inicio de sesión único integrado con los flujos de autenticación de Adobe Pass.
obligatorio
Parámetros de cuerpo
SAMLResponse
La respuesta de autenticación del socio que contiene los metadatos de usuario necesarios para crear y guardar un perfil de socio.

El valor debe estar codificado en Base64 y codificado en URL posteriormente.
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/x-www-form-urlencoded.
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
X-Device-Info
La generación de la carga de información del dispositivo se describe en la documentación del encabezado X-Device-Info.

Se recomienda utilizarlo siempre que la plataforma de dispositivos de la aplicación permita la provisión explícita de valores válidos.

Cuando se proporciona, el backend de autenticación de Adobe Pass combina explícitamente los valores establecidos con los valores extraídos implícitamente (de forma predeterminada).

Cuando no se proporciona, el backend de autenticación de Adobe Pass utilizará valores extraídos implícitamente (de forma predeterminada).
obligatorio
AP-Partner-Framework-Status
La generación de la carga de inicio de sesión único para el método Partner se describe en la documentación del encabezado AP-Partner-Framework-Status.

Para obtener más información sobre los flujos habilitados para el inicio de sesión único que usan un socio, consulte la documentación de Inicio de sesión único con flujos de socios.
opcional
X-Forwarded-For
La dirección IP del dispositivo de flujo continuo.

Se recomienda utilizarlo siempre para implementaciones de servidor a servidor, especialmente cuando la llamada la realice el servicio del programador en lugar del dispositivo de flujo continuo.

Para implementaciones de cliente a servidor, la dirección IP del dispositivo de flujo continuo se envía implícitamente.
opcional
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 response

Código
Texto
Descripción
201
Creado
El cuerpo de la respuesta contiene un mapa de perfiles válidos, que pueden estar vacíos.
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 no es válido, el cliente debe obtener un nuevo token de acceso e intentarlo de nuevo. Para obtener más información, consulte la Información general sobre el registro de clientes dinámicos.
405
Método no permitido
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. Para obtener más información, consulte la sección Solicitud.
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

Encabezados
Estado
201
obligatorio
Content-Type
application/json
obligatorio
Cuerpo
perfiles

JSON que contiene un mapa de pares de clave y valor.

El elemento clave se define con el siguiente valor:

table 0-row-3 1-row-3 1-bgcolor-eff2f7 2-bgcolor-eff2f7 3-bgcolor-eff2f7 5-bgcolor-deebff layout-auto html-authored
Valor
mvpd El identificador único interno asociado con el proveedor de identidad durante el proceso de incorporación. obligatorio

El elemento value se define mediante los atributos siguientes:

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 1-bgcolor-eff2f7 2-bgcolor-eff2f7 3-bgcolor-eff2f7 5-bgcolor-deebff 9-bgcolor-deebff 13-bgcolor-deebff 17-bgcolor-deebff 21-bgcolor-deebff layout-auto html-authored
Atributo
notBefore La marca de tiempo antes de la cual el perfil no es válido. obligatorio
notAfter La marca de tiempo después de la cual el perfil no es válido. obligatorio
emisor

La entidad propietaria del perfil.

Los valores posibles son:

  • Apple
    El perfil se creó como resultado de: inicio de sesión único con Apple de socio.
 obligatorio
type

El tipo de perfil.

Los valores posibles son:

  • appleSSO
    El perfil se creó como resultado de: inicio de sesión único con Apple de socio.
 obligatorio
atributos

La lista de atributos de metadatos de usuario.

Estos atributos pueden ser:

  • Obligatorio, como "userID"
  • No obligatorio, como "zip", "householdID", "maxRating", etc.

Los valores de los atributos pueden ser:

  • simple
  • lista
  • asignar
 obligatorio
obligatorio

Error error

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

1. Crear y recuperar perfiles mediante la respuesta de autenticación del socio

Solicitud
code language-https 
POST /api/v2/REF30/profiles/sso/Apple HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/x-www-form-urlencoded
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    AP-Partner-Framework-Status: ewogICAgImZyYW1ld29ya1Blcm1pc3Npb25JbmZvIjogewogICAgICAiYWNjZXNzU3RhdHVzIjogImdyYW50ZWQiCiAgICB9LAogICAgImZyYW1ld29ya1Byb3ZpZGVySW5mbyIgOiB7CiAgICAgICJpZCIgOiAiQ2FibGV2aXNpb24iLAogICAgICAiZXhwaXJhdGlvbkRhdGUiIDogIjIwMjU0MzA2MzYwMDAiCiAgICB9Cn0=
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

SAMLResponse=PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIH...
Respuesta
code language-https 
HTTP/1.1 201 Created

Content-Type: application/json;charset=UTF-8

{
    "profiles": {
        "Cablevision": {
            "notBefore": 1623943955,
            "notAfter": 1623951155,
            "issuer": "Apple",
            "type": "appleSSO",
            "attributes": {
                "userID": {
                    "value": "BASE64_value_userId",
                    "state": "plain"
                },
                "householdID": {
                    "value": "BASE64_value_householdId",
                    "state": "plain"
                },
                "zip": {
                    "value": "BASE64_value_zip",
                    "state": "enc"
                }
            }
        }
     }
}

2. Crear y recuperar perfiles mediante la respuesta de autenticación de socio, pero se aplica la degradación

Solicitud
code language-https 
POST /api/v2/REF30/profiles/sso/Apple HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/x-www-form-urlencoded
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    AP-Partner-Framework-Status: ewogICAgImZyYW1ld29ya1Blcm1pc3Npb25JbmZvIjogewogICAgICAiYWNjZXNzU3RhdHVzIjogImdyYW50ZWQiCiAgICB9LAogICAgImZyYW1ld29ya1Byb3ZpZGVySW5mbyIgOiB7CiAgICAgICJpZCIgOiAiJHtkZWdyYWRlZE12cGR9IiwKICAgICAgImV4cGlyYXRpb25EYXRlIiA6ICIyMDI1NDMwNjM2MDAwIgogICAgfQp9
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

SAMLResponse=PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIH...
Respuesta
code language-https 
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "profiles": {
        "${degradedMvpd}": {
            "notBefore": 1706636062704,
            "notAfter": 1706696062704,
            "issuer": "Adobe",
            "type": "degraded",
            "attributes": {
                "userID": {
                    "value": "95cf93bcd183214ac9e4433153cb8a9d180a463128c0a5d26f202e8c",
                    "state": "plain"
                }
            }
        }
   }
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b