Skip to content

custom-objects.md

Latest commit

 

History

History
177 lines (121 loc) · 5.56 KB

custom-objects.md

File metadata and controls

177 lines (121 loc) · 5.56 KB
Raw

Custom Objects

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

getAllCustomObjectsByQuery

GET /customobject

Retrieve Custom Object data by pagination

Retrieves Custom Object data based on specified pagination parameters.

Example

public static void callGetAllCustomObjectsByQuery(LoginRadiusClient client) {
  String customobject = "<customobject>"; //Optional
  String region = "<region>"; //Optional
  String next = "<next>"; //Optional

  try {
    var response = client.customObjects.getAllCustomObjectsByQuery(customobject, region, next);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
customobject query string no Custom Object identifier for filtering results. This parameter allows you to specify a Custom Object to filter the results returned by the API.
region query string no The region to filter results by.
next query string no Scroll or pagination token for fetching the next set of results. This token is used to retrieve the next page of results in a paginated response. If not provided, the API will return the first page of results.

Returns

UserProfileNextResponse

getCustomObjectByQuery

GET /identity/customobject

Retrieve User's and Custom Object data by pagination

Retrieves User's and Custom Object data per User based on the pagination parameters.

Example

public static void callGetCustomObjectByQuery(LoginRadiusClient client) {
  String region = "<region>"; //Optional
  String customobject = "<customobject>"; //Optional
  String next = "<next>"; //Optional

  try {
    var response = client.customObjects.getCustomObjectByQuery(region, customobject, next);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
region query string no The region to filter results by.
customobject query string no Custom Object identifier for filtering results. This parameter allows you to specify a Custom Object to filter the results returned by the API.
next query string no Scroll or pagination token for fetching the next set of results. This token is used to retrieve the next page of results in a paginated response. If not provided, the API will return the first page of results.

Returns

userProfileNextResponseWithCustomObject

postAllCustomObjectsByQuery

POST /customobject

Retrieve Custom Object data by query

Retrieves Custom Object data based on specified query filters.

Example

public static void callPostAllCustomObjectsByQuery(LoginRadiusClient client) {
  UserProfileRequestBody userProfileRequestBody = new UserProfileRequestBody().from("<from>").to("<to>").size(0); //Required
  String customobject = "<customobject>"; //Optional
  String region = "<region>"; //Optional

  try {
    var response = client.customObjects.postAllCustomObjectsByQuery(userProfileRequestBody, customobject, region);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
customobject query string no Custom Object identifier for filtering results. This parameter allows you to specify a Custom Object to filter the results returned by the API.
region query string no The region to filter results by.

Request body

UserProfileRequestBody as application/json.

Returns

UserProfileScrollResponse

postCustomObjectByQuery

POST /identity/customobject

Retrieve User's and Custom Object data by query

Retrieves User's and Custom Objects data per User based on the query.

Example

public static void callPostCustomObjectByQuery(LoginRadiusClient client) {
  UserProfileRequestBody userProfileRequestBody = new UserProfileRequestBody().from("<from>").to("<to>").size(0); //Required
  String region = "<region>"; //Optional
  String customobject = "<customobject>"; //Optional

  try {
    var response = client.customObjects.postCustomObjectByQuery(userProfileRequestBody, region, customobject);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
region query string no The region to filter results by.
customobject query string no Custom Object identifier for filtering results. This parameter allows you to specify a Custom Object to filter the results returned by the API.

Request body

UserProfileRequestBody as application/json.

Returns

userProfileScrollResponseWithCustomObject