DocumentaçãoAdobe PassAdobe Pass Authentication

Retomar sessão de autenticação resume-authentication-session

Last update: Tue Oct 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
IMPORTANT
O conteúdo desta página é fornecido apenas para fins informativos. O uso desta API requer uma licença atual do Adobe. Não é permitida nenhuma utilização não autorizada.
IMPORTANT
A implementação da REST API V2 é limitada pela documentação do Mecanismo de limitação.

Solicitação request

HTTP
caminho
/api/v2/{serviceProvider}/sessions/{code}
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
código
O código de autenticação obtido após a criação da sessão de autenticação no dispositivo de streaming.
obrigatório
Parâmetros de corpo
mvpd
O identificador exclusivo interno associado ao Provedor de identidade durante o processo de integração.

Se a plataforma do dispositivo de transmissão tiver limitações no fornecimento de um valor, um aplicativo terá que retomar a sessão de autenticação e fornecer um valor válido.
obrigatório
domainName
O domínio de origem do aplicativo que executa o logon MVPD.

Se a plataforma do dispositivo de transmissão tiver limitações no fornecimento de um valor, um aplicativo terá que retomar a sessão de autenticação e fornecer um valor válido.
obrigatório
redirectUrl
O URL final de redirecionamento para o qual o agente do usuário navega quando o fluxo de autenticação do MVPD é concluído.

O valor deve ser codificado em URL.

Se a plataforma do dispositivo de transmissão tiver limitações no fornecimento de um valor, um aplicativo terá que retomar a sessão de autenticação e fornecer um valor válido.
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.
obrigatório
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.
opcional
Aceitar
O tipo de mídia aceito pelo aplicativo cliente.

Se especificado, deve ser application/json.
opcional
User-Agent
O agente do usuário do aplicativo cliente.
opcional

Resposta response

Código
Texto
Descrição
200
OK
O corpo da resposta contém informações sobre as próximas ações necessárias para executar a autenticação.
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 success

Cabeçalhos
Status
200
obrigatório
Corpo

Objeto JSON com os seguintes atributos:

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-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 25-bgcolor-deebff 29-bgcolor-deebff 33-bgcolor-deebff layout-auto html-authored
Atributo
actionName

A ação que o dispositivo de streaming precisa executar para concluir o fluxo de autenticação.

Os valores possíveis são:

  • autenticar
    O dispositivo de streaming ou outro dispositivo precisa abrir a URL fornecida em um agente de usuário.
  • repetir
    O dispositivo de streaming ou outro dispositivo precisa fornecer os parâmetros ausentes e tentar retomar a sessão de autenticação usando o código.
  • autorizar
    O dispositivo de streaming pode continuar diretamente com fluxos de decisões.
 obrigatório
actionType

O tipo de interação que o dispositivo de streaming deve executar para continuar o fluxo com a ação especificada pelo atributo "actionName".

Os valores possíveis são:

  • interativo
    O fluxo continua com uma navegação até a URL fornecida usando um agente de usuário.
  • direct
    O fluxo continua com uma chamada direta para a URL fornecida usando um cliente HTTP disponível para a implementação do cliente.
 obrigatório
missingParameters Os parâmetros ausentes que precisam ser fornecidos para concluir o fluxo de autenticação básico. opcional
url O URL no qual o aplicativo cliente precisa navegar. opcional
código O código de autenticação que pode ser usado em um aplicativo secundário para retomar a sessão de autenticação. obrigatório
sessionId O identificador opaco que pode ser usado para rastrear a atividade do usuário. obrigatório
mvpd O identificador exclusivo interno associado ao Provedor de identidade durante o processo de integração. opcional
serviceProvider O identificador exclusivo interno associado ao provedor de serviços durante o processo de integração. obrigatório
obrigatório

Erro error

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 samples

1. Retomar sessão de autenticação sem parâmetros ausentes

Solicitação
code language-https 
POST /api/v2/REF30/sessions/8BLW4RW 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
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=Cablevision&domainName=adobe.com&redirectUrl=https%3A%2F%2Fadobe.com
Resposta
code language-https 
HTTP/1.1 200 OK

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

{
    "actionName": "authenticate",
    "actionType": "interactive",
    "url": "/api/v2/authenticate/REF30/8ER640M",
    "code": "8ER640M",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "Cablevision",
    "serviceProvider": "REF30"
}

2. Retomar sessão de autenticação com parâmetros ausentes

Solicitação
code language-https 
POST /api/v2/REF30/sessions/8BLW4RW 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
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=Cablevision&domainName=adobe.com
Resposta
code language-https 
HTTP/1.1 200 OK

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

{
    "actionName": "retry",
    "actionType": "direct",
    "url": "/api/v2/REF30/sessions/8BLW4RW",
    "missingParameters": ["redirectUrl"]
    "code": "8BLW4RW",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "Cablevision",
    "serviceProvider": "REF30"
}

3. Retomar sessão de autenticação enquanto já existir um perfil válido

Solicitação
code language-https 
POST /api/v2/REF30/sessions/8BLW4RW 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
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=TempPass_TEST40&domainName=adobe.com&redirectUrl=https%3A%2F%2Fadobe.com
Resposta
code language-https 
HTTP/1.1 200 OK

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

{
    "actionName": "authorize",
    "actionType": "direct",
    "url": "/api/v2/REF30/decisions/authorize/TempPass_TEST40",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "TempPass_TEST40",
    "serviceProvider": "REF30"
}

5. Retomar a sessão de autenticação enquanto a degradação é aplicada

Solicitação
code language-https 
POST /api/v2/REF30/sessions/8BLW4RW 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
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=Cablevision&domainName=adobe.com&redirectUrl=https%3A%2F%2Fadobe.com
Resposta
code language-https 
HTTP/1.1 200 OK

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

{
    "actionName": "authorize",
    "actionType": "direct",
    "url": "/api/v2/REF30/decisions/authorize/Cablevision",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "Cablevision",
    "serviceProvider": "REF30"
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b