Categories:

System Functions (System Information)

SYSTEM$MIGRATE_SAML_IDP_REGISTRATION

Migrates an existing SAML identity provider (i.e. IdP) configuration as defined by the account parameter SAML_IDENTITY_PROVIDER to a security integration.

If the account parameter SAML_IDENTITY_PROVIDER is present, SYSTEM$MIGRATE_SAML_IDP_REGISTRATION creates a new security integration using the data in the SAML_IDENTITY_PROVIDER parameter.

If the account SAML_IDENTITY_PROVIDER parameter is not present, the function fails. If this occurs, create a security integration where TYPE = SAML2 as shown in CREATE SECURITY INTEGRATION.

Syntax

SYSTEM$MIGRATE_SAML_IDP_REGISTRATION( '<integration_name>', '<issuer>' )

Arguments

integration_name

Name of the new SAML2 security integration to be created that will contain the IdP configuration.

Note that the entire name must be enclosed in single quotes.

Required.

issuer

Value of the IdP EntityID / Issuer.

The entire name must be enclosed in single quotes.

Required if not specified in the SAML_IDENTITY_PROVIDER as the Issuer attribute. To verify whether this parameter contains a value for Issuer, execute the following statement:

show parameters like 'SAML_IDENTITY_PROVIDER' in account;

Important

If the SAML_IDENTITY_PROVIDER parameter does not contain a value for Issuer, use your IdP’s metadata to locate the exact value. Depending on the IdP, you may be able to locate the issuer value through the user interface administrator settings, a URL your IdP provides, or by downloading the SAML federation metadata XML to a local file.

As a representative example, the following references detail how to locate the issuer value for Okta and Microsoft Azure AD:

Examples

The following is a representative example that migrates the IdP successfully and shows how to view the newly created security integration:

-- migrate an existing IDP configuration

select system$migrate_saml_idp_registration('my_fed_integration', 'http://my_idp.com');

+---------------------------------------------------------------------------------+
| SYSTEM$MIGRATE_SAML_IDP_REGISTRATION('MY_FED_INTEGRATION', 'HTTP://MY_IDP.COM') |
+---------------------------------------------------------------------------------+
| SUCCESS : [MY_FED_INTEGRATION] Fed SAML integration created                     |
+---------------------------------------------------------------------------------+

-- view the newly created security integration

desc integration my_fed_integration;