Skip to main content

Retrieve the information returned by the identity provider​

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

Path Parameters
    idpIntentId string required

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

Request 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
    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

POST /v2beta/idp_intents/:idpIntentId

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN
Bearer Token
idpIntentId — path required
Content-Type
Body required
{

  "idpIntentToken": "SJKL3ioIDpo342ioqw98fjp3sdf32wahb="

}
Accept
curl / cURL
curl -L -X POST 'https://$CUSTOM-DOMAIN/v2beta/idp_intents/:idpIntentId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "idpIntentToken": "SJKL3ioIDpo342ioqw98fjp3sdf32wahb="
}'