saml-integrations.md

SAML Integrations

6 operation(s). Part of the API index.

Call these as client.<service>.<method>({ ... }). <service> is the client field for this group — the README lists the field name for every service. These pages group operations the way the OpenAPI specification tags them, which is not always one field per page.

---

createSamlIntegration

POST /v2/manage/integrations/saml

Create SAML IdP Configuration

Creates a new SAML-based Identity Provider integration for the Tenant, enabling authentication and federation with the specified IdP.

Example

async function callCreateSamlIntegration(client: LoginRadius) {
  const object = {  }; //Required

  try {
    const res = await client.<service>.createSamlIntegration({ object });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Request body

object as application/json.

Returns

SamlIntegrationResponse

---

deleteSamlIntegrationByAppName

DELETE /v2/manage/integrations/saml/{samlApp}

Delete SAML IdP Configuration

Deletes the SAML-based Identity Provider configuration for the Tenant identified by the application name, disabling authentication for the specified application.

Example

async function callDeleteSamlIntegrationByAppName(client: LoginRadius) {
  const samlApp: string = '<samlApp>'; //Required

  try {
    const res = await client.<service>.deleteSamlIntegrationByAppName({ samlApp });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Parameters

Name	In	Type	Required	Description
samlApp	path	string	yes	The SAML App identifier

Returns

DeleteResponse

---

getAllSamlIntegrations

GET /v2/manage/integrations/saml

List SAML Integrations

Retrieves a list of all configured SAML-based Identity Provider integrations for the Tenant, including metadata and settings for authentication.

Example

async function callGetAllSamlIntegrations(client: LoginRadius) {
  try {
    const res = await client.<service>.getAllSamlIntegrations();
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Returns

object

---

getSamlIntegrationByAppName

GET /v2/manage/integrations/saml/{samlApp}

Retrieve SAML IdP client configuration by app name

Retrieves the SAML-based Identity Provider configuration details for the Tenant using the application name, including metadata and settings.

Example

async function callGetSamlIntegrationByAppName(client: LoginRadius) {
  const samlApp: string = '<samlApp>'; //Required

  try {
    const res = await client.<service>.getSamlIntegrationByAppName({ samlApp });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Parameters

Name	In	Type	Required	Description
samlApp	path	string	yes	The SAML App identifier

Returns

SamlIntegrationResponse

---

renewSamlIntegrationCertificate

POST /v2/manage/integrations/saml/{samlApp}/renew-certificate

Renew SAML IdP Certificate

Renews the SAML Identity Provider certificate to replace an expiring or compromised signing certificate.

Example

async function callRenewSamlIntegrationCertificate(client: LoginRadius) {
  const samlApp: string = '<samlApp>'; //Required

  try {
    const res = await client.<service>.renewSamlIntegrationCertificate({ samlApp });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Parameters

Name	In	Type	Required	Description
samlApp	path	string	yes	The SAML App identifier

Returns

SamlIntegrationResponse

---

updateSamlIntegrationByAppName

PUT /v2/manage/integrations/saml/{samlApp}

Update SAML IdP client configuration by app name

Updates an existing SAML-based Identity Provider configuration for the Tenant identified by the application name, modifying necessary settings.

Example

async function callUpdateSamlIntegrationByAppName(client: LoginRadius) {
  const samlApp: string = '<samlApp>'; //Required
  const samlIntegrationRequest = {  }; //Required

  try {
    const res = await client.<service>.updateSamlIntegrationByAppName({ samlApp, samlIntegrationRequest });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Parameters

Name	In	Type	Required	Description
samlApp	path	string	yes	The SAML App identifier

Request body

SamlIntegrationRequest as application/json.

Returns

SamlIntegrationResponse