v1

latestOpenAPI 3.0.32026-07-24198357534.7 KB
User & Permission

Create a new User

Creates a User resource.

post/users

Request body

usernamestring
activeboolean
adminboolean
firstNamestring nullable
lastNamestring nullable
emailstring
timezonestring
isAutomaticTimezoneboolean nullable
decimalFormatstring
jobstring nullable
managerstring nullable
localesAvailableLocale[]

List of i18n locales for the application data

localeDefaultstring

Any locale

localeI18nDefault'fr-FR' | 'de-DE' | 'en-US' | 'es-ES' | 'it-IT' | 'nl-NL' | 'pl-PL' | 'ro-RO' | 'ru-RU' | 'zh-CN' | 'ja-JP'

Any language

permissionFeaturesstring[]
permissionFieldstring nullable
permissionCatalogstring nullable
dateDeactivationstring date-time nullable

This is an ISO datetime

passwordstring
typestring nullable

Example request

{
  "decimalFormat": "comma",
  "localesAvailable": [
    "fr_FR|en_US|..."
  ],
  "localeDefault": "fr_FR|en_US|...",
  "permissionFeatures": [
    "contributor",
    "validator",
    "..."
  ],
  "permissionField": "seo_enrichment",
  "permissionCatalog": "brand_quable",
  "type": "api|user"
}

Response

User resource created

idinteger
usernamestring
activeboolean
adminboolean
firstNamestring nullable
lastNamestring nullable
emailstring
timezonestring
isAutomaticTimezoneboolean
jobstring nullable
managerstring nullable
profilePicturestring nullable
localesAvailableLocale[]

List of i18n locales for the application data

localeDefaultstring

Any locale

localeI18nDefault'fr-FR' | 'de-DE' | 'en-US' | 'es-ES' | 'it-IT' | 'nl-NL' | 'pl-PL' | 'ro-RO' | 'ru-RU' | 'zh-CN' | 'ja-JP'

Any language

permissionFeaturesstring[]
permissionFieldstring nullable
permissionCatalogstring nullable
dateDeactivationstring date-time nullable

This is an ISO datetime

dateLoggedstring date-time nullable

This is an ISO datetime

dateCreatedstring date-time nullable

This is an ISO datetime

dateModifiedstring date-time nullable

This is an ISO datetime

decimalFormatstring
typestring

Example response

{
  "localesAvailable": [
    "fr_FR|en_US|..."
  ],
  "localeDefault": "fr_FR|en_US|...",
  "permissionFeatures": [
    "contributor",
    "validator",
    "..."
  ],
  "permissionField": "seo_enrichment",
  "permissionCatalog": "brand_quable",
  "type": "api|user"
}