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

function callCreateSamlIntegration($client) {
    $createSamlIntegrationRequest = new \LoginRadius\Sdk\Internal\OpenApi\Model\CreateSamlIntegrationRequest(['appName' => '<appName>']); //Required

    try {
        $response = $client->samlIntegrations->createSamlIntegration($createSamlIntegrationRequest);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

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

function callDeleteSamlIntegrationByAppName($client) {
    $samlApp = '<samlApp>'; //Required

    try {
        $response = $client->samlIntegrations->deleteSamlIntegrationByAppName(samlApp: $samlApp);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

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

function callGetAllSamlIntegrations($client) {
    try {
        $response = $client->samlIntegrations->getAllSamlIntegrations();
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

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

function callGetSamlIntegrationByAppName($client) {
    $samlApp = '<samlApp>'; //Required

    try {
        $response = $client->samlIntegrations->getSamlIntegrationByAppName(samlApp: $samlApp);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

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

function callRenewSamlIntegrationCertificate($client) {
    $samlApp = '<samlApp>'; //Required

    try {
        $response = $client->samlIntegrations->renewSamlIntegrationCertificate(samlApp: $samlApp);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

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

function callUpdateSamlIntegrationByAppName($client) {
    $samlApp = '<samlApp>'; //Required
    $samlIntegrationRequest = new \LoginRadius\Sdk\Internal\OpenApi\Model\SamlIntegrationRequest(['afterLogoutUrl' => '<afterLogoutUrl>', 'assertionConsumerService' => '<assertionConsumerService>', 'attributes' => '<attributes>']); //Required

    try {
        $response = $client->samlIntegrations->updateSamlIntegrationByAppName($samlIntegrationRequest, samlApp: $samlApp);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

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

Request body

SamlIntegrationRequest as application/json.

Returns

SamlIntegrationResponse