Skip to main content

Start an IDP authentication intent

POST 
/resources/v3alpha/idp_intents

Start a new authentication intent on configured identity provider (IDP) for external login, registration or linking.

Request​

Body

required

    instance

    object

    id string
    domain string

    organization

    object

    Optionally expect the user to be in this organization.

    orgId string
    orgDomain string
    idpId stringrequired

    Possible values: non-empty and <= 200 characters

    ID of an existing identity provider (IDP).

    urls

    object

    successUrl stringrequired

    Possible values: non-empty and <= 2048 characters

    URL to which the user will be redirected after a successful login.

    failureUrl stringrequired

    Possible values: non-empty and <= 2048 characters

    URL to which the user will be redirected after a failed login.

    ldap

    object

    username stringrequired

    Possible values: non-empty and <= 200 characters

    Username used to login through LDAP.

    password stringrequired

    Possible values: non-empty and <= 200 characters

    Password used to login through LDAP.

Responses​

IDP intent successfully started

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
    authUrl string

    The authentication URL to which the client should redirect.

    idpIntent

    object

    The Start Intent directly succeeded and returned the IDP Intent. Further information can be retrieved by using the retrieve identity provider intent request.

    idpIntentId string

    ID of the identity provider (IDP) intent.

    idpIntentToken string

    Token of the identity provider (IDP) intent.

    userId string

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

    postForm byte

    The HTML form with the embedded POST call information to render and execute.

Loading...