DokumentationAdobe PassAdobe Pass-autentisering

Hämta profiler retrieve-profiles

Last update: Thu Aug 21 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
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.
Related Articles
Gå även till REST API V2 FAQ.

Begäran request

HTTP
bana
/api/v2/{serviceProvider}/profiler
method
GET
Sökvägsparametrar
serviceProvider
Den interna unika identifierare som är associerad med tjänsteleverantören under introduktionsprocessen.
obligatoriskt
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.
obligatoriskt
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).
obligatoriskt
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
Adobe-Subject-Token
eller
X-Roku-Reserved-Roku-Connect-Token
Genereringen av nyttolasten för enkel inloggning för metoden Platform Identity beskrivs i rubrikdokumentationen för Adobe-Subject-Token / X-Roku-Reserved-Roku-Connect-Token.

Mer information om enkla inloggningsaktiverade flöden med en plattformsidentitet finns i dokumentationen för enkel inloggning med plattformsidentitetsflöden.
valfri
AD-Service-token
Genereringen av nyttolasten för enkel inloggning för Service Token-metoden beskrivs i rubrikdokumentationen för AD-Service-Token.

Mer information om enkla inloggningsaktiverade flöden med en tjänsttoken finns i dokumentationen för enkel inloggning med tjänsttoken flows.
valfri
AP-Partner-Framework-status
Genereringen av nyttolasten för enkel inloggning för partnermetoden beskrivs i rubrikdokumentationen för AP-Partner-Framework-Status .

Mer information om aktiverade flöden för enkel inloggning med en partner finns i dokumentationen för enkel inloggning med partnerflöden.
valfri
AP-Visitor-Identifier
Genereringen av nyttolasten för besökaridentifieraren beskrivs i rubrikdokumentationen för AP-Visitor-Identifier.
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 karta över giltiga profiler, som kan vara tom.
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
profiler

JSON innehåller en karta över nyckel- och värdepar.

Nyckelelementet definieras med följande värde:

table 0-row-3 1-row-3 1-bgcolor-eff2f7 2-bgcolor-eff2f7 3-bgcolor-eff2f7 5-bgcolor-deebff layout-auto html-authored
Värde
mvpd Den interna unika identifierare som är associerad med identitetsleverantören under introduktionsprocessen. obligatoriskt

Elementet value definieras av följande attribut:

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
Attribut
notBefore Tidsstämpeln i millisekunder innan profilen är ogiltig. obligatoriskt
notAfter Tidsstämpeln i millisekunder efter vilken profilen är ogiltig. obligatoriskt
utfärdare

Den enhet som äger profilen.

Möjliga värden är:

  • mvpd (t.ex. spektrum, Cablevision)
    Profilen skapades som ett resultat av: grundläggande autentisering, enkel inloggning med plattformsidentitet eller enkel inloggning med tjänsttoken.
  • Apple
    Profilen skapades som ett resultat av: enkel inloggning med partner-Apple.
 obligatoriskt
type

Profilens typ.

Möjliga värden är:

  • normal
    Profilen skapades som ett resultat av: grundläggande autentisering.
  • appleSSO
    Profilen skapades som ett resultat av: enkel inloggning med partner-Apple.
  • platformSSO
    Profilen skapades som ett resultat av: enkel inloggning med plattformsidentitet.
  • serviceTokenSSO
    Profilen skapades som ett resultat av: enkel inloggning med tjänsttoken.
 obligatoriskt
attributes

JSON innehåller en karta över nyckel- och värdepar.

Nyckelelementet definieras av användarens metadataattribut och kan vara:

  • Obligatoriskt, till exempel 'userID'
  • Icke-obligatoriskt, t.ex. 'zip', 'houseID', 'maxRating'.

Värdena för attributen kan vara:

  • enkel
  • list
  • map

Användarmetadata blir tillgängliga när autentiseringsflödet har slutförts, men vissa metadataattribut kan uppdateras under auktoriseringsflödet, beroende på MVPD och det specifika metadataattributet i fråga.

 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 profiler som erhållits via grundläggande autentisering

Begäran
code language-https 
GET /api/v2/REF30/profiles HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    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

{
    "profiles": {
        "Cablevision": {
            "notBefore": 1752149281000,
            "notAfter": 1783685280000,
            "issuer": "Cablevision",
            "type": "regular",
            "attributes": {
                "userID": {
                    "value": "BASE64_value_userId",
                    "state": "plain"
                },
                "householdID": {
                    "value": "BASE64_value_householdId",
                    "state": "plain"
                },
                "zip": {
                    "value": "BASE64_value_zip",
                    "state": "enc"
                }
            }
        },
        "Spectrum": {
            "notBefore": 1752149272300,
            "notAfter": 1783685284670,
            "issuer": "Spectrum",
            "type": "regular",
            "attributes": {
                "userID": {
                    "value": "BASE64_value_userId",
                    "state": "plain"
                }
            }
        }
     }
}

​2. Hämta profiler som erhållits via grundläggande autentisering eller enkel inloggning med Service Token-metoden

Begäran
code language-https 
GET /api/v2/REF30/profiles HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    AD-Service-Token: eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkZDNmYWIyN2NmMjg0ZmU2ZWU0ZDY3ZmExZjY4MzE3YyIsImlzcyI6IkFkb2JlIiw.....
    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

{
   "profiles": {
      "AdobeShibboleth": {
         "notBefore": 1748073636999,
         "notAfter": 1748105173000,
         "issuer": "AdobeShibboleth",
         "type": "serviceTokenSSO",
         "attributes": {
            "upstreamUserID": {
               "value": "AAdzZWNyZXQxydCkywfPBl0KExk8OWhdbUBVDDJBttfKD7RAcRlc32Pbuwd1...",
               "state": "plain"
            },
            "userID": {
               "value": "AAdzZWNyZXQxydCkywfPBl0KExk8OWhdbUBVDDJBttfKD7RAcRlc32Pbuwd14aTV....",
               "state": "plain"
            },
            "mvpd": {
               "value": "AdobeShibboleth",
               "state": "plain"
            }
         }
      },
      "Spectrum": {
         "notBefore": 1752149281000,
         "notAfter": 1783685280000,
         "issuer": "Spectrum",
         "type": "regular",
         "attributes": {
            "userID": {
               "value": "BASE64_value_userId",
               "state": "plain"
            }
         }
      }
   }
}

​3. Hämta profiler som erhållits via grundläggande autentisering eller enkel inloggning med plattformsidentitetsmetoden

Begäran
code language-https 
GET /api/v2/REF30/profiles HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Adobe-Subject-Token: eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIyMmM4MDU1MjEzMDIwYzhmZGYzOGZkMTI1YWViMzUzYSIsImlzcyI6....
    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

{
   "profiles": {
      "AdobePass_SMI": {
         "notBefore": 1724337476000,
         "notAfter": 1724345252000,
         "issuer": "AdobePass_SMI",
         "type": "platformSSO",
         "attributes": {
            "upstreamUserID": {
               "value": "38524bdc3d1caac0b3e139003ea0954e15ad9648",
               "state": "plain"
            },
            "userID": {
               "value": "38524bdc3d1caac0b3e139003ea0954e15ad9648",
               "state": "plain"
            },
            "mvpd": {
               "value": "AdobePass_SMI",
               "state": "plain"
            }
         }
      },
      "Cablevision": {
         "notBefore": 1752149281000,
         "notAfter": 1783685280000,
         "issuer": "Spectrum",
         "type": "regular",
         "attributes": {
            "userID": {
               "value": "BASE64_value_userId",
               "state": "plain"
            }
         }
      }
   }
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b