JSON Scheme

emailuserdetails


    {
      "jabber": jabber /* from coreuserdetails */, 
      "password": password /* from coreuserdetails */, 
      "originService": service /* from coreuserdetails */, 
      "passwordChangeRequired": boolean /* from coreuserdetails */, 
      "id": string /* from details */, 
      "aliasIds": [string, ...] /* from details */, 
      "aliases": [alias, ...] /* from details */, 
      "email": email /* from details */, 
      "authModule": authmodule /* from details */, 
      "authModuleName": string /* from details */, 
      "user": user /* from details */, 
      "lastAccessTime": calendar /* from details */, 
      "lastAccessAddress": string /* from details */, 
      "lastAccessUserAgent": string /* from details */
    }

loginuserdetails

extends coreuserdetails


    {
      "login": string, 
      "jabber": jabber /* from coreuserdetails */, 
      "password": password /* from coreuserdetails */, 
      "originService": service /* from coreuserdetails */, 
      "passwordChangeRequired": boolean /* from coreuserdetails */, 
      "id": string /* from details */, 
      "aliasIds": [string, ...] /* from details */, 
      "aliases": [alias, ...] /* from details */, 
      "email": email /* from details */, 
      "authModule": authmodule /* from details */, 
      "authModuleName": string /* from details */, 
      "user": user /* from details */, 
      "lastAccessTime": calendar /* from details */, 
      "lastAccessAddress": string /* from details */, 
      "lastAccessUserAgent": string /* from details */
    }

password

extended by plainpassword, shapassword, md5password

    {
      "oldValue": string
    }
  

plainpassword

extends password

    {
      "value": string, 
      "oldValue": string /* from password */
    }
  

shapassword

extends password

    {
      "hashedValue": string, 
      "oldValue": string /* from password */
    }
  

coreuserdetails

extends details

extended by emailuserdetails, loginuserdetails


    {
      "jabber": jabber, 
      "password": password, 
      "originService": service, 
      "passwordChangeRequired": boolean, 
      "id": string /* from details */, 
      "aliasIds": [string, ...] /* from details */, 
      "aliases": [alias, ...] /* from details */, 
      "email": email /* from details */, 
      "authModule": authmodule /* from details */, 
      "authModuleName": string /* from details */, 
      "user": user /* from details */, 
      "lastAccessTime": calendar /* from details */, 
      "lastAccessAddress": string /* from details */, 
      "lastAccessUserAgent": string /* from details */
    }

coreauthmodule

extends authmodule


    {
      "registrationEnabled": boolean, 
      "passwordRestoreEnabled": boolean, 
      "captchaEnabled": boolean, 
      "captchaPublicKey": string, 
      "captchaPrivateKey": string, 
      "passwordStrengthPolicy": int, 
      "loginThrottlingSettings": throttlingSettings, 
      "addCredentialsThrottlingSettings": throttlingSettings, 
      "id": string /* from authmodule */, 
      "aliasIds": [string, ...] /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "url": string /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
    }

md5password

extends password

    {
      "hashedValue": string, 
      "salt": string, 
      "oldValue": string /* from password */
    }
  

throttlingSettings

    {
      "enabled": boolean, 
      "ratePeriod": long, 
      "ratePermits": int, 
      "timeout": long
    }
  

githubauthmodule

extends externaloauth2module


    {
      "scope": string, 
      "clientId": string /* from externaloauth2module */, 
      "clientSecret": string /* from externaloauth2module */, 
      "redirectUri": string /* from externaloauth2module */, 
      "iconUrl": string /* from externaloauth2module */, 
      "serverUrl": string /* from externalauthmodule */, 
      "connectionTimeout": int /* from externalauthmodule */, 
      "readTimeout": int /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from externalauthmodule */, 
      "keyStore": keyStore /* from externalauthmodule */, 
      "id": string /* from authmodule */, 
      "aliasIds": [string, ...] /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "url": string /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
    }

githubdetails

extends details


    {
      "login": string, 
      "fullName": string, 
      "avatar": string, 
      "id": string /* from details */, 
      "aliasIds": [string, ...] /* from details */, 
      "aliases": [alias, ...] /* from details */, 
      "email": email /* from details */, 
      "authModule": authmodule /* from details */, 
      "authModuleName": string /* from details */, 
      "user": user /* from details */, 
      "lastAccessTime": calendar /* from details */, 
      "lastAccessAddress": string /* from details */, 
      "lastAccessUserAgent": string /* from details */
    }

