Start an IDP authentication intent​
Start a new authentication intent on configured identity provider (IDP) for external login, registration or linking.
Request Body required
Possible values: non-empty
and <= 200 characters
ID of an existing identity provider (IDP).
urls object
Possible values: non-empty
and <= 200 characters
URL to which the user will be redirected after a successful login.
Possible values: non-empty
and <= 200 characters
URL to which the user will be redirected after a failed login.
ldap object
Possible values: non-empty
and <= 200 characters
Username used to login through LDAP.
Possible values: non-empty
and <= 200 characters
Password used to login through LDAP.
Request Body required
Possible values: non-empty
and <= 200 characters
ID of an existing identity provider (IDP).
urls object
Possible values: non-empty
and <= 200 characters
URL to which the user will be redirected after a successful login.
Possible values: non-empty
and <= 200 characters
URL to which the user will be redirected after a failed login.
ldap object
Possible values: non-empty
and <= 200 characters
Username used to login through LDAP.
Possible values: non-empty
and <= 200 characters
Password used to login through LDAP.
Request Body required
Possible values: non-empty
and <= 200 characters
ID of an existing identity provider (IDP).
urls object
Possible values: non-empty
and <= 200 characters
URL to which the user will be redirected after a successful login.
Possible values: non-empty
and <= 200 characters
URL to which the user will be redirected after a failed login.
ldap object
Possible values: non-empty
and <= 200 characters
Username used to login through LDAP.
Possible values: non-empty
and <= 200 characters
Password used to login through LDAP.
- 200
- 403
- 404
- default
IDP intent successfully started
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
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.
ID of the identity provider (IDP) intent.
Token of the identity provider (IDP) intent.
If the user was already federated and linked to a ZITADEL user, it's id will be returned.
The HTML form with the embedded POST call information to render and execute.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.422Z",
"resourceOwner": "69629023906488334"
},
"authUrl": "https://accounts.google.com/o/oauth2/v2/auth?client_id=clientID&callback=https%3A%2F%2Fzitadel.cloud%2Fidps%2Fcallback",
"idpIntent": {
"idpIntentId": "163840776835432705",
"idpIntentToken": "SJKL3ioIDpo342ioqw98fjp3sdf32wahb=",
"userId": "163840776835432345"
},
"postForm": "string"
}
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
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.
ID of the identity provider (IDP) intent.
Token of the identity provider (IDP) intent.
If the user was already federated and linked to a ZITADEL user, it's id will be returned.
The HTML form with the embedded POST call information to render and execute.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.422Z",
"resourceOwner": "69629023906488334"
},
"authUrl": "https://accounts.google.com/o/oauth2/v2/auth?client_id=clientID&callback=https%3A%2F%2Fzitadel.cloud%2Fidps%2Fcallback",
"idpIntent": {
"idpIntentId": "163840776835432705",
"idpIntentToken": "SJKL3ioIDpo342ioqw98fjp3sdf32wahb=",
"userId": "163840776835432345"
},
"postForm": "string"
}
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
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.
ID of the identity provider (IDP) intent.
Token of the identity provider (IDP) intent.
If the user was already federated and linked to a ZITADEL user, it's id will be returned.
The HTML form with the embedded POST call information to render and execute.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.422Z",
"resourceOwner": "69629023906488334"
},
"authUrl": "https://accounts.google.com/o/oauth2/v2/auth?client_id=clientID&callback=https%3A%2F%2Fzitadel.cloud%2Fidps%2Fcallback",
"idpIntent": {
"idpIntentId": "163840776835432705",
"idpIntentToken": "SJKL3ioIDpo342ioqw98fjp3sdf32wahb=",
"userId": "163840776835432345"
},
"postForm": "string"
}
Returned when the user does not have permission to access the resource.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}