Post

/vms/{id}/saml_config/

This endpoint creates a SAML configuration to enable SSO using a given IdP, or modifies an existing SAML configuration.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

stringRequired

VMS ID

Query parameters

idp_name

stringRequired

SAML IDP name

Body parameters

Expand All

object

saml_settings

object

encrypt_assertion

boolean

Set to true if the IdP encrypts the assertion. If true, an encryption certificate and key must be uploaded. Use encryption_saml_crt and encryption_saml_key to provide the required certificate and key. Default: false. Set to false to disable encryption.

encryption_saml_crt

string

Specifies the encryption certificate file content to upload. Required if encrypt_assertion is true.

encryption_saml_key

string

Specifies the encryption key file content to upload. Required if encrypt_assertion is true.

force_authn

boolean

Set to true to force authentication with the IDP even if there is an active session with the IdP for the user. Default: false.

idp_entityid

string

A unique identifier for the IdP instance

idp_metadata

string

Use local metadata. Supply local metadata XML.

idp_metadata_url

string

Use metadata located at specified remote URL. For example: 'https://dev-12914105.okta.com/app/exke7ia133bKXWP2g5d7/sso/saml/metadata'

signing_cert

string

Specifies the certificate file content to use for requiring signed responses from the IdP. Required if want_assertions_or_response_signed is true.

signing_key

string

Specifies the key file content to use for requiring signed responses from the IdP. Required if want_assertions_or_response_signed is true.

want_assertions_or_response_signed

boolean

Set to true to require a signed response or assertion from the IdP. VMS then fails the user authentication if an unsigned response is received. If true, upload a certificate and key. Use signing_cert and signing_key to provide certificate and key. Default: false.

Responses

200

string

400

string

Modify or Create a SAML configuration for a specific IdP