googleauthmodule

extends externaloauth2module


    {
      "newUserRestrictDomain": string, 
      "clientId": string /* from externaloauth2module */, 
      "clientSecret": string /* from externaloauth2module */, 
      "redirectUri": string /* from externaloauth2module */, 
      "iconUrl": string /* from externaloauth2module */, 
      "serverUrl": string /* from externalauthmodule */, 
      "connectionTimeout": int /* from externalauthmodule */, 
      "readTimeout": int /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from externalauthmodule */, 
      "keyStore": keyStore /* from externalauthmodule */, 
      "id": string /* from authmodule */, 
      "aliasIds": [string, ...] /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "url": string /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
    }

googledetails

extends details


    {
      "identifier": string, 
      "fullName": string, 
      "avatar": string, 
      "id": string /* from details */, 
      "aliasIds": [string, ...] /* from details */, 
      "aliases": [alias, ...] /* from details */, 
      "email": email /* from details */, 
      "authModule": authmodule /* from details */, 
      "authModuleName": string /* from details */, 
      "user": user /* from details */, 
      "lastAccessTime": calendar /* from details */, 
      "lastAccessAddress": string /* from details */, 
      "lastAccessUserAgent": string /* from details */
    }

jbadetails

extends details


    {
      "login": string, 
      "fullName": string, 
      "changePasswordUrl": string, 
      "id": string /* from details */, 
      "aliasIds": [string, ...] /* from details */, 
      "aliases": [alias, ...] /* from details */, 
      "email": email /* from details */, 
      "authModule": authmodule /* from details */, 
      "authModuleName": string /* from details */, 
      "user": user /* from details */, 
      "lastAccessTime": calendar /* from details */, 
      "lastAccessAddress": string /* from details */, 
      "lastAccessUserAgent": string /* from details */
    }

jbaauthmodule

extends externalpasswordauthmodule


    {
      "registrationEnabled": boolean, 
      "allowedToSavePassword": boolean /* from externalpasswordauthmodule */, 
      "changePasswordUri": string /* from externalpasswordauthmodule */, 
      "serverUrl": string /* from externalauthmodule */, 
      "connectionTimeout": int /* from externalauthmodule */, 
      "readTimeout": int /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from externalauthmodule */, 
      "keyStore": keyStore /* from externalauthmodule */, 
      "id": string /* from authmodule */, 
      "aliasIds": [string, ...] /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "url": string /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
    }

jiradetails

extends details


    {
      "login": string, 
      "fullName": string, 
      "changePasswordUrl": string, 
      "id": string /* from details */, 
      "aliasIds": [string, ...] /* from details */, 
      "aliases": [alias, ...] /* from details */, 
      "email": email /* from details */, 
      "authModule": authmodule /* from details */, 
      "authModuleName": string /* from details */, 
      "user": user /* from details */, 
      "lastAccessTime": calendar /* from details */, 
      "lastAccessAddress": string /* from details */, 
      "lastAccessUserAgent": string /* from details */
    }

jiraauthmodule

extends externalpasswordauthmodule


    {
      "allowedToSavePassword": boolean /* from externalpasswordauthmodule */, 
      "changePasswordUri": string /* from externalpasswordauthmodule */, 
      "serverUrl": string /* from externalauthmodule */, 
      "connectionTimeout": int /* from externalauthmodule */, 
      "readTimeout": int /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from externalauthmodule */, 
      "keyStore": keyStore /* from externalauthmodule */, 
      "id": string /* from authmodule */, 
      "aliasIds": [string, ...] /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "url": string /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
    }

ldapdetails

extends details


    {
      "userid": string, 
      "fullName": string, 
      "changePasswordUrl": string, 
      "jabber": jabber, 
      "VCSName": string, 
      "id": string /* from details */, 
      "aliasIds": [string, ...] /* from details */, 
      "aliases": [alias, ...] /* from details */, 
      "email": email /* from details */, 
      "authModule": authmodule /* from details */, 
      "authModuleName": string /* from details */, 
      "user": user /* from details */, 
      "lastAccessTime": calendar /* from details */, 
      "lastAccessAddress": string /* from details */, 
      "lastAccessUserAgent": string /* from details */
    }

ldapauthmodule

