custom-objects.md

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

async function callGetAllCustomObjectsByQuery(client: LoginRadius) {
  const customobject: string = '<customobject>'; //Optional
  const region: string = '<region>'; //Optional
  const next: string = '<next>'; //Optional

  try {
    const res = await client.<service>.getAllCustomObjectsByQuery({ customobject, region, next });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

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

async function callGetCustomObjectByQuery(client: LoginRadius) {
  const region: string = '<region>'; //Optional
  const customobject: string = '<customobject>'; //Optional
  const next: string = '<next>'; //Optional

  try {
    const res = await client.<service>.getCustomObjectByQuery({ region, customobject, next });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

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

async function callPostAllCustomObjectsByQuery(client: LoginRadius) {
  const userProfileRequestBody = {  }; //Required
  const customobject: string = '<customobject>'; //Optional
  const region: string = '<region>'; //Optional

  try {
    const res = await client.<service>.postAllCustomObjectsByQuery({ userProfileRequestBody, customobject, region });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

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

async function callPostCustomObjectByQuery(client: LoginRadius) {
  const userProfileRequestBody = {  }; //Required
  const region: string = '<region>'; //Optional
  const customobject: string = '<customobject>'; //Optional

  try {
    const res = await client.<service>.postCustomObjectByQuery({ userProfileRequestBody, region, customobject });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

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