Skip to content
Authrim

List registration-visible custom fields.

GET
/api/v1/registration-fields
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/v1/registration-fields

Returns custom claim schema definitions marked as visible on the registration screen for the resolved tenant.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Registration fields visible to the signup form.

Media type application/json
object
fields
required
Array<object>
object
id
string
name
string
display_name
string
data_type
string
required
boolean
key
additional properties
Example 
{
  "fields": [
    {
      "id": "claim_email",
      "name": "email",
      "display_name": "Email address",
      "data_type": "string",
      "required": true
    }
  ]
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}