User

Retrieve the user schema

Retrieves the user attribute schema for the tenant. This includes all fields configured in the admin console for the user schema.

get/blaize/schema/users

Request

  • Base URL: https://demo-site
  • URL: https://demo-site/blaize/schema/users
  • Auth: one of:
    • API key in cookie blaize_session
    • API key in query parameter jwt
    • API key in header x-blaize-jwt
    • API key in header x-zephr-jwt
    • HTTP bearer
    • API key in cookie blaize_jwt

Response

OK. Returns a list of schema fields.

tenantIdstring
subTenantIdstring
slugstring

The unique identifier for the schema field.

visibility'PUBLIC'

The visibility of the schema field. This is used to determine who can see the field. By default, all fields are PUBLIC. Those fields are visible to all users.

contextstring

The context of the schema field. It is used to group fields together into different contexts. By default, all fields are used in the null context.

labelstring
requiredboolean
internal-descriptionstring
public-descriptionstring
validation-expressionstring
input-type'text' | 'color' | 'number' | 'range' | 'time' | 'datetime-local' | 'date' | 'week' | 'month' | 'email' | 'tel' | 'url' | 'password' | 'select' | 'checkbox' | 'radio' | 'textarea' | 'hidden'
range-startnumber
range-endnumber
range-stepnumber
decision-pointboolean

The decision point of the schema field. It determines whether the field is used in the decision engine. If set to true, this field will be evaluated by the decision engine to influence the outcome of decisions. For example, a field marked as a decision point might be used to grant or deny access to a specific feature.

publicly-writableboolean
form-useboolean

Example response

[
  {
    "tenantId": "company",
    "subTenantId": "company|demo",
    "slug": "first-name",
    "visibility": "PUBLIC",
    "context": "ZUORA_BILLING",
    "label": "First Name",
    "required": true,
    "internal-description": "The first name of the user",
    "public-description": "The first name of the user",
    "validation-expression": "[a-z]+$",
    "input-type": "text",
    "range-end": 100,
    "range-step": 1,
    "decision-point": true,
    "publicly-writable": true
  }
]

Changes

No recorded changes to this operation across all 2 revisions of this API.