Skip to main content

Get the information of the IDP authentication intent

GET 
/resources/v3alpha/idp_intents/:idpIntentId

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

Request​

Path Parameters

    idpIntentId stringrequired

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

Query Parameters

    instance.id string
    instance.domain string
    organization.orgId string
    organization.orgDomain string
    idpIntentToken stringrequired

    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

    id string
    created date-time

    the timestamp of the first event applied to the object.

    changed date-time

    the timestamp of the last event applied to the object.

    owner

    object

    the parent object representing the returned objects context.

    type string

    Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

    Default value: OWNER_TYPE_UNSPECIFIED

    id string

    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.

    id string

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

Loading...