MFA Connector

Manage connectors to multi-factor authentication providers.

📄️List multi-factor authentication connectors

Returns all configured connectors, sorted by name. Use it to see which RADIUS, OpenID Connect and SAML connectors exist and which one is the default or exclusive.

📄️Create a RADIUS connector

Creates a RADIUS multi-factor authentication connector together with its RADIUS settings. Use it to add a RADIUS server as a sign-in method.

📄️Set the default connector

Turns the default setting on or off for a connector. Turning it on makes this the default sign-in method, removes the default setting from the previous default connector and removes the exclusive setting from whichever connector has it, including this one. If the connector is already the default, nothing changes. Turning it off changes only this connector.

📄️Assign a connector to a group

Sets the multi-factor authentication connector for a managed account group. Members who have no connector of their own use the group's connector. If a member belongs to several groups that have connectors, the group that comes first by name is used.

📄️List connector names and IDs

Returns the ID, name and type of every connector, sorted by name. Use it to find a connector ID, for example before assigning a connector to a user.

📄️List OpenID Connect connectors

Returns the ID, name and type of each OpenID Connect connector, sorted by name. Use it to find the OpenID Connect connector you want to view or change.

📄️Delete an OpenID Connect connector

Deletes the multi-factor authentication connector with the given connector ID. Use it to remove a OpenID Connect connector you no longer need; it behaves the same as the general connector delete.

📄️Update OpenID Connect settings

Updates the OpenID Connect settings with the given ID. Use it to change the provider address, client ID or user matching of an OpenID Connect connector.

📄️Create a SAML connector

Creates a SAML multi-factor authentication connector together with its SAML settings. Use it to add a SAML identity provider as a sign-in method.

📄️Delete a SAML connector

Deletes the multi-factor authentication connector with the given connector ID. Use it to remove a SAML connector you no longer need; it behaves the same as the general connector delete.

📄️Get SAML settings

Returns the SAML settings with the given ID, such as the issuer, logout address, claim and name ID policy. Use it to review or edit a SAML connector.

📄️Update SAML settings

Updates the SAML settings with the given ID. Use it to change the issuer, claim, certificate or name ID policy of a SAML connector.

📄️Assign a connector to a user

Sets the multi-factor authentication connector used by a user and returns the user's account information. If the user is not yet a product user, the call first checks that the license allows another user, then creates the product user.

📄️Get a multi-factor authentication connector

Returns the connector with the given ID. Use it to see a connector's name, type, enabled state and the IDs of its settings.