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.
POST /v2/manage/integrations/oauth
Create OAuth Integration
Creates a new OAuth/OIDC integration configuration for the Tenant. The response returns the integration's identifier (Id), which is also the {oAuthApp} segment of the runtime OAuth/OIDC endpoints. Only the authorization_code and refresh_token grant types are permitted.
public static void callCreateOAuthIntegration(LoginRadiusClient client) {
CreateOAuthIntegrationRequest createOAuthIntegrationRequest = new CreateOAuthIntegrationRequest().displayName("<displayName>").redirectURIs("<redirectURIs>").grantTypes("<grantTypes>"); //Required
try {
var response = client.oauthIntegrations.createOAuthIntegration(createOAuthIntegrationRequest);
System.out.println(response);
} catch (ApiException e) {
LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
System.err.println(lr.description());
}
}object as application/json.
OAuthIntegrationResponse
DELETE /v2/manage/integrations/oauth/{integrationId}
Delete OAuth Integration configuration
Deletes an existing OAuth/OIDC integration configuration for the Tenant using its Id, permanently removing it.
public static void callDeleteOAuthIntegration(LoginRadiusClient client) {
String integrationId = "<integrationId>"; //Required
try {
var response = client.oauthIntegrations.deleteOAuthIntegration(integrationId);
System.out.println(response);
} catch (ApiException e) {
LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
System.err.println(lr.description());
}
}| Name | In | Type | Required | Description |
|---|---|---|---|---|
integrationId |
path | string | yes | The OAuth integration identifier. It is the integration's OAuth application name, so the same value is the {oAuthApp} path segment of the runtime OAuth/OIDC endpoints (e.g. /api/oidc/{integrationId}/token). |
DeleteResponse
GET /v2/manage/integrations/oauth
List OAuth Integrations
Retrieves a list of all configured OAuth/OIDC integrations for the Tenant, including redirect URIs, allowed scopes, grant types, claim mappings, and token settings.
public static void callGetAllOAuthIntegrations(LoginRadiusClient client) {
try {
var response = client.oauthIntegrations.getAllOAuthIntegrations();
System.out.println(response);
} catch (ApiException e) {
LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
System.err.println(lr.description());
}
}object
GET /v2/manage/integrations/oauth/{integrationId}
Retrieve OAuth Integration configuration
Retrieves the details of a specific OAuth/OIDC integration configuration for the Tenant using its Id, including redirect URIs, scopes, grant types, claim mappings, and token settings.
public static void callGetOAuthIntegrationById(LoginRadiusClient client) {
String integrationId = "<integrationId>"; //Required
try {
var response = client.oauthIntegrations.getOAuthIntegrationById(integrationId);
System.out.println(response);
} catch (ApiException e) {
LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
System.err.println(lr.description());
}
}| Name | In | Type | Required | Description |
|---|---|---|---|---|
integrationId |
path | string | yes | The OAuth integration identifier. It is the integration's OAuth application name, so the same value is the {oAuthApp} path segment of the runtime OAuth/OIDC endpoints (e.g. /api/oidc/{integrationId}/token). |
OAuthIntegrationResponse
PUT /v2/manage/integrations/oauth/{integrationId}/credentials
Rotate OAuth Integration client secret
Regenerates the client secret for an existing OAuth/OIDC integration identified by its Id. The ClientId and Id are unchanged; only the secret is rotated. The new plaintext ClientSecret is returned once in this response, and only its hash is persisted server-side.
public static void callRotateOAuthIntegrationCredentials(LoginRadiusClient client) {
String integrationId = "<integrationId>"; //Required
try {
var response = client.oauthIntegrations.rotateOAuthIntegrationCredentials(integrationId);
System.out.println(response);
} catch (ApiException e) {
LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
System.err.println(lr.description());
}
}| Name | In | Type | Required | Description |
|---|---|---|---|---|
integrationId |
path | string | yes | The OAuth integration identifier. It is the integration's OAuth application name, so the same value is the {oAuthApp} path segment of the runtime OAuth/OIDC endpoints (e.g. /api/oidc/{integrationId}/token). |
OAuthIntegrationCredentialsResponse
PUT /v2/manage/integrations/oauth/{integrationId}
Update OAuth Integration configuration
Updates an existing OAuth/OIDC integration configuration for the Tenant identified by its Id. Id and DisplayName are immutable; only configuration fields are updated. Omitting a field leaves its stored value unchanged, as does a token lifetime of 0; passing an explicit empty AllowedScopes array removes all scopes from the integration.
public static void callUpdateOAuthIntegrationById(LoginRadiusClient client) {
String integrationId = "<integrationId>"; //Required
OAuthIntegrationBaseModel oauthIntegrationBaseModel = new OAuthIntegrationBaseModel().redirectURIs("<redirectURIs>").allowedScopes("<allowedScopes>").grantTypes("<grantTypes>"); //Required
try {
var response = client.oauthIntegrations.updateOAuthIntegrationById(integrationId, oauthIntegrationBaseModel);
System.out.println(response);
} catch (ApiException e) {
LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
System.err.println(lr.description());
}
}| Name | In | Type | Required | Description |
|---|---|---|---|---|
integrationId |
path | string | yes | The OAuth integration identifier. It is the integration's OAuth application name, so the same value is the {oAuthApp} path segment of the runtime OAuth/OIDC endpoints (e.g. /api/oidc/{integrationId}/token). |
OAuthIntegrationBaseModel as application/json.
OAuthIntegrationResponse