List sign-up custom fields

GET

/options/authentication/signup/custom_fields

Retrieves a list of configured custom fields collected during user sign-up.

Authorization

API-Key

headerX-API-KEY<token>

MonoCloud APIs require authentication with an API key. Retrieve your key from the Tenant Settings section of the MonoCloud dashboard and include it in the request header as: X-API-Key: <your_api_key>

Response Body

200

application/json

The sign-up custom fields were retrieved successfully

TypeScript Definitions

Use the response body type in TypeScript.

Returns an array. Each item has the fields below.

Sign-up Custom Field Response: Represents the configuration of a custom field collected during user sign-up.

enabled*boolean

Specifies whether this custom field is enabled and shown during sign-up.

required*boolean

Specifies whether this custom field is mandatory during sign-up.

claim_name*string

The claim name under which the value will be stored.

value_type*ValueTypes

The data type of the claim value.

values

string
A plain text value.
email
An email address value.
phone
A phone number value.

label*string

The user-facing label displayed for this field during sign-up.

Errors

401Unauthorized

403Forbidden

404Not Found

curl -X GET "https://your-domain.us.monocloud.com/api/options/authentication/signup/custom_fields" \  -H "X-API-KEY: <token>"

[  {    "enabled": true,    "required": true,    "claim_name": "string",    "value_type": "string",    "label": "string"  }]

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

ErrorsCopy Anchor Link

422Unprocessable Entity

Authorization

Response Body

Errors