Skip to content

Latest commit

 

History

History
222 lines (147 loc) · 7.03 KB

oauth-integrations.md

File metadata and controls

222 lines (147 loc) · 7.03 KB

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


createOAuthIntegration

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.

Example

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());
  }
}

Request body

object as application/json.

Returns

OAuthIntegrationResponse


deleteOAuthIntegration

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.

Example

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());
  }
}

Parameters

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

Returns

DeleteResponse


getAllOAuthIntegrations

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.

Example

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());
  }
}

Returns

object


getOAuthIntegrationById

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.

Example

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());
  }
}

Parameters

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

Returns

OAuthIntegrationResponse


rotateOAuthIntegrationCredentials

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.

Example

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());
  }
}

Parameters

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

Returns

OAuthIntegrationCredentialsResponse


updateOAuthIntegrationById

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.

Example

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());
  }
}

Parameters

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

Request body

OAuthIntegrationBaseModel as application/json.

Returns

OAuthIntegrationResponse