extends externalpasswordauthmodule


    {
      "filter": string, 
      "formatDN": string, 
      "emailAttributeName": string, 
      "fullNameAttributeName": string, 
      "jabberAttributeName": string, 
      "userIdAttributeName": string, 
      "VCSNameAttributeName": string, 
      "bindUserLogin": string, 
      "bindUserPassword": string, 
      "useBindUser": boolean, 
      "allowedToSavePassword": boolean /* from externalpasswordauthmodule */, 
      "changePasswordUri": string /* from externalpasswordauthmodule */, 
      "serverUrl": string /* from externalauthmodule */, 
      "connectionTimeout": int /* from externalauthmodule */, 
      "readTimeout": int /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from externalauthmodule */, 
      "keyStore": keyStore /* from externalauthmodule */, 
      "id": string /* from authmodule */, 
      "aliasIds": [string, ...] /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "url": string /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
    }

oauth2authmodule

extends externaloauth2module


    {
      "scope": string, 
      "tokenUrl": string, 
      "formClientAuth": boolean, 
      "userInfoUrl": string, 
      "userIdPath": string, 
      "userEmailPath": string, 
      "userEmailVerifiedPath": string, 
      "userNamePath": string, 
      "userPictureIdPath": string, 
      "userPictureUrlPattern": string, 
      "clientId": string /* from externaloauth2module */, 
      "clientSecret": string /* from externaloauth2module */, 
      "redirectUri": string /* from externaloauth2module */, 
      "iconUrl": string /* from externaloauth2module */, 
      "serverUrl": string /* from externalauthmodule */, 
      "connectionTimeout": int /* from externalauthmodule */, 
      "readTimeout": int /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from externalauthmodule */, 
      "keyStore": keyStore /* from externalauthmodule */, 
      "id": string /* from authmodule */, 
      "aliasIds": [string, ...] /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "url": string /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
    }

oauth2details

extends details


    {
      "identifier": string, 
      "fullName": string, 
      "avatar": string, 
      "id": string /* from details */, 
      "aliasIds": [string, ...] /* from details */, 
      "aliases": [alias, ...] /* from details */, 
      "email": email /* from details */, 
      "authModule": authmodule /* from details */, 
      "authModuleName": string /* from details */, 
      "user": user /* from details */, 
      "lastAccessTime": calendar /* from details */, 
      "lastAccessAddress": string /* from details */, 
      "lastAccessUserAgent": string /* from details */
    }

openiddetails

extends details


    {
      "identifier": string, 
      "fullName": string, 
      "avatar": string, 
      "id": string /* from details */, 
      "aliasIds": [string, ...] /* from details */, 
      "aliases": [alias, ...] /* from details */, 
      "email": email /* from details */, 
      "authModule": authmodule /* from details */, 
      "authModuleName": string /* from details */, 
      "user": user /* from details */, 
      "lastAccessTime": calendar /* from details */, 
      "lastAccessAddress": string /* from details */, 
      "lastAccessUserAgent": string /* from details */
    }

openidauthmodule

extends externalauthmodule


    {
      "emailSchema": string, 
      "firstNameSchema": string, 
      "lastNameSchema": string, 
      "fullNameSchema": string, 
      "avatarSchema": string, 
      "urlPattern": string, 
      "iconUrl": string, 
      "serverUrl": string /* from externalauthmodule */, 
      "connectionTimeout": int /* from externalauthmodule */, 
      "readTimeout": int /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from externalauthmodule */, 
      "keyStore": keyStore /* from externalauthmodule */, 
      "id": string /* from authmodule */, 
      "aliasIds": [string, ...] /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "url": string /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
    }

externalauthmodule

extends authmodule

extended by githubauthmodule, googleauthmodule, jbaauthmodule, jiraauthmodule, ldapauthmodule, oauth2authmodule, openidauthmodule, externalpasswordauthmodule, externaloauth2module


    {
      "serverUrl": string, 
      "connectionTimeout": int, 
      "readTimeout": int, 
      "allowedCreateNewUsers": boolean, 
      "keyStore": keyStore, 
      "id": string /* from authmodule */, 
      "aliasIds": [string, ...] /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "url": string /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
    }

externalpasswordauthmodule

extends externalauthmodule

extended by jbaauthmodule, jiraauthmodule, ldapauthmodule


    {
      "allowedToSavePassword": boolean, 
      "changePasswordUri": string, 
      "serverUrl": string /* from externalauthmodule */, 
      "connectionTimeout": int /* from externalauthmodule */, 
      "readTimeout": int /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from externalauthmodule */, 
      "keyStore": keyStore /* from externalauthmodule */, 
      "id": string /* from authmodule */, 
      "aliasIds": [string, ...] /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "url": string /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
    }

