DocumentatieAdobe PassAdobe Pass-verificatie

Profiel ophalen met verificatierespons van partner retrieve-profile-using-partner-authentication-response

Last update: Tue Oct 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
IMPORTANT
De inhoud op deze pagina wordt alleen ter informatie verstrekt. Voor het gebruik van deze API is een huidige licentie van Adobe vereist. Ongeautoriseerd gebruik is niet toegestaan.
IMPORTANT
De implementatie van REST API V2 wordt begrensd door de Throttling mechanismedocumentatie.

Verzoek request

HTTP
pad
/api/v2/{serviceProvider}/profiles/sso/{partner}
methode
POST
Padparameters
serviceProvider
De interne unieke id die tijdens het instapproces aan de Serviceleverancier is gekoppeld.
vereist
partner
De naam van de partner (bijvoorbeeld Apple) die het Single Sign-On-framework biedt dat is geïntegreerd met Adobe Pass-verificatiestromen.
vereist
Bodyparameters
SAMLResponse
De reactie van de partnerauthentificatie die de vereiste gebruikersmeta-gegevens bevat om een partnerprofiel tot stand te brengen en op te slaan.

De waarde moet Base64-gecodeerd en achteraf URL-gecodeerd zijn.
vereist
Kopteksten
Toestemming
De generatie van de toonder symbolische nuttige lading wordt beschreven in de 1} kopbaldocumentatie van de Toestemming {.
vereist
Inhoudstype
Het geaccepteerde mediatype voor de bronnen die worden verzonden.

Het moet application/x-www-form-urlencoded zijn.
vereist
AP-apparaat-id
De generatie van de apparatenherkenningstekenlading wordt beschreven in AP-apparaat-Identifierkopbaldocumentatie.
vereist
X-Apparaat-Info
De generatie van de lading van de apparateninformatie wordt beschreven in x-apparaat-Infokopbaldocumentatie.

Het wordt ten zeerste aanbevolen deze altijd te gebruiken wanneer het apparaatplatform van de toepassing expliciet geldige waarden biedt.

Als deze optie is opgegeven, worden waarden met geëxtraheerde waarden expliciet samengevoegd met de Adobe Pass-verificatieachterkant (standaard).

Als deze optie niet is opgegeven, gebruikt de Adobe Pass Authentication-backend impliciet geëxtraheerde waarden (standaard).
vereist
AP-Partner-Kader-Status
De generatie van enige sign-on lading voor de methode van de Partner wordt beschreven in AP-partner-kader-statuskopbaldocumentatie.

Voor meer details over enige sign-on toegelaten stromen die een partner gebruiken, verwijs naar Enige sign-on gebruikend de documentatie van de partnerstromen.
optioneel
X-Forwarded-For
Het IP-adres van het streamingapparaat.

Het wordt sterk geadviseerd om het voor server aan serverimplementaties altijd te gebruiken, vooral wanneer de vraag door de programmeerdienst eerder dan het het stromen apparaat wordt gemaakt.

Voor client-naar-server-implementaties wordt het IP-adres van het streamingapparaat impliciet verzonden.
optioneel
Accepteren
Het mediatype dat door de clienttoepassing wordt geaccepteerd.

Indien gespecificeerd, moet het application/json zijn.
optioneel
Gebruikersagent
De gebruikersagent van de clienttoepassing.
optioneel

Antwoord response

Code
Tekst
Beschrijving
201
Gemaakt
De hoofdtekst van de reactie bevat een kaart met geldige profielen, die leeg kan zijn.
400
Ongeldig verzoek
De aanvraag is ongeldig, de client moet de aanvraag corrigeren en het opnieuw proberen. Het reactielichaam kan fouteninformatie bevatten die aan de Verbeterde documentatie van de Codes van de Foutvolgt.
401
Ongeautoriseerd
Het toegangstoken is ongeldig, moet de cliënt een nieuw toegangstoken verkrijgen en opnieuw proberen. Voor meer details verwijs naar de Dynamische documentatie van de Registratie van de Cliënt van het Overzicht.
405
Methode niet toegestaan
De HTTP-methode is ongeldig, de client moet een HTTP-methode gebruiken die is toegestaan voor de aangevraagde resource en het opnieuw proberen. Voor meer details verwijs naar de 1} sectie van het Verzoek {.
500
Interne serverfout
Er is een probleem opgetreden op de server. Het reactielichaam kan fouteninformatie bevatten die aan de Verbeterde documentatie van de Codes van de Foutvolgt.

Succes success

Kopteksten
Status
201
vereist
Inhoudstype
application/json
vereist
Lichaam
profielen

JSON met een overzicht van sleutel-, waardeparen.

Het hoofdelement wordt gedefinieerd door de volgende waarde:

table 0-row-3 1-row-3 1-bgcolor-eff2f7 2-bgcolor-eff2f7 3-bgcolor-eff2f7 5-bgcolor-deebff layout-auto html-authored
Waarde
mvpd De interne unieke id die tijdens het instapproces aan de identiteitsprovider is gekoppeld. vereist

Het element value wordt gedefinieerd door de volgende kenmerken:

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
Kenmerk
notBefore De tijdstempel waarvóór het profiel niet geldig is. vereist
notAfter De tijdstempel waarna het profiel niet geldig is. vereist
uitgever

De entiteit die eigenaar is van het profiel.

De mogelijke waarden zijn:

  • Apple
    het profiel werd gecreeerd als resultaat van: enig teken-op het gebruiken van partnerApple.
 vereist
type

Het type profiel.

De mogelijke waarden zijn:

  • appleSSO
    Het profiel werd gecreeerd als resultaat van: enig teken-op het gebruiken van partner Apple.
 vereist
attributes

De lijst met metagegevenskenmerken van de gebruiker.

Deze kenmerken kunnen zijn:

  • Verplicht, zoals 'userId'
  • Niet-verplicht, zoals 'zip', 'familyId', 'maxRating', enz.

De waarden voor de kenmerken kunnen zijn:

  • eenvoudig
  • list
  • map
 vereist
vereist

Fout error

Kopteksten
Status
400, 401, 405, 500
vereist
Inhoudstype
application/json
vereist
Lichaam
Het reactielichaam kan extra fouteninformatie verstrekken die aan de Verbeterde documentatie van de Codes van de Foutvolgt.
vereist

Voorbeelden samples

1. Haal profiel terug gebruikend de reactie van de partnerauthentificatie

Verzoek
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...
Reactie
code language-https 
HTTP/1.1 201 Created

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

{
    "profiles": {
        "Cablevision": {
            "notBefore": 1623943955,
            "notAfter": 1623951155,
            "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. Haal profiel terug gebruikend de reactie van de partnerauthentificatie, maar de degradatie wordt toegepast

Verzoek
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...
Reactie
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