Hämta konfiguration för en viss tjänsteleverantör retrieve-configuration-for-specific-service-provider

IMPORTANT
Innehållet på den här sidan tillhandahålls endast i informationssyfte. Användning av denna API kräver en aktuell licens från Adobe. Ingen obehörig användning är tillåten.
IMPORTANT
REST API V2-implementeringen begränsas av dokumentationen för begränsningsmekanismen.

Begäran request

HTTP
bana
/api/v2/{serviceProvider}/konfiguration
method
GET
Sökvägsparametrar
serviceProvider
Den interna unika identifierare som är associerad med tjänsteleverantören under introduktionsprocessen.
obligatoriskt
Frågeparametrar
profil
-
valfri
Sidhuvuden
Behörighet
Genereringen av mottagarens tokennyttolast beskrivs i rubrikdokumentationen för autentisering.
obligatoriskt
AP-Device-Identifier
Genereringen av nyttolasten för enhetsidentifieraren beskrivs i rubrikdokumentationen för AP-Device-Identifier.
valfri
X-Device-Info
Genereringen av nyttolasten för enhetsinformation beskrivs i rubrikdokumentationen för X-Device-Info.

Vi rekommenderar att du alltid använder den när programmets enhetsplattform tillåter explicit tillhandahållande av giltiga värden.

När detta anges sammanfogas Adobe Pass Authentication-backend explicit med extraherade värden implicit (som standard).

Om det inte anges kommer Adobe Pass Authentication-serverdelen att använda extraherade värden implicit (som standard).
valfri
X-Forwarded-For
Direktuppspelningsenhetens IP-adress.

Vi rekommenderar starkt att du alltid använder det för server-till-server-implementeringar, särskilt när anropet görs av programmeringstjänsten i stället för av direktuppspelningsenheten.

För implementeringar från klient till server skickas direktuppspelningsenhetens IP-adress implicit.
valfri
Acceptera
Medietypen som accepteras av klientprogrammet.

Om det anges måste det vara application/json.
valfri
Användaragent
Användaragenten för klientprogrammet.
valfri

Svar response

Code
Text
Beskrivning
200
OK
Svarstexten innehåller en lista med MVPD-filer som har en aktiv integrering med serviceProvider.
400
Felaktig begäran
Begäran är ogiltig. Klienten måste åtgärda begäran och försöka igen. Svarstexten kan innehålla felinformation som följer dokumentationen för Förbättrade felkoder.
401
Obehörig
Åtkomsttoken är ogiltig. Klienten måste hämta en ny åtkomsttoken och försöka igen. Mer information finns i dokumentationen Översikt över registrering av dynamisk klient.
405
Metoden tillåts inte
HTTP-metoden är ogiltig. Klienten måste använda en HTTP-metod som är tillåten för den begärda resursen och försök igen. Mer information finns i avsnittet Begäran.
500
Internt serverfel
Ett fel uppstod på serversidan. Svarstexten kan innehålla felinformation som följer dokumentationen för Förbättrade felkoder.

Lyckades success

Sidhuvuden
Status
200
obligatoriskt
Content-Type
application/json
obligatoriskt
Brödtext

JSON innehåller en lista med element, där varje element har följande attribut:

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
Attribut
enhet Enhetstyp obligatoriskt
clientType Klienttyp
errorReporting Objekt
begärande

JSON-objekt med följande attribut:

  • id
    Den interna unika identifierare som är associerad med tjänstprovidern under introduktionsprocessen.
  • name
    Det företagsnamn (varumärke) som är associerat med tjänsteleverantören under introduktionsprocessen.
  • domäner
    Listan över domännamn som visas för Adobe Pass-autentisering som representerar tjänstprovidern.
obligatoriskt
mvpds

JSON-objekt med följande attribut:

  • id
    Den interna unika identifierare som är associerad med identitetsleverantören under introduktionsprocessen.
  • displayName
    Det företagsnamn (varumärke) som är associerat med identitetsleverantören under introduktionsprocessen.
  • logoUrl
    URL:en som logotypen som är kopplad till identitetsleverantören ska hämtas från.
  • isTempPass
    Den flagga som anger om MVPD är utformat för att tillhandahålla TempPass-funktionalitet.
  • isProxy
    Den flagga som anger om MVPD är en proxiderad MVPD.
  • boardingStatus
    Statusen som anger om identitetsprovidern har anslutits av den strömmande enhetsplattformen för enkla inloggningsflöden.
  • platformMappingId
    Den interna unika identifierare som är associerad med identitetsleverantören av den strömmande enhetsplattformen för enkla inloggningsflöden.
  • enablePlatformServices
    Den flagga som anger om identitetsproviderkonfigurationen är aktiverad för den direktuppspelade enhetsplattformen för enkla inloggningsflöden.
  • displayInPlatformPicker
    Den flagga som anger om identitetsleverantören kan visas i väljaren för direktuppspelningsplattform för enkla inloggningsflöden.
  • enforcementPlatformPermissions
    Den flagga som anger om direktuppspelningsenheten måste tillämpa användarbehörigheterna som tillhandahålls av plattformen för enkla inloggningsflöden.
obligatoriskt
tid obligatoriskt
obligatoriskt

Fel error

Sidhuvuden
Status
400, 401, 405, 500
obligatoriskt
Content-Type
application/json
obligatoriskt
Brödtext
Svarstexten kan innehålla ytterligare felinformation som följer dokumentationen för Förbättrade felkoder.
obligatoriskt

Exempel samples

​1. Hämta konfiguration för en viss tjänsteleverantör

Begäran
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)
Svar
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