externaloauth2module

extends externalauthmodule

extended by githubauthmodule, googleauthmodule, oauth2authmodule


    {
      "clientId": string, 
      "clientSecret": string, 
      "redirectUri": string, 
      "iconUrl": string, 
      "serverUrl": string /* from externalauthmodule */, 
      "connectionTimeout": int /* from externalauthmodule */, 
      "readTimeout": int /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from externalauthmodule */, 
      "keyStore": keyStore /* from externalauthmodule */, 
      "id": string /* from authmodule */, 
      "aliasIds": [string, ...] /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "url": string /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
    }

conflict


    {
      "id": string, 
      "type": string, 
      "local": info, 
      "remote": info, 
      "resolution": resolution, 
      "matches": info
    }

counters

    {
      "users": int, 
      "groups": int, 
      "roles": int, 
      "projects": int, 
      "services": int, 
      "authModules": int
    }
  

import


    {
      "id": string, 
      "adminConsoleUrl": string, 
      "remoteUrl": string, 
      "localUrl": string, 
      "phase": importPhase, 
      "conflicts": [conflict, ...]
    }

importPhase

    {
      "name": string, 
      "progress": int, 
      "message": string
    }
  

info

    {
      "id": string, 
      "name": string, 
      "login": string, 
      "key": string, 
      "url": string, 
      "email": string, 
      "jabber": string, 
      "banned": boolean
    }
  

resolution


    {
      "type": string, 
      "propertyOverrides": info
    }

service

extends authorityHolder


    {
      "key": string, 
      "homeUrl": string, 
      "baseUrls": [string, ...], 
      "userUriPattern": string, 
      "groupUriPattern": string, 
      "redirectUris": [string, ...], 
      "untrustedRedirectUris": [untrustedRedirectURI, ...], 
      "applicationName": string, 
      "vendor": string, 
      "releaseDate": calendar, 
      "version": string, 
      "iconUrl": string, 
      "resources": [resource, ...], 
      "permissions": [permission, ...], 
      "defaultRoles": [role, ...], 
      "headerVisibleGroups": [userGroup, ...], 
      "licenseSettings": license, 
      "apis": [serviceAPI, ...], 
      "trusted": boolean, 
      "secret": string, 
      "id": string /* from authorityHolder */, 
      "aliasIds": [string, ...] /* from authorityHolder */, 
      "aliases": [alias, ...] /* from authorityHolder */, 
      "name": string /* from authorityHolder */, 
      "projectRoles": [projectRole, ...] /* from authorityHolder */, 
      "transitiveProjectRoles": [projectRole, ...] /* from authorityHolder */
    }

user

extends authorityHolder


    {
      "login": string, 
      "banned": boolean, 
      "banReason": string, 
      "guest": boolean, 
      "avatar": avatar, 
      "profile": profile, 
      "contacts": [contact, ...], 
      "groups": [userGroup, ...], 
      "details": [details, ...], 
      "VCSUserNames": [vcsUserName, ...], 
      "sshPublicKeys": [sshPublicKey, ...], 
      "licenses": [license, ...], 
      "creationTime": calendar, 
      "lastAccessTime": calendar, 
      "refreshTokens": [refreshToken, ...], 
      "permanentTokens": [permanentToken, ...], 
      "approvedScopes": [approvedScope, ...], 
      "favoriteProjects": [project, ...], 
      "id": string /* from authorityHolder */, 
      "aliasIds": [string, ...] /* from authorityHolder */, 
      "aliases": [alias, ...] /* from authorityHolder */, 
      "name": string /* from authorityHolder */, 
      "projectRoles": [projectRole, ...] /* from authorityHolder */, 
      "transitiveProjectRoles": [projectRole, ...] /* from authorityHolder */
    }

userGroup

extends authorityHolder


    {
      "description": string, 
      "iconUrl": string, 
      "autoJoin": boolean, 
      "users": [user, ...], 
      "ownUsers": [user, ...], 
      "userCount": int, 
      "parent": userGroup, 
      "subgroups": [userGroup, ...], 
      "project": project, 
      "allUsers": boolean, 
      "implicit": boolean, 
      "queriedSingleton": boolean, 
      "id": string /* from authorityHolder */, 
      "aliasIds": [string, ...] /* from authorityHolder */, 
      "aliases": [alias, ...] /* from authorityHolder */, 
      "name": string /* from authorityHolder */, 
      "projectRoles": [projectRole, ...] /* from authorityHolder */, 
      "transitiveProjectRoles": [projectRole, ...] /* from authorityHolder */
    }

