Get
/identity/userPropertyDefinitions
Returns the list of property definitions for user objects.
Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired
The name of the target tenant (e.g. acme).
Responses
200
Successful operation.
Array of object
object
The definition of a property of an object.
name
string
The name of the property used as field in the "properties" node.
Exampletank_size
label
string
The label of the property.
ExampleTank Size
type
string
The property value type.
Valid values[
"ADDRESS",
"BOOLEAN",
"CITY",
"CONTACTS",
"DATE",
"DOUBLE",
"EMAIL",
"FILE",
"FISCAL_CODE",
"FLOAT",
"INTEGER",
"LONG",
"MOBILE_NUMBER",
"PHONE_NUMBER",
"STATE",
"STREET_NUMBER",
"STRING",
"ZIP_CODE"
]
Minimum1
mandatory
boolean
The flag indicating whether the property cannot be left empty.
401
User not authenticated.
object
message
string
The error response.
ExampleUser not authenticated
403
User not authorized.
object
message
string
The error response.
ExampleUser not authorized
404
Resource was not found.
object
message
string
The error response.
ExampleResource not found
429
API call rate limit exeeded.
object
message
string
The error response.
ExampleAPI call rate limit exeeded
500
Internal server error.
object
message
string
The error response.
ExampleInternal Server Error