User Schema

GetUserSchema

GET {{domain}}/api/v1/Schema/user

Gets the enforcement and validation schema for a user entity

Path Parameters

Name
Type
Description

clientId

string

Client Id of the application

{
  "message": "200",
  "data": {
    "clientId": "avitech",
    "entityName": "User",
    "schema": [
      {
        "attributeName": "FirstName",
        "isRequired": true,
        "isValidated": false,
        "datatype": "string"
      },
      {
        "attributeName": "IsActive",
        "isRequired": true,
        "isValidated": false,
        "datatype": "string"
      }
    ]
  }
}

CreateUserSchema

POST {{domain}}/api/v1/Schema/user

Creates the enforcement and validation schema for a user entity

Request Body

Name
Type
Description

object

{ "clientId": "string", "entityName": "string", "schema": [ "attributeName":"string", "isRequired": boolean, "isValidated": boolean, "dataType": "string" ] }

Last updated

Was this helpful?