yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-07-09 10:09:09 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/v1.6.x/main-concepts/metadata-standard/schemas/security/client/samlSSOClientConfig.md
tarunpandey23 69342d4783
Feat: update generate docs schema (#19372) 
* Updated generate_docs_schema

* Updated generate_docs_schema

* Updated generate_docs_schema

* applied generate_docs_schema script

* Revert the changes in this file

---------

Co-authored-by: Tarun <tarun.p@deuexsolutions.com>
Co-authored-by: Prajwal214 <167504578+Prajwal214@users.noreply.github.com>
2025-01-15 17:46:55 +05:30

2.9 KiB
Raw Permalink Blame History

title slug
samlSSOClientConfig /main-concepts/metadata-standard/schemas/security/client/samlssoclientconfig

SamlSSOClientConfig

SAML SSO client security configs.

Properties

Definitions

  • idp (object): This schema defines defines the identity provider config. Cannot contain additional properties.
    • entityId (string, required): Identity Provider Entity ID usually same as the SSO login URL.
    • ssoLoginUrl (string, required): SSO Login URL.
    • idpX509Certificate (string): X509 Certificate .
    • authorityUrl (string): Authority URL to redirect the users on Sign In page.
    • nameId (string): Authority URL to redirect the users on Sign In page. Default: "urn:oasis:names:tc:SAML:2.0:nameid-format:emailAddress".
  • sp (object): This schema defines defines the identity provider config. Cannot contain additional properties.
    • entityId (string, required): Service Provider Entity ID.
    • acs (string, required): Assertion Consumer URL.
    • spX509Certificate (string): X509 Certificate .
    • spPrivateKey (string): Sp Private Key for Signing and Encryption Only.
    • callback (string, required): Service Provider Entity ID usually same as the SSO login URL.
  • security (object): This schema defines defines the security config for SAML. Cannot contain additional properties.
    • strictMode (boolean): Only accept valid signed and encrypted assertions if the relevant flags are set. Default: false.
    • validateXml (boolean): In case of strict mode whether to validate XML format. Default: false.
    • tokenValidity (integer): Validity for the JWT Token created from SAML Response. Default: "3600".
    • sendEncryptedNameId (boolean): Encrypt Name Id while sending requests from SP. Default: false.
    • sendSignedAuthRequest (boolean): Sign the Authn Request while sending. Default: false.
    • signSpMetadata (boolean): Want the Metadata of this SP to be signed. Default: false.
    • wantMessagesSigned (boolean): SP requires the messages received to be signed. Default: false.
    • wantAssertionsSigned (boolean): SP requires the assertions received to be signed. Default: false.
    • wantAssertionEncrypted (boolean): SP requires the assertion received to be encrypted. Default: false.
    • keyStoreFilePath (string): KeyStore File Path.
    • keyStoreAlias (string): KeyStore Alias.
    • keyStorePassword (string): KeyStore Password.

Documentation file automatically generated at 2025-01-15 09:05:25.266839+00:00.