jwt-integrations.md

JWT Integrations

7 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.

---

createJwtIntegration

POST /v2/manage/integrations/jwt

Create JWT Integration

Creates a new JWT-based Integration configuration for the Tenant by specifying algorithms, mapping, and endpoint information, enabling authentication and federation with the specified IdP.

Example

function callCreateJwtIntegration($client) {
    $createJwtIntegrationRequest = new \LoginRadius\Sdk\Internal\OpenApi\Model\CreateJwtIntegrationRequest(['appName' => '<appName>', 'algo' => '<algo>', 'secret' => '<secret>']); //Required

    try {
        $response = $client->jwtIntegrations->createJwtIntegration($createJwtIntegrationRequest);
        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

JwtIntegrationResponse

---

deleteJwtIntegration

DELETE /v2/manage/integrations/jwt/{jwtApp}

Delete JWT Integration configuration

Deletes an existing JWT-based integration configuration for the Tenant using its AppName, permanently disabling authentication and federation with that IdP.

Example

function callDeleteJwtIntegration($client) {
    $jwtApp = '<jwtApp>'; //Required

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

Parameters

Name	In	Type	Required	Description
jwtApp	path	string	yes	The jwt App identifier

Returns

DeleteResponse

---

getAllJwtIntegrations

GET /v2/manage/integrations/jwt

List JWT Integrations

Retrieves a list of all configured JWT-based integrations for the Tenant, including algorithms, mapping, endpoints, and settings used for authentication and federation.

Example

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

Returns

object

---

getJwtIntegrationByAppName

GET /v2/manage/integrations/jwt/{jwtApp}

Retrieve JWT Integration configuration

Retrieves the details of a specific JWT-based integration configuration for the Tenant using the AppName, including algorithms, mapping, and endpoints associated with the application.

Example

function callGetJwtIntegrationByAppName($client) {
    $jwtApp = '<jwtApp>'; //Required

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

Parameters

Name	In	Type	Required	Description
jwtApp	path	string	yes	The jwt App identifier

Returns

JwtIntegrationResponse

---

getJwtIntegrationDataMappingFieldsList

GET /v2/manage/integrations/jwt/data-mapping

List JWT data mapping fields

Retrieves a list of available data mapping fields that can be used when configuring JWT-based Identity Provider (IdP) integrations for the Tenant, including all supported fields for mapping JWT claims to User profile attributes.

Example

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

Returns

object

---

getJwtIntegrationSupportedAlgoList

GET /v2/manage/integrations/jwt/algo

List supported JWT algorithms

Retrieves a list of all supported cryptographic algorithms that can be used by JWT clients for signing and verification when configuring a JWT-based Identity Provider (IdP) for the Tenant.

Example

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

Returns

object

---

updateJwtIntegrationByAppName

PUT /v2/manage/integrations/jwt/{jwtApp}

Update JWT Integration configuration

Updates an existing JWT-based integration configuration for the Tenant identified by the AppName, modifying details such as algorithms, mapping, or endpoint information.

Example

function callUpdateJwtIntegrationByAppName($client) {
    $jwtApp = '<jwtApp>'; //Required
    $jwtIntegrationBaseModel = new \LoginRadius\Sdk\Internal\OpenApi\Model\JwtIntegrationBaseModel(['algo' => '<algo>', 'secret' => '<secret>', 'mappingTemplate' => '<mappingTemplate>']); //Required

    try {
        $response = $client->jwtIntegrations->updateJwtIntegrationByAppName($jwtIntegrationBaseModel, jwtApp: $jwtApp);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
jwtApp	path	string	yes	The jwt App identifier

Request body

JwtIntegrationBaseModel as application/json.

Returns

JwtIntegrationResponse