avatar

extended by gravatar, urlavatar, defaultavatar

    {
      "url": string, 
      "pictureUrl": string
    }
  

contact

extended by email, jabber

    {
      "verified": boolean
    }
  

permission


    {
      "id": string, 
      "aliasIds": [string, ...], 
      "aliases": [alias, ...], 
      "key": string, 
      "name": string, 
      "service": service, 
      "description": string, 
      "global": boolean, 
      "entityType": string, 
      "operation": string
    }

role


    {
      "id": string, 
      "aliasIds": [string, ...], 
      "aliases": [alias, ...], 
      "url": string, 
      "key": string, 
      "name": string, 
      "description": string, 
      "teamRole": boolean, 
      "permissions": [permission, ...]
    }

resource


    {
      "id": string, 
      "aliasIds": [string, ...], 
      "aliases": [alias, ...], 
      "key": string, 
      "name": string, 
      "homeUrl": string, 
      "type": string, 
      "service": service, 
      "project": project
    }

email

extends contact

    {
      "email": string, 
      "verified": boolean /* from contact */
    }
  

jabber

extends contact

    {
      "jabber": string, 
      "verified": boolean /* from contact */
    }
  

details

extended by emailuserdetails, loginuserdetails, coreuserdetails, githubdetails, googledetails, jbadetails, jiradetails, ldapdetails, oauth2details, openiddetails


    {
      "id": string, 
      "aliasIds": [string, ...], 
      "aliases": [alias, ...], 
      "email": email, 
      "authModule": authmodule, 
      "authModuleName": string, 
      "user": user, 
      "lastAccessTime": calendar, 
      "lastAccessAddress": string, 
      "lastAccessUserAgent": string
    }

serviceAPI


    {
      "id": string, 
      "aliasIds": [string, ...], 
      "aliases": [alias, ...], 
      "name": string, 
      "type": string, 
      "description": string
    }

queryAssist


    {
      "query": string, 
      "caret": int, 
      "styleRanges": [queryStyleRange, ...], 
      "suggestions": [querySuggestItem, ...]
    }

queryStyleRange

    {
      "start": int, 
      "length": int, 
      "style": string, 
      "title": string
    }
  

querySuggestItem

    {
      "prefix": string, 
      "option": string, 
      "suffix": string, 
      "description": string, 
      "matchingStart": int, 
      "matchingEnd": int, 
      "caret": int, 
      "completionStart": int, 
      "completionEnd": int, 
      "group": string, 
      "icon": string
    }
  

event


    {
      "id": string, 
      "aliasIds": [string, ...], 
      "aliases": [alias, ...], 
      "targetId": string, 
      "targetType": string, 
      "targetPresentation": string, 
      "author": string, 
      "authorPresentation": string, 
      "authorType": string, 
      "changes": [change, ...], 
      "type": string, 
      "timestamp": calendar
    }

primitiveChange

extends change

    {
      "oldValue": string, 
      "newValue": string, 
      "fieldName": string /* from change */, 
      "fieldType": string /* from change */
    }
  

linkChange

extends change


    {
      "removedItems": [string, ...], 
      "removed": [linkData, ...], 
      "addedItems": [string, ...], 
      "added": [linkData, ...], 
      "fieldName": string /* from change */, 
      "fieldType": string /* from change */
    }

change

extended by primitiveChange, linkChange, aggregationChange

    {
      "fieldName": string, 
      "fieldType": string
    }
  

aggregationChange

extends change


    {
      "childChanges": [change, ...], 
      "fieldName": string /* from change */, 
      "fieldType": string /* from change */
    }

error

    {
      "error": string, 
      "error_code": int, 
      "error_description": string, 
      "error_developer_message": string, 
      "error_uri": string, 
      "error_field": string
    }
  

authmodule

extended by coreauthmodule, githubauthmodule, googleauthmodule, jbaauthmodule, jiraauthmodule, ldapauthmodule, oauth2authmodule, openidauthmodule, externalauthmodule, externalpasswordauthmodule, externaloauth2module


    {
      "id": string, 
      "aliasIds": [string, ...], 
      "aliases": [alias, ...], 
      "url": string, 
      "name": string, 
      "ordinal": int, 
      "accountsSize": int, 
      "disabled": boolean, 
      "autoJoinGroups": [userGroup, ...]
    }

