DocumentaçãoAdobe PassAdobe Pass Authentication

Recuperar configuração para provedor de serviços específico retrieve-configuration-for-specific-service-provider

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}/configuration
método
GET
Parâmetros de caminho
serviceProvider
O identificador exclusivo interno associado ao provedor de serviços durante o processo de integração.
obrigatório
Parâmetros de consulta
perfil
-
opcional
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
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).
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 uma lista de MVPDs com uma integração ativa com o "serviceProvider".
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
Tipo de conteúdo
application/json
obrigatório
Corpo

JSON contendo uma lista de elementos, cada elemento 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 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 layout-auto html-authored
Atributo
dispositivo Tipo de dispositivo obrigatório
clientType Tipo de cliente
errorReporting Objeto
solicitante

Objeto JSON com os seguintes atributos:

  • id
  • name
  • domínios
 obrigatório
mvpds

Objeto JSON com os seguintes atributos:

  • id
  • displayName
  • logoUrl
  • isTempPass
  • isProxy
  • boardingStatus
  • platformMappingId
  • enablePlatformServices
  • displayInPlatformPicker
  • forcePlatformPermissions
 obrigatório
hora 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. Recuperar a configuração para um provedor de serviços específico

Solicitação
code language-https 
GET /api/v2/REF30/configuration/ HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)
Resposta
code language-https 
HTTP/1.1 200 OK

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

{
    "device": "unknown",
    "clientType": "html5",
    "os": "Unknown",
    "requestor": {
        "id": "REF30",
        "name": "Reference site only in 30",
        "domains": [
            {
                "name": "adobe.com",
                "mvpdInitiated": false
            },
            {
                "name": "adobe.io",
                "mvpdInitiated": false
            },
            {
                "name": "adobepass.com",
                "mvpdInitiated": false
            },
            {
                "name": "adobeptime.com",
                "mvpdInitiated": false
            },
            {
                "name": "anvilcreative.com",
                "mvpdInitiated": false
            },
            {
                "name": "testadobe.com",
                "mvpdInitiated": false
            }
        ],
        "mvpds": [
            {
                "id": "AdobePass_SMI",
                "displayName": "Adobe Pass SMI",
                "logoUrl": "https://blogs.adobe.com/conversations/files/2010/08/adobe-logo.jpg",
                "authPerAggregator": false
            },
            {
                "id": "TempPass_TEST40",
                "displayName": "Adobe Temp Pass Test 3 min",
                "logoUrl": "https://entitlement.auth.adobe.com/entitlement/noLogo.png",
                "authPerAggregator": true,
                "isTempPass": true
            },
            {
                "id": "TempPass_TEST44",
                "displayName": "Adobe Temp Pass Test 30 min",
                "logoUrl": "https://entitlement.auth.adobe.com/entitlement/noLogo.png",
                "authPerAggregator": true,
                "isTempPass": true
            },
            {
                "id": "AdobeShibboleth",
                "displayName": "AdobeShibboleth",
                "logoUrl": "https://entitlement.auth.adobe.com/entitlement/adobe.png"
            },
            {
                "id": "ATTOTT",
                "displayName": "DIRECTV STREAM",
                "logoUrl": "https://entitlement.auth.adobe.com/entitlement/directvstream.jpg"
            },
            {
                "id": "ElasticSSO",
                "displayName": "ElasticSSO",
                "logoUrl": "https://entitlement.auth.adobe.com/entitlement/noLogo.png",
                "authPerAggregator": false
            },
            {
                "id": "TempPass",
                "displayName": "Temp-Pass",
                "logoUrl": "https://entitlement.auth.adobe.com/entitlement/noLogo.png",
                "passiveAuthnEnabled": false,
                "authPerAggregator": true,
                "isTempPass": true
            },
            {
                "id": "Comcast_SSO_Perf",
                "displayName": "Xfinity Perf",
                "logoUrl": "https://login.comcast.net/static/images/ci/tve/mvpd_comcast_logo112x33.gif",
                "authPerAggregator": true,
                "authPerBrowserSession": true
            }
        ]
    }
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b