Hub 2017.3 Help

JSON Scheme

accessToken

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

aggregationChange

extends change

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

alias

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

approvedScope

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

authAttempt

extends uuid

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

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 }

authResults

{ "foundUsers": [authFoundUser, ...], "noUserAttempts": [authAttempt, ...], "createHubDetails": createHubDetails }

authmodule

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

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

authorityHolder

extended by projectTeam, projectTeamMember, service, user, userGroup

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

avatar

extended by defaultavatar, gravatar, urlavatar

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

backupData

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

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, ...] }

blockedAddress

{ "address": string, "hostName": string }

blockedAddresses

{ "items": [blockedAddress, ...], "timeUntilNextCooldown": long }

cachedPermission

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

certificate

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

certificateInfo

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

change

extended by aggregationChange, linkChange, primitiveChange

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

conflict

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

contact

extended by email, jabber

{ "verified": boolean }

coreauthmodule

extends authmodule

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

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 */ }

counters

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

createHubDetails

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

credentials

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

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 */ }

dashboardImport

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

dashboardImportEvent

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

dashboardImportList

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

dashboardImportMissingEntity

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

dashboardImportResult

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

dashboardPermission

extends uuid

extended by projectTeamDashboardPermission, userDashboardPermission, userGroupDashboardPermission

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

dashboardPermissionImport

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

database

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

defaultavatar

extends avatar

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

details

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

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

email

extends contact

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

emailuserdetails

extends coreuserdetails

{ "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 */ }

enabledFeatures

{ "enabled": [string, ...] }

error

{ "error": string, "error_code": int, "error_description": string, "error_developer_message": string, "error_uri": string, "error_field": string, "error_params": [nameValue, ...] }

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 }

externalauthmodule

extends authmodule

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

{ "serverUrl": string, "connectionTimeout": int, "readTimeout": int, "allowedCreateNewUsers": boolean, "id": string /* from authmodule */, "aliasIds": [string, ...] /* from authmodule */, "aliases": [alias, ...] /* 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 */, "id": string /* from authmodule */, "aliasIds": [string, ...] /* from authmodule */, "aliases": [alias, ...] /* 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, "keyStore": keyStore, "serverUrl": string /* from externalauthmodule */, "connectionTimeout": int /* from externalauthmodule */, "readTimeout": int /* from externalauthmodule */, "allowedCreateNewUsers": boolean /* from externalauthmodule */, "id": string /* from authmodule */, "aliasIds": [string, ...] /* from authmodule */, "aliases": [alias, ...] /* from authmodule */, "name": string /* from authmodule */, "ordinal": int /* from authmodule */, "accountsSize": int /* from authmodule */, "disabled": boolean /* from authmodule */, "autoJoinGroups": [userGroup, ...] /* from authmodule */ }

fingerprint

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

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 */, "id": string /* from authmodule */, "aliasIds": [string, ...] /* from authmodule */, "aliases": [alias, ...] /* 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 */, "id": string /* from authmodule */, "aliasIds": [string, ...] /* from authmodule */, "aliases": [alias, ...] /* 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 */ }

gravatar

extends avatar

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

headerItem

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

hubFeature

extends uuid

extended by scopedFeature, systemFeature

{ "key": string, "name": string, "description": string, "restartRequired": boolean, "enabled": boolean, "id": string /* from uuid */, "aliasIds": [string, ...] /* from uuid */, "aliases": [alias, ...] /* from uuid */ }

identityProviderMetadata

extends providerMetadata

{ "defaultNameIdType": string, "service": service, "keyStore": keyStore, "entityId": string /* from providerMetadata */, "name": string /* from providerMetadata */, "id": string /* from uuid */, "aliasIds": [string, ...] /* from uuid */, "aliases": [alias, ...] /* from uuid */ }

import

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

importPhase

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

importSettings

extends settings

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

info

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

internalSettings

extends settings

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

jabber

extends contact

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

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 */ }

jbaauthmodule

extends externalpasswordauthmodule

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

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 */ }

jiraauthmodule

extends externalpasswordauthmodule

{ "allowedToSavePassword": boolean /* from externalpasswordauthmodule */, "changePasswordUri": string /* from externalpasswordauthmodule */, "keyStore": keyStore /* from externalpasswordauthmodule */, "serverUrl": string /* from externalauthmodule */, "connectionTimeout": int /* from externalauthmodule */, "readTimeout": int /* from externalauthmodule */, "allowedCreateNewUsers": boolean /* from externalauthmodule */, "id": string /* from authmodule */, "aliasIds": [string, ...] /* from authmodule */, "aliases": [alias, ...] /* 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 */ }

keyStore

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

keyStoreData

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

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 */, "keyStore": keyStore /* from externalpasswordauthmodule */, "serverUrl": string /* from externalauthmodule */, "connectionTimeout": int /* from externalauthmodule */, "readTimeout": int /* from externalauthmodule */, "allowedCreateNewUsers": boolean /* from externalauthmodule */, "id": string /* from authmodule */, "aliasIds": [string, ...] /* from authmodule */, "aliases": [alias, ...] /* 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 */ }

license

extends settings

{ "licenseKey": string, "licenseName": string, "service": service, "users": [user, ...], "autoJoinGroups": [userGroup, ...], "licenseInfo": licenseInfo, "availableLicenses": int, "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 }

linkChange

extends change

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

linkData

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

locale

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

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 */ }

