Retrieve the user schema

Public API reference

v4 API

Request

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

Security

CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie

cURL

curl -i -X GET \
  https://demo-site/blaize/schema/users \
  -b blaize_session=YOUR_API_KEY_HERE

Responses

OK. Returns a list of schema fields.

Headers

any

Bodyapplication/json

Array [

tenantIdstring

Example:"company"

subTenantIdstring

Example:"company|demo"

slugstring

The unique identifier for the schema field.

Example:"first-name"

visibilityany

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.

Value:"PUBLIC"

Example:"PUBLIC"

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.

Example:"ZUORA_BILLING"

labelstring

Example:"First Name"

requiredboolean

Example:true

internal-descriptionstring

Example:"The first name of the user"

public-descriptionstring

Example:"The first name of the user"

validation-expressionstring

Example:"[a-z]+$"

input-typeany

Enum:"text""color""number""range""time""datetime-local""date""week""month""email"

Example:"text"

select-optionsArray of objects

Example:"[ {key1: value1}, {key2: value2} ]"

range-startnumber

Example:0

range-endnumber

Example:100

range-stepnumber

Example:1

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.

Example:true

publicly-writableboolean

Example:true

form-useboolean

Example:false

]

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",
    "select-options": "[ {key1: value1}, {key2: value2} ]",
    "range-start": 0,
    "range-end": 100,
    "range-step": 1,
    "decision-point": true,
    "publicly-writable": true,
    "form-use": false
  }
]