latest--saml-schema

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/dwp-exchange-gateway/_shared/latest--saml-schema.json
Parent schema dwp-exchange-gateway
Type: object

Properties

idpRedirectEndpoint string required

The URL of the page the user will be redirected to by the plugin. Input varies based on the user.

format=uri
pathToListenOn string required

The path that identity provider will post is relative to current API. Varies from user to user

pattern=^/(.*)[^/]*$
userIdAttributeName string required

Enables find user in the SAML response attribute statement and always differs between SAML plugin users

format=uri
usernameAttributeName string required

Acts in place of the default username attribute

rolesAttributeName string required

Acts in place of the default roles attribute

format=uri
expectedIpPublicKey string required

A path to X509 certificate file in PEM format which contains a public key which matches the X509 certificate/key returned by Identify Provider(e.g ADFS).

pattern=^/(.*)[^/]*$
HMACSecret string required

A secret string for using in conjunction with private key for generating the HMAC signature in the JWT

maxLength=8
RSACertificate string required

Validates the signature in JWT token

pattern=^/(.*)[^/]*$
RSAPrivateKey string required

Used for encrypting the JWT payload

pattern=^/(.*)[^/]*$
customIssuer string

Provides information which is sent to the SAML IDP and which the IDP may take action on.

format=uri
authenticationRequestVerb string

The HTTP verb that the Authentication request redirection form will be sent with.

Default: "POST"
pattern=^((?:GET|POST|PUT|HEAD|DELETE|CONNECT|OPTIONS|PATCH|TRACE),?\s?)+$
userLastNameAttributeName string

Acts in place of the default lastName attribute

format=uri
authIndex integer

Determines which authentication request is sent

Default: 1
min=1max=7
customAuthnRequestXML string

Custom XML to send to the IDP. Must be valid against https://tinyurl.com/atv7c8n

disableSignatureValidation boolean

Disable validation of the signature.

Default: false
signatureCountInResponse integer

EAS SAML responses contain 2 signatures and ADFS/AZURE AD SAML responses contain one signature.

Default: 1
min=1max=2
easCustomIssuer string

The issuer value in the EAS authentication request.

format=uri
easAssertionConsumerUrl string

The assertion consumer url in the EAS authentication request

format=uri
allowNoSigning boolean

Allow tokens that use an algorithm of NONE.

Default: false
encrypt boolean

An encrypted token (JWE) when returning a token to the caller.

Default: true
denyTokenlessSubmission boolean

Prevent data from being posted (POST/PUT) through the Gateway without a token

Default: true
tokenTTL integer

Number of seconds before the token (and cookie) time-out

Default: 20000
min=1
authTTL integer

Number of seconds before the authentication session times-out

Default: 20000
min=1