Skip to main content

Retrieve the information of the IDP authentication intent​

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

Path Parameters
    idpIntentId string required

    ID of the identity provider (IDP) intent, previously returned on the success response of the start identity provider intent.

Request Body required
    idpIntentToken string required

    Possible values: non-empty and <= 200 characters

    Token of the identity provider (IDP) intent, previously returned on the success response of the start identity provider intent.

Responses

IDP intent successfully retrieved

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

    Information returned by the identity provider (IDP) such as the identification of the user and detailed / profile information.

    idpId string

    ID of the identity provider.

    userId string

    ID of the user provided by the identity provider.

    userName string

    Username of the user provided by the identity provider.

    rawInformation object

    Complete information returned by the identity provider.

    oauth object

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

    accessToken string

    The access_token returned by the identity provider.

    idToken string

    In case the provider returned an id_token.

    ldap object
    attributes object

    The attributes of the user returned by the identity provider.

    saml object
    assertion byte

    The SAML assertion returned by the identity provider.

    userId string

    If the user was already federated and linked to a ZITADEL user, it's id will be returned.

POST /v3alpha/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/v3alpha/idp_intents/:idpIntentId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "idpIntentToken": "SJKL3ioIDpo342ioqw98fjp3sdf32wahb="
}'