custom-fields.md

Custom Fields

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.

---

createCustomField

POST /v2/manage/custom-fields

Create custom field

Creates a new Custom Field for the Tenant.

Example

public static void callCreateCustomField(LoginRadiusClient client) {
  RaasCustomFieldModel raasCustomFieldModel = new RaasCustomFieldModel().customField("<customField>"); //Required

  try {
    var response = client.customFields.createCustomField(raasCustomFieldModel);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Request body

RaasCustomFieldModel as application/json.

Returns

RaasCustomField

---

deleteCustomField

DELETE /v2/manage/custom-fields/{cfname}

Delete custom field

Deletes a Custom Field by name for the Tenant.

Example

public static void callDeleteCustomField(LoginRadiusClient client) {
  String cfname = "<cfname>"; //Required

  try {
    var response = client.customFields.deleteCustomField(cfname);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name	In	Type	Required	Description
cfname	path	string	yes	Custom Fields Name

Returns

DeleteResponse

---

getActiveCustomFields

GET /v2/manage/custom-fields/active

List active custom fields

Retrieves all custom fields currently active in the registration form for the Tenant.

Example

public static void callGetActiveCustomFields(LoginRadiusClient client) {
  try {
    var response = client.customFields.getActiveCustomFields();
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Returns

object

---

getAllCustomFields

GET /v2/manage/custom-fields

List custom fields

Retrieves all Custom Fields created for the Tenant.

Example

public static void callGetAllCustomFields(LoginRadiusClient client) {
  try {
    var response = client.customFields.getAllCustomFields();
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Returns

object

---

getCustomFieldLimit

GET /v2/manage/custom-fields/limit

Retrieve custom field limit

Retrieves the Custom Field Limit configured for the Tenant.

Example

public static void callGetCustomFieldLimit(LoginRadiusClient client) {
  try {
    var response = client.customFields.getCustomFieldLimit();
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Returns

CustomFieldLimitResponse

---

listCustomFields

GET /v2/manage/custom-fields/list

List custom fields

Retrieves all custom fields for the Tenant, returned as an array of strings.

Example

public static void callListCustomFields(LoginRadiusClient client) {
  try {
    var response = client.customFields.listCustomFields();
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Returns

object

---

setCustomField

PUT /v2/manage/custom-fields

Set custom field

Updates or sets a Custom Field instance in RAAS to be displayed on forms for the Tenant.

Example

public static void callSetCustomField(LoginRadiusClient client) {
  SetCustomFieldRequest setCustomFieldRequest = new SetCustomFieldRequest().data("<data>"); //Required

  try {
    var response = client.customFields.setCustomField(setCustomFieldRequest);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Request body

object as application/json.

Returns

object