AddSAMLProvider

Add a new SAML identity provider on the instance

Request Body

application/json

name?string

binding?string

Binding which defines the type of communication with the identity provider.

Value in"SAML_BINDING_UNSPECIFIED" | "SAML_BINDING_POST" | "SAML_BINDING_REDIRECT" | "SAML_BINDING_ARTIFACT"

withSignedRequest?boolean

Boolean which defines if the authentication requests are signed.

providerOptions?

nameIdFormat?string

Optionally specify the nameid-format requested.

Value in

"SAML_NAME_ID_FORMAT_UNSPECIFIED" | "SAML_NAME_ID_FORMAT_EMAIL_ADDRESS" | "SAML_NAME_ID_FORMAT_PERSISTENT" | "SAML_NAME_ID_FORMAT_TRANSIENT"

transientMappingAttributeName?string

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.

federatedLogoutEnabled?boolean

Optionally enable federated logout. If enabled, Zitadel will send a logout request to the identity provider, if the user terminates the session in ZITADEL. Be sure to provide a SLO endpoint as part of the metadata.

signatureAlgorithm?string

Specify a Signature Algorithm that should be used to sign SAML requests and responses. Can be used only if the with_signed_request option is set to true.

Value in"SAML_SIGNATURE_UNSPECIFIED" | "SAML_SIGNATURE_RSA_SHA1" | "SAML_SIGNATURE_RSA_SHA256" | "SAML_SIGNATURE_RSA_SHA512"

metadataUrl*string

Url to the metadata of the SAML identity provider.

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/idps/saml" \
  -H "Content-Type: application/json" \
  -d '{
    "metadataUrl": "string"
  }'

curl -X POST "https://loading/idps/saml" \  -H "Content-Type: application/json" \  -d '{    "metadataUrl": "string"  }'

{
  "details": {
    "sequence": 0,
    "creationDate": "1s",
    "changeDate": "1s",
    "resourceOwner": "string"
  },
  "id": "string"
}

{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

AddSAMLProvider

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`