md5password

extends password

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

memory

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

mergeTokens

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

metrics

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

migrations

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

nameValue

{ "name": string, "value": string }

oauth2authmodule

extends externaloauth2module

{ "scope": string, "tokenUrl": string, "formClientAuth": boolean, "userInfoUrl": string, "userIdPath": string, "userEmailUrl": string, "userEmailPath": string, "userEmailVerifiedPath": string, "userNamePath": string, "userPictureIdPath": string, "userPictureUrlPattern": string, "emailVerifiedByDefault": boolean, "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 */, "id": string /* from authmodule */, "aliasIds": [string, ...] /* from authmodule */, "aliases": [alias, ...] /* 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 */ }

openidauthmodule

extends externalauthmodule

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

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 */ }

password

extended by md5password, plainpassword, shapassword

{ "oldValue": string }

permanentToken

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

permission

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

plainpassword

extends password

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

primitiveChange

extends change

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

profile

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

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, "team": projectTeam, "owner": user, "global": boolean }

projectRole

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

projectTeam

extends authorityHolder

{ "groups": [userGroup, ...], "users": [user, ...], "ownUsers": [user, ...], "project": project, "userCount": int, "id": string /* from authorityHolder */, "aliasIds": [string, ...] /* from authorityHolder */, "aliases": [alias, ...] /* from authorityHolder */, "name": string /* from authorityHolder */, "projectRoles": [projectRole, ...] /* from authorityHolder */, "transitiveProjectRoles": [projectRole, ...] /* from authorityHolder */ }

projectTeamDashboardPermission

extends dashboardPermission

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

projectTeamMember

extends user

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

providerMetadata

extends uuid

extended by identityProviderMetadata, serviceProviderMetadata

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

publicSettings

extends settings

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

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 }

refreshToken

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

resolution

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

resource

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

role

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

scopedFeature

extends hubFeature

{ "scopes": [authorityHolder, ...], "key": string /* from hubFeature */, "name": string /* from hubFeature */, "description": string /* from hubFeature */, "restartRequired": boolean /* from hubFeature */, "enabled": boolean /* from hubFeature */, "id": string /* from uuid */, "aliasIds": [string, ...] /* from uuid */, "aliases": [alias, ...] /* from uuid */ }

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, ...], "viewers": [authorityHolder, ...], "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 */ }

serviceAPI

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

serviceProviderMetadata

extends providerMetadata

{ "description": string, "assertionConsumerUrl": string, "logoutResponseSupported": boolean, "entityId": string /* from providerMetadata */, "name": string /* from providerMetadata */, "id": string /* from uuid */, "aliasIds": [string, ...] /* from uuid */, "aliases": [alias, ...] /* from uuid */ }

settings

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

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

shapassword

extends password

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

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 */ }

sshPublicKey

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

systemFeature

extends hubFeature

{ "key": string /* from hubFeature */, "name": string /* from hubFeature */, "description": string /* from hubFeature */, "restartRequired": boolean /* from hubFeature */, "enabled": boolean /* from hubFeature */, "id": string /* from uuid */, "aliasIds": [string, ...] /* from uuid */, "aliases": [alias, ...] /* from uuid */ }

team

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

throttlingSettings

extends settings

{ "enabled": boolean, "whiteList": [string, ...], "maxTrackingAddresses": int, "maxFailuresPerAddress": int, "cooldownValue": int, "cooldownPeriodSec": long, "suggestedAddress": string, "blockedAddresses": blockedAddresses, "id": string /* from settings */, "aliasIds": [string, ...] /* from settings */, "aliases": [alias, ...] /* from settings */ }

tokenInfo

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

untrustedRedirectURI

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

updateStatus

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

updateStatusInfo

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

urlavatar

extends avatar

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

user

extends authorityHolder

extended by projectTeamMember

{ "login": string, "banned": boolean, "banReason": string, "guest": boolean, "avatar": avatar, "profile": profile, "contacts": [contact, ...], "groups": [userGroup, ...], "teams": [projectTeam, ...], "transitiveTeams": [projectTeam, ...], "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 */ }

userDashboard

extends uuid

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

userDashboardImport

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

userDashboardPermission

extends dashboardPermission

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

userGroup

extends authorityHolder

{ "description": string, "iconUrl": string, "autoJoin": boolean, "users": [user, ...], "ownUsers": [user, ...], "userCount": int, "parent": userGroup, "subgroups": [userGroup, ...], "teams": [projectTeam, ...], "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 */ }

userGroupDashboardPermission

extends dashboardPermission

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

uuid

extended by authAttempt, authFoundUser, dashboard, dashboardPermission, hubFeature, identityProviderMetadata, projectTeamDashboardPermission, providerMetadata, scopedFeature, serviceProviderMetadata, systemFeature, userDashboard, userDashboardPermission, userGroupDashboardPermission, widget

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

vcsUserName

{ "name": string }

widget

extends uuid

{ "key": string, "version": string, "installedVersion": string, "latestVersion": string, "installedFromRepository": boolean, "archiveId": string, "manifest": raw, "owner": user, "disabled": boolean, "applicationNames": [string, ...], "accessibleServices": [service, ...], "id": string /* from uuid */, "aliasIds": [string, ...] /* from uuid */, "aliases": [alias, ...] /* from uuid */ }
Last modified: 4 October 2017