credentials

    {
      "username": string, 
      "password": string
    }
  

cachedPermission


    {
      "permission": permission, 
      "global": boolean, 
      "projects": [project, ...], 
      "resources": [resource, ...]
    }

profile


    {
      "avatar": avatar, 
      "email": email, 
      "jabber": jabber
    }

gravatar

extends avatar

    {
      "email": string, 
      "url": string /* from avatar */, 
      "pictureUrl": string /* from avatar */
    }
  

urlavatar

extends avatar

    {
      "avatarUrl": string, 
      "url": string /* from avatar */, 
      "pictureUrl": string /* from avatar */
    }
  

defaultavatar

extends avatar

    {
      "url": string /* from avatar */, 
      "pictureUrl": string /* from avatar */
    }
  

vcsUserName

    {
      "name": string
    }
  

settings

extended by license, publicSettings, smtpSettings, jabberSettings, backupSettings, importSettings, internalSettings


    {
      "id": string, 
      "aliasIds": [string, ...], 
      "aliases": [alias, ...]
    }

license

extends settings


    {
      "licenseKey": string, 
      "licenseName": string, 
      "service": service, 
      "users": [user, ...], 
      "autoJoinGroups": [userGroup, ...], 
      "licenseInfo": licenseInfo, 
      "id": string /* from settings */, 
      "aliasIds": [string, ...] /* from settings */, 
      "aliases": [alias, ...] /* from settings */
    }

publicSettings

extends settings


    {
      "locale": locale, 
      "hubMottoHidden": boolean, 
      "companyLogo": string, 
      "systemMessage": string, 
      "id": string /* from settings */, 
      "aliasIds": [string, ...] /* from settings */, 
      "aliases": [alias, ...] /* from settings */
    }

licenseInfo

    {
      "product": int, 
      "licenseType": int, 
      "majorVersion": int, 
      "minorVersion": int, 
      "buildNumber": int, 
      "userCount": int, 
      "expirationDate": calendar, 
      "freeUpdateEnd": calendar, 
      "hosted": boolean, 
      "changeYouTrackLogoForbidden": boolean, 
      "guestBanForbidden": boolean, 
      "invalidityReason": string
    }
  

smtpSettings

extends settings


    {
      "enabled": boolean, 
      "host": string, 
      "port": int, 
      "protocol": string, 
      "from": string, 
      "login": string, 
      "password": string, 
      "passwordDefined": boolean, 
      "keyStore": keyStore, 
      "id": string /* from settings */, 
      "aliasIds": [string, ...] /* from settings */, 
      "aliases": [alias, ...] /* from settings */
    }

jabberSettings

extends settings


    {
      "enabled": boolean, 
      "host": string, 
      "port": int, 
      "serviceName": string, 
      "SASLEnabled": boolean, 
      "login": string, 
      "password": string, 
      "passwordDefined": boolean, 
      "id": string /* from settings */, 
      "aliasIds": [string, ...] /* from settings */, 
      "aliases": [alias, ...] /* from settings */
    }

certificate


    {
      "id": string, 
      "aliasIds": [string, ...], 
      "aliases": [alias, ...], 
      "url": string, 
      "disabled": boolean, 
      "name": string, 
      "data": string, 
      "certificateType": string, 
      "version": int, 
      "serialNumber": string, 
      "issuedBy": string, 
      "issuedTo": string, 
      "validFrom": calendar, 
      "validTo": calendar, 
      "algorithm": string, 
      "fingerprint": fingerprint
    }

keyStore


    {
      "id": string, 
      "aliasIds": [string, ...], 
      "aliases": [alias, ...], 
      "url": string, 
      "name": string, 
      "data": keyStoreData, 
      "certificates": [certificateInfo, ...], 
      "certificate": certificateInfo
    }

keyStoreData

    {
      "bytes": string, 
      "password": string
    }
  

projectRole


    {
      "id": string, 
      "aliasIds": [string, ...], 
      "aliases": [alias, ...], 
      "role": role, 
      "project": project, 
      "owner": authorityHolder
    }

certificateInfo


    {
      "certificateType": string, 
      "version": int, 
      "serialNumber": string, 
      "issuedBy": string, 
      "issuedTo": string, 
      "validFrom": calendar, 
      "validTo": calendar, 
      "algorithm": string, 
      "fingerprint": fingerprint
    }

