Skip to main content

Retrieve the information returned by the identity provider

POST 
https://$CUSTOM-DOMAIN/v2/idp_intents/:idpIntentId

Retrieve the information returned by the identity provider for registration or updating an existing user with new information..

Request​

Path Parameters

    idpIntentId stringrequired

    ID of the idp intent, previously returned on the success response of the IDP callback

Body

required

    idpIntentToken string

    Possible values: non-empty and <= 200 characters

    token of the idp intent, previously returned on the success response of the IDP callback

Responses​

OK

Schema

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    resourceOwner resource_owner is the organization or instance_id an object belongs to (string)

    idpInformation

    object

    oauth

    object

    OAuth/OIDC access (and id_token) returned by the identity provider

    accessToken string
    idToken string

    ldap

    object

    LDAP entity attributes returned by the identity provider

    attributes object

    saml

    object

    SAMLResponse returned by the identity provider

    assertion byte
    idpId string

    ID of the identity provider

    userId string

    ID of the user of the identity provider

    userName string

    username of the user of the identity provider

    rawInformation object

    complete information returned by the identity provider

    userId string

    ID of the user in ZITADEL if external user is linked

curl -L 'https://$CUSTOM-DOMAIN/v2/idp_intents/:idpIntentId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "idpIntentToken": "SJKL3ioIDpo342ioqw98fjp3sdf32wahb="
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN
Auth
Parameters
— pathrequired
Body required
{
  "idpIntentToken": "SJKL3ioIDpo342ioqw98fjp3sdf32wahb="
}
ResponseClear

Click the Send API Request button above and see the response here!