Criar e recuperar perfil usando a resposta de autenticação do parceiro
Última atualização: 7 de março de 2025
- Tópicos:
- Authentication
IMPORTANTO conteúdo desta página é fornecido apenas para fins informativos. O uso desta API requer uma licença atual da Adobe. Não é permitida nenhuma utilização não autorizada.
IMPORTANTA implementação da REST API V2 é limitada pela documentação do Mecanismo de limitação.
Solicitação
HTTP
caminho
/api/v2/{serviceProvider}/profiles/sso/{partner}
método
POST
Parâmetros de caminho
serviceProvider
O identificador exclusivo interno associado ao provedor de serviços durante o processo de integração.
obrigatório
parceiro
O nome do parceiro (por exemplo, Apple) que fornece a estrutura de logon único integrada aos fluxos de autenticação da Adobe Pass.
obrigatório
Parâmetros de corpo
SAMLResponse
A resposta de autenticação de parceiro que contém os metadados de usuário necessários para criar e salvar um perfil de parceiro.
O valor deve ser codificado em Base64 e depois codificado em URL.
O valor deve ser codificado em Base64 e depois codificado em URL.
obrigatório
Cabeçalhos
Autorização
A geração da carga do token do portador está descrita na documentação do cabeçalho Autorização.
obrigatório
Tipo de conteúdo
O tipo de mídia aceito para os recursos que estão sendo enviados.
Deve ser application/x-www-form-urlencoded.
Deve ser application/x-www-form-urlencoded.
obrigatório
Identificador de dispositivo AP
A geração da carga do identificador de dispositivo está descrita na documentação do cabeçalho AP-Device-Identifier.
obrigatório
X-Device-Info
A geração da carga de informações do dispositivo está descrita na documentação do cabeçalho X-Device-Info.
É altamente recomendável sempre usá-lo quando a plataforma do dispositivo do aplicativo permitir a provisão explícita de valores válidos.
Quando fornecido, o back-end da Autenticação do Adobe Pass mesclará explicitamente valores definidos com valores extraídos implicitamente (por padrão).
Quando não for fornecido, o back-end da Autenticação do Adobe Pass usará os valores extraídos implicitamente (por padrão).
É altamente recomendável sempre usá-lo quando a plataforma do dispositivo do aplicativo permitir a provisão explícita de valores válidos.
Quando fornecido, o back-end da Autenticação do Adobe Pass mesclará explicitamente valores definidos com valores extraídos implicitamente (por padrão).
Quando não for fornecido, o back-end da Autenticação do Adobe Pass usará os valores extraídos implicitamente (por padrão).
obrigatório
AP-Partner-Framework-Status
A geração da carga de logon único para o método Partner está descrita na documentação do cabeçalho AP-Partner-Framework-Status.
Para obter mais detalhes sobre os fluxos habilitados para logon único usando um parceiro, consulte a documentação do Logon único usando fluxos do parceiro.
Para obter mais detalhes sobre os fluxos habilitados para logon único usando um parceiro, consulte a documentação do Logon único usando fluxos do parceiro.
opcional
X-Encaminhado-Para
O endereço IP do dispositivo de streaming.
É altamente recomendável sempre usá-lo para implementações de servidor para servidor, especialmente quando a chamada é feita pelo serviço do programador, em vez do dispositivo de transmissão.
Para implementações de cliente para servidor, o endereço IP do dispositivo de transmissão é enviado implicitamente.
É altamente recomendável sempre usá-lo para implementações de servidor para servidor, especialmente quando a chamada é feita pelo serviço do programador, em vez do dispositivo de transmissão.
Para implementações de cliente para servidor, o endereço IP do dispositivo de transmissão é enviado implicitamente.
opcional
Aceitar
O tipo de mídia aceito pelo aplicativo cliente.
Se especificado, deve ser application/json.
Se especificado, deve ser application/json.
opcional
User-Agent
O agente do usuário do aplicativo cliente.
opcional
Resposta
Código
Texto
Descrição
201
Criado em
O corpo da resposta contém um mapa de perfis válidos, que pode estar vazio.
400
Solicitação inválida
A solicitação é inválida, o cliente precisa corrigir a solicitação e tentar novamente. O corpo da resposta pode conter informações de erro que seguem a documentação de Códigos de erro aprimorados.
401
Não autorizado
O token de acesso é inválido, o cliente precisa obter um novo token de acesso e tentar novamente. Para obter mais detalhes, consulte a documentação Visão geral do registro dinâmico do cliente.
405
Método não permitido
O método HTTP é inválido, o cliente precisa usar um método HTTP permitido para o recurso solicitado e tentar novamente. Para obter mais detalhes, consulte a seção Solicitação.
500
Erro interno do servidor
O servidor encontrou um problema. O corpo da resposta pode conter informações de erro que seguem a documentação de Códigos de erro aprimorados.
Sucesso
Cabeçalhos
Status
201
obrigatório
Tipo de conteúdo
application/json
obrigatório
Corpo
perfis
JSON que contém um mapa de pares de chaves e valores.
O elemento principal é definido pelo seguinte valor:
Valor
mvpd
O identificador exclusivo interno associado ao Provedor de identidade durante o processo de integração.
obrigatório
O elemento value é definido pelos seguintes atributos:
Atributo
notBefore
O carimbo de data/hora antes do qual o perfil não é válido.
obrigatório
notAfter
O carimbo de data/hora após o qual o perfil não é válido.
obrigatório
emissor
A entidade proprietária do perfil.
Os valores possíveis são:
- Apple
O perfil foi criado como resultado de: logon único usando Apple parceiro.
obrigatório
type
O tipo do perfil.
Os valores possíveis são:
- appleSSO
O perfil foi criado como resultado de: logon único usando o Apple parceiro.
obrigatório
atributos
A lista de atributos de metadados do usuário.
Esses atributos podem ser:
- Obrigatório, como "userID"
- Não obrigatório, como "zip", "householdID", "maxRating" etc.
Os valores dos atributos podem ser:
- simples
- lista
- mapa
obrigatório
obrigatório
Erro
Cabeçalhos
Status
400, 401, 405, 500
obrigatório
Tipo de conteúdo
application/json
obrigatório
Corpo
O corpo da resposta pode fornecer informações adicionais de erro que seguem a documentação de Códigos de erro aprimorados.
obrigatório
Amostras
1. Criar e recuperar perfil usando a resposta de autenticação do parceiro
Solicitação
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...
Resposta
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. Criar e recuperar perfis usando a resposta de autenticação do parceiro, mas a degradação é aplicada
Solicitação
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...
Resposta
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