project


    {
      "id": string, 
      "aliasIds": [string, ...], 
      "aliases": [alias, ...], 
      "key": string, 
      "name": string, 
      "archived": boolean, 
      "description": string, 
      "creationTime": calendar, 
      "iconUrl": string, 
      "resources": [resource, ...], 
      "projectRoles": [projectRole, ...], 
      "transitiveProjectRoles": [projectRole, ...], 
      "myFavorite": boolean
    }

locale

    {
      "name": string, 
      "language": string, 
      "region": string
    }
  

backupSettings

extends settings


    {
      "namePrefix": string, 
      "backupFolder": string, 
      "resolvedBackupFolder": string, 
      "archiveType": string, 
      "status": backupStatus, 
      "databaseReadonly": boolean, 
      "cronExpression": string, 
      "countToKeep": int, 
      "id": string /* from settings */, 
      "aliasIds": [string, ...] /* from settings */, 
      "aliases": [alias, ...] /* from settings */
    }

backupStatus


    {
      "inProgress": boolean, 
      "savedData": [backupData, ...]
    }

backupData

    {
      "name": string, 
      "timestamp": calendar
    }
  

migrations


    {
      "id": string, 
      "aliasIds": [string, ...], 
      "aliases": [alias, ...], 
      "applied": boolean
    }

metrics


    {
      "id": string, 
      "aliasIds": [string, ...], 
      "aliases": [alias, ...], 
      "availableProcessors": int, 
      "memory": memory, 
      "database": database, 
      "serverStartTime": long
    }

memory

    {
      "available": long, 
      "allocated": long, 
      "used": long
    }
  

database

    {
      "location": string, 
      "dataSize": long, 
      "textIndexSize": long, 
      "blobsSize": long, 
      "backgroundThreadsCount": int, 
      "pendingJobsCount": int, 
      "entityIterableCacheSize": int, 
      "entityIterableCacheHitRate": double, 
      "transactionsCount": long, 
      "transactionsPerSecond": double
    }
  

linkData

    {
      "id": string, 
      "presentation": string
    }
  

sshPublicKey

    {
      "fingerPrint": string, 
      "data": string, 
      "openSshKey": string, 
      "comment": string
    }
  

uuid

extended by dashboard, dashboardPermission, userDashboard, userDashboardPermission, userGroupDashboardPermission, authResults, authAttempt, authFoundUser


    {
      "id": string, 
      "aliasIds": [string, ...], 
      "aliases": [alias, ...]
    }

headerItem


    {
      "id": string, 
      "aliasIds": [string, ...], 
      "aliases": [alias, ...], 
      "name": string, 
      "homeUrl": string, 
      "iconUrl": string, 
      "applicationName": string, 
      "vendor": string
    }

team


    {
      "role": role, 
      "users": [user, ...], 
      "usersTotal": int, 
      "groups": [userGroup, ...], 
      "groupsTotal": int
    }

importSettings

extends settings


    {
      "importFolder": string, 
      "id": string /* from settings */, 
      "aliasIds": [string, ...] /* from settings */, 
      "aliases": [alias, ...] /* from settings */
    }

authorityHolder

extended by service, user, userGroup


    {
      "id": string, 
      "aliasIds": [string, ...], 
      "aliases": [alias, ...], 
      "name": string, 
      "projectRoles": [projectRole, ...], 
      "transitiveProjectRoles": [projectRole, ...]
    }

updateStatus


    {
      "succeed": boolean, 
      "update": updateStatusInfo
    }

updateStatusInfo

    {
      "message": string, 
      "downloadUrl": string, 
      "date": calendar, 
      "free": boolean
    }
  

internalSettings

extends settings


    {
      "sessionInterval": int, 
      "rememberMeInterval": int, 
      "id": string /* from settings */, 
      "aliasIds": [string, ...] /* from settings */, 
      "aliases": [alias, ...] /* from settings */
    }

fingerprint

    {
      "md5": string, 
      "sha1": string, 
      "sha256": string, 
      "sha384": string, 
      "sha512": string
    }
  

alias

    {
      "id": string, 
      "action": string
    }
  

untrustedRedirectURI

    {
      "redirectURI": string, 
      "triedFrom": string, 
      "triedAt": calendar
    }
  

dashboard

extends uuid


    {
      "name": string, 
      "owner": user, 
      "data": raw, 
      "permission": string, 
      "permissions": [dashboardPermission, ...], 
      "favorite": boolean, 
      "ordinal": int, 
      "id": string /* from uuid */, 
      "aliasIds": [string, ...] /* from uuid */, 
      "aliases": [alias, ...] /* from uuid */
    }

