Add SAML Identity Provider​
Add SAML Identity Provider
Request Body required
Metadata of the SAML identity provider
Url to the metadata of the SAML identity provider
Possible values: [SAML_BINDING_UNSPECIFIED
, SAML_BINDING_POST
, SAML_BINDING_REDIRECT
, SAML_BINDING_ARTIFACT
]
Default value: SAML_BINDING_UNSPECIFIED
Binding which defines the type of communication with the identity provider
Boolean which defines if the authentication requests are signed
providerOptions object
Enable if users should be able to link an existing ZITADEL user with an external account.
Enable if users should be able to create a new account in ZITADEL when using an external account.
Enable if a new account in ZITADEL should be created automatically when login with an external account.
Enable if a the ZITADEL account fields should be updated automatically on each login.
Request Body required
Metadata of the SAML identity provider
Url to the metadata of the SAML identity provider
Possible values: [SAML_BINDING_UNSPECIFIED
, SAML_BINDING_POST
, SAML_BINDING_REDIRECT
, SAML_BINDING_ARTIFACT
]
Default value: SAML_BINDING_UNSPECIFIED
Binding which defines the type of communication with the identity provider
Boolean which defines if the authentication requests are signed
providerOptions object
Enable if users should be able to link an existing ZITADEL user with an external account.
Enable if users should be able to create a new account in ZITADEL when using an external account.
Enable if a new account in ZITADEL should be created automatically when login with an external account.
Enable if a the ZITADEL account fields should be updated automatically on each login.
Request Body required
Metadata of the SAML identity provider
Url to the metadata of the SAML identity provider
Possible values: [SAML_BINDING_UNSPECIFIED
, SAML_BINDING_POST
, SAML_BINDING_REDIRECT
, SAML_BINDING_ARTIFACT
]
Default value: SAML_BINDING_UNSPECIFIED
Binding which defines the type of communication with the identity provider
Boolean which defines if the authentication requests are signed
providerOptions object
Enable if users should be able to link an existing ZITADEL user with an external account.
Enable if users should be able to create a new account in ZITADEL when using an external account.
Enable if a new account in ZITADEL should be created automatically when login with an external account.
Enable if a the ZITADEL account fields should be updated automatically on each login.
- 200
- 403
- 404
- default
A successful response.
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 first event of the object
on create: 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
{
"details": {
"sequence": "2",
"creationDate": "2024-03-27T06:43:23.499Z",
"changeDate": "2024-03-27T06:43:23.499Z",
"resourceOwner": "69629023906488334"
},
"id": "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 first event of the object
on create: 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
{
"details": {
"sequence": "2",
"creationDate": "2024-03-27T06:43:23.499Z",
"changeDate": "2024-03-27T06:43:23.499Z",
"resourceOwner": "69629023906488334"
},
"id": "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 first event of the object
on create: 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
{
"details": {
"sequence": "2",
"creationDate": "2024-03-27T06:43:23.499Z",
"changeDate": "2024-03-27T06:43:23.499Z",
"resourceOwner": "69629023906488334"
},
"id": "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"
}
]
}