yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-10-24 15:25:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/v1.5.x-SNAPSHOT/main-concepts/metadata-standard/schemas/security/client/samlSSOClientConfig.md
Imri Paran e2f845b2d1
docs: add 1.5.x-SNAPSHOT (#16694)
2024-06-18 15:53:06 +02:00

2.8 KiB
Raw Blame History

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

SamlSSOClientConfig

SAML SSO client security configs.

Properties

  • idp: Refer to #/definitions/idp.
  • sp: Refer to #/definitions/sp.
  • security: Refer to #/definitions/security.
  • debugMode (boolean): Get logs from the Library in debug mode. Default: False.

Definitions

  • idp (object): This schema defines defines the identity provider config. Cannot contain additional properties.
    • entityId (string): Identity Provider Entity ID usually same as the SSO login URL.
    • ssoLoginUrl (string): 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): Service Provider Entity ID.
    • acs (string): Assertion Consumer URL.
    • spX509Certificate (string): X509 Certificate .
    • spPrivateKey (string): Sp Private Key for Signing and Encryption Only.
    • callback (string): 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.
    • 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.
    • wantNameIdEncrypted (boolean): SP requires the Name Id received to be encrypted. Default: False.
    • keyStoreFilePath (string): KeyStore File Path.
    • keyStoreAlias (string): KeyStore Alias.
    • keyStorePassword (string): KeyStore Password.

Documentation file automatically generated at 2023-10-27 13:55:46.343512.