Documentation Index

Fetch the complete documentation index at: https://learn.servitly.com/llms.txt

Use this file to discover all available pages before exploring further.

Get the user property definitions

Prev Next
Get
/identity/userPropertyDefinitions

Returns the list of property definitions for user objects.
Each definition describes the name, label, value type and mandatory flag of a custom property, and corresponds to a field of the properties node of the User object.
Use this endpoint to discover which custom properties are configured on this tenant before reading or writing them.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the 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.0
mandatory
boolean

The flag indicating whether the property is mandatory.

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 exceeded.

object
message
string

The error response.

ExampleAPI call rate limit exceeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error