dashboardPermission

extends uuid

extended by userDashboardPermission, userGroupDashboardPermission


    {
      "permission": string, 
      "id": string /* from uuid */, 
      "aliasIds": [string, ...] /* from uuid */, 
      "aliases": [alias, ...] /* from uuid */
    }

userDashboard

extends uuid


    {
      "dashboard": dashboard, 
      "user": user, 
      "favorite": boolean, 
      "ordinal": int, 
      "id": string /* from uuid */, 
      "aliasIds": [string, ...] /* from uuid */, 
      "aliases": [alias, ...] /* from uuid */
    }

userDashboardPermission

extends dashboardPermission


    {
      "user": user, 
      "permission": string /* from dashboardPermission */, 
      "id": string /* from uuid */, 
      "aliasIds": [string, ...] /* from uuid */, 
      "aliases": [alias, ...] /* from uuid */
    }

userGroupDashboardPermission

extends dashboardPermission


    {
      "userGroup": userGroup, 
      "permission": string /* from dashboardPermission */, 
      "id": string /* from uuid */, 
      "aliasIds": [string, ...] /* from uuid */, 
      "aliases": [alias, ...] /* from uuid */
    }

userDashboardImport

    {
      "id": string, 
      "user": string, 
      "favorite": boolean, 
      "ordinal": int
    }
  

dashboardPermissionImport

    {
      "id": string, 
      "principal": string, 
      "type": string, 
      "permission": string
    }
  

dashboardImport


    {
      "id": string, 
      "name": string, 
      "owner": string, 
      "json": string, 
      "permissions": [dashboardPermissionImport, ...], 
      "userDashboards": [userDashboardImport, ...]
    }

dashboardImportList


    {
      "items": [dashboardImport, ...]
    }

dashboardImportEvent

    {
      "message": string, 
      "path": string, 
      "severity": string
    }
  

dashboardImportResult


    {
      "success": boolean, 
      "events": [dashboardImportEvent, ...], 
      "missing": [dashboardImportMissingEntity, ...]
    }

dashboardImportMissingEntity

    {
      "entityType": string, 
      "entityId": string
    }
  

authResults

extends uuid


    {
      "foundUsers": [authFoundUser, ...], 
      "noUserAttempts": [authAttempt, ...], 
      "createHubDetails": createHubDetails, 
      "id": string /* from uuid */, 
      "aliasIds": [string, ...] /* from uuid */, 
      "aliases": [alias, ...] /* from uuid */
    }

authAttempt

extends uuid


    {
      "externalUserDetails": details, 
      "persistedUserDetails": details, 
      "similarUser": user, 
      "authModule": authmodule, 
      "id": string /* from uuid */, 
      "aliasIds": [string, ...] /* from uuid */, 
      "aliases": [alias, ...] /* from uuid */
    }

mergeTokens

    {
      "userId": string, 
      "foundUsers": [string, ...], 
      "noUserAttempts": [string, ...], 
      "createHubDetails": boolean
    }
  

approvedScope


    {
      "id": string, 
      "client": service, 
      "scope": [service, ...], 
      "user": user, 
      "expiresOn": calendar
    }

refreshToken


    {
      "id": string, 
      "client": service, 
      "scope": [service, ...], 
      "user": user, 
      "creationTime": calendar, 
      "lastAccessTime": calendar
    }

accessToken

    {
      "id_token": string, 
      "access_token": string, 
      "token_type": string, 
      "expires_in": int, 
      "refresh_token": string, 
      "scope": string
    }
  

permanentToken


    {
      "id": string, 
      "name": string, 
      "token": string, 
      "scope": [service, ...], 
      "user": user, 
      "creationTime": calendar, 
      "lastAccessTime": calendar
    }

tokenInfo

    {
      "client": string, 
      "user": string, 
      "scope": [string, ...]
    }
  

createHubDetails

    {
      "isAllowed": boolean, 
      "errorId": string
    }
  

authFoundUser

extends uuid


    {
      "user": user, 
      "attempts": [authAttempt, ...], 
      "ownCredentials": boolean, 
      "id": string /* from uuid */, 
      "aliasIds": [string, ...] /* from uuid */, 
      "aliases": [alias, ...] /* from uuid */
    }

authRequest


    {
      "userId": string, 
      "credentials": credentials
    }

Last modified: 6 April 2017