DokumentationAdobe PassAdobe Pass-autentisering

Skapa och hämta profil med partnerautentiseringssvar create-and-retrieve-profile-using-partner-authentication-response

Last update: Tue Sep 02 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.

Begäran request

HTTP
bana
/api/v2/{serviceProvider}/profiles/sso/{partner}
method
POST
Sökvägsparametrar
serviceProvider
Den interna unika identifierare som är associerad med tjänsteleverantören under introduktionsprocessen.
obligatoriskt
partner
Namnet på den partner (t.ex. Apple) som tillhandahåller det single sign-on-ramverk som är integrerat med Adobe Pass autentiseringsflöden.
obligatoriskt
Kroppsparametrar
SAMLResponse
Partnerautentiseringssvaret som innehåller de användarmetadata som behövs för att skapa och spara en partnerprofil.

Värdet måste vara Base64-kodad och efteråt URL-kodad.
obligatoriskt
Sidhuvuden
Behörighet
Genereringen av mottagarens tokennyttolast beskrivs i rubrikdokumentationen för autentisering.
obligatoriskt
Content-Type
Godkänd medietyp för resurserna som skickas.

Det måste vara application/x-www-form-urlencoded.
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
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
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
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
201
Skapad
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
201
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:

  • Apple
    Profilen skapades som ett resultat av: enkel inloggning med partner-Apple.
 obligatoriskt
type

Profilens typ.

Möjliga värden är:

  • appleSSO
    Profilen skapades som ett resultat av: enkel inloggning med partner-Apple.
 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.

Klientprogrammet måste implementera en felhanteringsmekanism som kan hantera de felkoder som oftast returneras av denna API korrekt:

  • invalid_header_pfs_permission_access_not_present
  • invalid_header_pfs_permission_access_not_determine
  • invalid_header_pfs_permission_access_not_granted
  • invalid_header_pfs_provider_id_not_determine
  • invalid_header_pfs_provider_id_mismatch
  • invalid_header_pfs_provider_info_utgången
  • invalid_parameter_saml_response
  • osv.

Förteckningen ovan är inte uttömmande. Klientprogrammet måste kunna hantera alla utökade felkoder som definieras i den offentliga dokumentationen.

obligatoriskt

Exempel samples

​1. Skapa och hämta profil med partnerautentiseringssvar

Begäran
code language-https 
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...
Svar
code language-https 
HTTP/1.1 201 Created

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

{
    "profiles": {
        "Cablevision": {
            "notBefore": 1752149281000,
            "notAfter": 1783685280000,
            "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. Skapa och hämta profil med partnerautentiseringssvar, men en försämring tillämpas

Begäran
code language-https 
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...
Svar
code language-https 
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