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.
Possible values: [AUTO_LINKING_OPTION_UNSPECIFIED
, AUTO_LINKING_OPTION_USERNAME
, AUTO_LINKING_OPTION_EMAIL
]
Default value: AUTO_LINKING_OPTION_UNSPECIFIED
Enable if users should get prompted to link an existing ZITADEL user to an external account if the selected attribute matches.
Possible values: [SAML_NAME_ID_FORMAT_UNSPECIFIED
, SAML_NAME_ID_FORMAT_EMAIL_ADDRESS
, SAML_NAME_ID_FORMAT_PERSISTENT
, SAML_NAME_ID_FORMAT_TRANSIENT
]
Default value: SAML_NAME_ID_FORMAT_UNSPECIFIED
Optionally specify the nameid-format
requested.
Optionally specify the name of the attribute, which will be used to map the user
in case the nameid-format returned is urn:oasis:names:tc:SAML:2.0:nameid-format:transient
.
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.
Possible values: [AUTO_LINKING_OPTION_UNSPECIFIED
, AUTO_LINKING_OPTION_USERNAME
, AUTO_LINKING_OPTION_EMAIL
]
Default value: AUTO_LINKING_OPTION_UNSPECIFIED
Enable if users should get prompted to link an existing ZITADEL user to an external account if the selected attribute matches.
Possible values: [SAML_NAME_ID_FORMAT_UNSPECIFIED
, SAML_NAME_ID_FORMAT_EMAIL_ADDRESS
, SAML_NAME_ID_FORMAT_PERSISTENT
, SAML_NAME_ID_FORMAT_TRANSIENT
]
Default value: SAML_NAME_ID_FORMAT_UNSPECIFIED
Optionally specify the nameid-format
requested.
Optionally specify the name of the attribute, which will be used to map the user
in case the nameid-format returned is urn:oasis:names:tc:SAML:2.0:nameid-format:transient
.
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.
Possible values: [AUTO_LINKING_OPTION_UNSPECIFIED
, AUTO_LINKING_OPTION_USERNAME
, AUTO_LINKING_OPTION_EMAIL
]
Default value: AUTO_LINKING_OPTION_UNSPECIFIED
Enable if users should get prompted to link an existing ZITADEL user to an external account if the selected attribute matches.
Possible values: [SAML_NAME_ID_FORMAT_UNSPECIFIED
, SAML_NAME_ID_FORMAT_EMAIL_ADDRESS
, SAML_NAME_ID_FORMAT_PERSISTENT
, SAML_NAME_ID_FORMAT_TRANSIENT
]
Default value: SAML_NAME_ID_FORMAT_UNSPECIFIED
Optionally specify the nameid-format
requested.
Optionally specify the name of the attribute, which will be used to map the user
in case the nameid-format returned is urn:oasis:names:tc:SAML:2.0:nameid-format:transient
.
- 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-06-13T06:44:38.984Z",
"changeDate": "2024-06-13T06:44:38.984Z",
"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-06-13T06:44:38.984Z",
"changeDate": "2024-06-13T06:44:38.984Z",
"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-06-13T06:44:38.985Z",
"changeDate": "2024-06-13T06:44:38.985Z",
"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"
}
]
}