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
  }
  

applicationPassword


  {
    "id": string, 
    "name": string, 
    "password": string, 
    "user": user, 
    "creationTime": calendar, 
    "lastAccessTime": calendar, 
    "lastAccessAddress": string, 
    "lastAccessUserAgent": 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 */, 
      "aliases": [alias, ...] /* from uuid */
  }

authFoundUser

extends uuid


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

authModuleCustomAttributeMapping


  {
    "mapping": string, 
    "attributePrototype": profileAttributePrototype
  }

authModuleGroupMapping


  {
    "externalGroupName": string, 
    "group": userGroup
  }

authRequest


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

authResults


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

authmodule

extended by azureauthmodule, coreauthmodule, externalauthmodule, externaloauth2module, externalpasswordauthmodule, githubauthmodule, googleauthmodule, jbaoauthauthmodule, jiraauthmodule, ldapauthmodule, oauth2authmodule, oktaAuthmodule, openidauthmodule, samlAuthModule, userCreationAuthModule


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

authorityHolder

extended by invitedUser, organizationMember, projectTeam, projectTeamMember, service, user, userGroup


  {
    "id": string, 
    "aliases": [alias, ...], 
    "name": string, 
    "projectRoles": [projectRole, ...], 
    "transitiveProjectRoles": [projectRole, ...], 
    "sourcedProjectRoles": [sourcedProjectRole, ...], 
    "organizationRoles": [organizationRole, ...], 
    "transitiveOrganizationRoles": [organizationRole, ...], 
    "sourcedOrganizationRoles": [sourcedOrganizationRole, ...]
  }

avatar

extended by defaultavatar, gravatar, urlavatar

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

azureauthmodule

extends externaloauth2module


  {
    "tenant": string, 
    "syncInterval": string, 
    "userStatusIgnored": boolean, 
      "clientId": string /* from externaloauth2module */, 
      "clientSecret": string /* from externaloauth2module */, 
      "redirectUri": string /* from externaloauth2module */, 
      "iconUrl": string /* from externaloauth2module */, 
      "extensionGrantType": string /* from externaloauth2module */, 
      "usesOldReturnUri": boolean /* from externaloauth2module */, 
      "serverUrl": string /* from externalauthmodule */, 
      "connectionTimeout": int /* from externalauthmodule */, 
      "readTimeout": int /* from externalauthmodule */, 
      "groupMappings": [authModuleGroupMapping, ...] /* from externalauthmodule */, 
      "attributeMappings": [authModuleCustomAttributeMapping, ...] /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from userCreationAuthModule */, 
      "id": string /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "isDefault": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
  }

azuredetails

extends details


  {
    "identifier": string, 
    "fullName": string, 
    "avatar": string, 
    "groupNames": [string, ...], 
      "id": 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 */
  }

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

backupStatus


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

bcryptpassword

extends password

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

blockedKey

  {
    "key": string, 
    "description": string
  }
  

blockedKeys


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

cachedPermission


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

certificate


  {
    "id": 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
  }
  

confirm2FA

  {
    "code": int
  }
  

contact

extended by email


  {
    "verified": boolean, 
    "user": user
  }

coreauthmodule

extends authmodule


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

coreuserdetails

extends details

extended by emailuserdetails, loginuserdetails


  {
    "password": password, 
    "originService": service, 
    "passwordChangeRequired": boolean, 
      "id": 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 */
  }

createHubDetails

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

credentials

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

dashboard

extends uuid


  {
    "name": string, 
    "owner": user, 
    "data": raw, 
    "permission": string, 
    "access": string, 
    "permissions": [dashboardPermission, ...], 
    "favorite": boolean, 
    "ordinal": int, 
      "id": 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 */, 
      "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 azuredetails, coreuserdetails, emailuserdetails, githubdetails, googledetails, jbaoauthdetails, jiradetails, ldapdetails, loginuserdetails, oauth2details, oktadetails, openiddetails, samlUserDetails


  {
    "id": 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 */, 
      "user": user /* from contact */
  }

emailuserdetails

extends coreuserdetails


  {
      "password": password /* from coreuserdetails */, 
      "originService": service /* from coreuserdetails */, 
      "passwordChangeRequired": boolean /* from coreuserdetails */, 
      "id": 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, ...]
  }
  

endUserAgreement

  {
    "enabled": boolean, 
    "text": string, 
    "majorVersion": int, 
    "minorVersion": int, 
    "updateTime": calendar, 
    "requiredForREST": boolean
  }
  

endUserAgreementConsent

  {
    "accepted": boolean, 
    "majorVersion": int, 
    "minorVersion": int, 
    "time": calendar, 
    "revocationTime": calendar, 
    "address": 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, 
    "aliases": [alias, ...], 
    "targetId": string, 
    "targetType": string, 
    "targetPresentation": string, 
    "author": string, 
    "authorPresentation": string, 
    "authorType": string, 
    "changes": [change, ...], 
    "type": string, 
    "timestamp": calendar, 
    "eraseTimestamp": calendar
  }

externalauthmodule

extends userCreationAuthModule

extended by azureauthmodule, externaloauth2module, externalpasswordauthmodule, githubauthmodule, googleauthmodule, jbaoauthauthmodule, jiraauthmodule, ldapauthmodule, oauth2authmodule, oktaAuthmodule, openidauthmodule, samlAuthModule


  {
    "serverUrl": string, 
    "connectionTimeout": int, 
    "readTimeout": int, 
    "groupMappings": [authModuleGroupMapping, ...], 
    "attributeMappings": [authModuleCustomAttributeMapping, ...], 
      "allowedCreateNewUsers": boolean /* from userCreationAuthModule */, 
      "id": string /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "isDefault": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
  }

externaloauth2module

extends externalauthmodule

extended by azureauthmodule, githubauthmodule, googleauthmodule, jbaoauthauthmodule, oauth2authmodule, oktaAuthmodule


  {
    "clientId": string, 
    "clientSecret": string, 
    "redirectUri": string, 
    "iconUrl": string, 
    "extensionGrantType": string, 
    "usesOldReturnUri": boolean, 
      "serverUrl": string /* from externalauthmodule */, 
      "connectionTimeout": int /* from externalauthmodule */, 
      "readTimeout": int /* from externalauthmodule */, 
      "groupMappings": [authModuleGroupMapping, ...] /* from externalauthmodule */, 
      "attributeMappings": [authModuleCustomAttributeMapping, ...] /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from userCreationAuthModule */, 
      "id": string /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "isDefault": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
  }

externalpasswordauthmodule

extends externalauthmodule

extended by jiraauthmodule, ldapauthmodule


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

fingerprint

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

githubauthmodule

extends externaloauth2module


  {
    "scope": string, 
    "allowedOrganizations": string, 
      "clientId": string /* from externaloauth2module */, 
      "clientSecret": string /* from externaloauth2module */, 
      "redirectUri": string /* from externaloauth2module */, 
      "iconUrl": string /* from externaloauth2module */, 
      "extensionGrantType": string /* from externaloauth2module */, 
      "usesOldReturnUri": boolean /* from externaloauth2module */, 
      "serverUrl": string /* from externalauthmodule */, 
      "connectionTimeout": int /* from externalauthmodule */, 
      "readTimeout": int /* from externalauthmodule */, 
      "groupMappings": [authModuleGroupMapping, ...] /* from externalauthmodule */, 
      "attributeMappings": [authModuleCustomAttributeMapping, ...] /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from userCreationAuthModule */, 
      "id": string /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "isDefault": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
  }

githubdetails

extends details


  {
    "login": string, 
    "fullName": string, 
    "avatar": string, 
      "id": 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 */, 
      "extensionGrantType": string /* from externaloauth2module */, 
      "usesOldReturnUri": boolean /* from externaloauth2module */, 
      "serverUrl": string /* from externalauthmodule */, 
      "connectionTimeout": int /* from externalauthmodule */, 
      "readTimeout": int /* from externalauthmodule */, 
      "groupMappings": [authModuleGroupMapping, ...] /* from externalauthmodule */, 
      "attributeMappings": [authModuleCustomAttributeMapping, ...] /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from userCreationAuthModule */, 
      "id": string /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "isDefault": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
  }

googledetails

extends details


  {
    "identifier": string, 
    "fullName": string, 
    "avatar": string, 
      "id": 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 */
  }
  

groupProjectRoleSource

extends groupRoleSource


  {
      "group": userGroup /* from groupRoleSource */
  }

groupRoleSource

extends roleSource

extended by groupProjectRoleSource


  {
    "group": userGroup
  }

headerItem


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

internalSettings

extends settings


  {
    "tokenInterval": int, 
    "sessionInterval": int, 
    "rememberMeInterval": int, 
    "hashAnonymization": boolean, 
    "captchaPublicKey": string, 
    "captchaPrivateKey": string, 
    "debugCategories": [string, ...], 
      "id": string /* from settings */, 
      "aliases": [alias, ...] /* from settings */
  }

inviteToken


  {
    "user": user, 
    "token": string
  }

invitedUser

extends user


  {
    "successful": boolean, 
    "errorMessage": string, 
    "email": string, 
      "login": string /* from user */, 
      "banned": boolean /* from user */, 
      "banReason": string /* from user */, 
      "banBadge": string /* from user */, 
      "guest": boolean /* from user */, 
      "avatar": avatar /* from user */, 
      "profile": profile /* from user */, 
      "groups": [userGroup, ...] /* from user */, 
      "organizations": [organization, ...] /* from user */, 
      "transitiveOrganizations": [organization, ...] /* from user */, 
      "transitiveGroups": [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 */, 
      "helpdeskProjectSettings": [projectHelpdeskSettings, ...] /* from user */, 
      "creationTime": calendar /* from user */, 
      "lastAccessTime": calendar /* from user */, 
      "refreshTokens": [refreshToken, ...] /* from user */, 
      "permanentTokens": [permanentToken, ...] /* from user */, 
      "approvedScopes": [approvedScope, ...] /* from user */, 
      "applicationPasswords": [applicationPassword, ...] /* from user */, 
      "favoriteProjects": [project, ...] /* from user */, 
      "endUserAgreementConsent": endUserAgreementConsent /* from user */, 
      "eraseTimestamp": calendar /* from user */, 
      "twoFactorAuthentication": twoFactorAuthentication /* from user */, 
      "requiredTwoFactorAuthentication": boolean /* from user */, 
      "pendingTwoFactorAuthentication": twoFactorAuthenticationSecret /* from user */, 
      "webauthnDevice": webauthnDevice /* from user */, 
      "userType": userType /* from user */, 
      "permissions": [string, ...] /* from user */, 
      "id": string /* from authorityHolder */, 
      "aliases": [alias, ...] /* from authorityHolder */, 
      "name": string /* from authorityHolder */, 
      "projectRoles": [projectRole, ...] /* from authorityHolder */, 
      "transitiveProjectRoles": [projectRole, ...] /* from authorityHolder */, 
      "sourcedProjectRoles": [sourcedProjectRole, ...] /* from authorityHolder */, 
      "organizationRoles": [organizationRole, ...] /* from authorityHolder */, 
      "transitiveOrganizationRoles": [organizationRole, ...] /* from authorityHolder */, 
      "sourcedOrganizationRoles": [sourcedOrganizationRole, ...] /* from authorityHolder */
  }

jbaoauthauthmodule

extends externaloauth2module


  {
    "newUserRestrictDomain": string, 
    "jbaCustomerCode": string, 
    "jbaCustomerApiToken": string, 
      "clientId": string /* from externaloauth2module */, 
      "clientSecret": string /* from externaloauth2module */, 
      "redirectUri": string /* from externaloauth2module */, 
      "iconUrl": string /* from externaloauth2module */, 
      "extensionGrantType": string /* from externaloauth2module */, 
      "usesOldReturnUri": boolean /* from externaloauth2module */, 
      "serverUrl": string /* from externalauthmodule */, 
      "connectionTimeout": int /* from externalauthmodule */, 
      "readTimeout": int /* from externalauthmodule */, 
      "groupMappings": [authModuleGroupMapping, ...] /* from externalauthmodule */, 
      "attributeMappings": [authModuleCustomAttributeMapping, ...] /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from userCreationAuthModule */, 
      "id": string /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "isDefault": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
  }

jbaoauthdetails

extends details


  {
    "login": string, 
    "fullName": string, 
      "id": 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 */, 
      "groupMappings": [authModuleGroupMapping, ...] /* from externalauthmodule */, 
      "attributeMappings": [authModuleCustomAttributeMapping, ...] /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from userCreationAuthModule */, 
      "id": string /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "isDefault": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
  }

jiradetails

extends details


  {
    "login": string, 
    "fullName": string, 
    "changePasswordUrl": string, 
      "id": 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, 
    "aliases": [alias, ...], 
    "name": string, 
    "data": keyStoreData, 
    "certificate": certificateInfo, 
    "certificateData": string
  }

keyStoreData

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

ldapauthmodule

extends externalpasswordauthmodule


  {
    "filter": string, 
    "formatDN": string, 
    "emailAttributeName": string, 
    "fullNameAttributeName": string, 
    "userIdAttributeName": string, 
    "VCSNameAttributeName": string, 
    "groupsAttributeName": string, 
    "accountExpiresAttributeName": string, 
    "userAccountControlAttributeName": string, 
    "lockoutThresholdAttributeName": string, 
    "lockoutTimeAttributeName": string, 
    "lockoutDurationAttributeName": string, 
    "bindUserLogin": string, 
    "bindUserPassword": string, 
    "useBindUser": boolean, 
    "referralIgnored": boolean, 
    "userStatusIgnored": boolean, 
    "syncInterval": string, 
      "allowedToSavePassword": boolean /* from externalpasswordauthmodule */, 
      "changePasswordUri": string /* from externalpasswordauthmodule */, 
      "keyStore": keyStore /* from externalpasswordauthmodule */, 
      "serverUrl": string /* from externalauthmodule */, 
      "connectionTimeout": int /* from externalauthmodule */, 
      "readTimeout": int /* from externalauthmodule */, 
      "groupMappings": [authModuleGroupMapping, ...] /* from externalauthmodule */, 
      "attributeMappings": [authModuleCustomAttributeMapping, ...] /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from userCreationAuthModule */, 
      "id": string /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "isDefault": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
  }

ldapdetails

extends details


  {
    "userid": string, 
    "fullName": string, 
    "changePasswordUrl": string, 
    "VCSName": string, 
    "ldapGroupNames": [string, ...], 
    "userStatus": string, 
      "id": 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, 
    "availableAgentLicenses": int, 
    "availableReporterLicenses": int, 
      "id": string /* from settings */, 
      "aliases": [alias, ...] /* from settings */
  }

licenseInfo

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

linkChange

extends change


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

linkData

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

locale

  {
    "name": string, 
    "label": string, 
    "language": string, 
    "region": string, 
    "community": boolean
  }
  

loginuserdetails

extends coreuserdetails


  {
    "login": string, 
      "password": password /* from coreuserdetails */, 
      "originService": service /* from coreuserdetails */, 
      "passwordChangeRequired": boolean /* from coreuserdetails */, 
      "id": 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, 
    "aliases": [alias, ...], 
    "availableProcessors": int, 
    "memory": memory, 
    "database": database, 
    "serverStartTime": long, 
    "logsFolder": string
  }

migrations


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

nameValue

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

oauth2authmodule

extends externaloauth2module


  {
    "scope": string, 
    "tokenUrl": string, 
    "formClientAuth": boolean, 
    "userInfoUrl": string, 
    "jwksUrl": string, 
    "userIdPath": string, 
    "userEmailUrl": string, 
    "userAvatarUrl": string, 
    "userEmailPath": string, 
    "userEmailVerifiedPath": string, 
    "userNamePath": string, 
    "fullNamePath": string, 
    "userPictureIdPath": string, 
    "userPictureUrlPattern": string, 
    "emailVerifiedByDefault": boolean, 
    "userGroupsPath": string, 
      "clientId": string /* from externaloauth2module */, 
      "clientSecret": string /* from externaloauth2module */, 
      "redirectUri": string /* from externaloauth2module */, 
      "iconUrl": string /* from externaloauth2module */, 
      "extensionGrantType": string /* from externaloauth2module */, 
      "usesOldReturnUri": boolean /* from externaloauth2module */, 
      "serverUrl": string /* from externalauthmodule */, 
      "connectionTimeout": int /* from externalauthmodule */, 
      "readTimeout": int /* from externalauthmodule */, 
      "groupMappings": [authModuleGroupMapping, ...] /* from externalauthmodule */, 
      "attributeMappings": [authModuleCustomAttributeMapping, ...] /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from userCreationAuthModule */, 
      "id": string /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "isDefault": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
  }

oauth2details

extends details


  {
    "identifier": string, 
    "userName": string, 
    "fullName": string, 
    "avatar": string, 
    "groupNames": [string, ...], 
      "id": 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 */
  }

oktaAuthmodule

extends externaloauth2module


  {
    "authUrl": string, 
    "oktaDomain": string, 
    "apiToken": string, 
    "syncInterval": string, 
      "clientId": string /* from externaloauth2module */, 
      "clientSecret": string /* from externaloauth2module */, 
      "redirectUri": string /* from externaloauth2module */, 
      "iconUrl": string /* from externaloauth2module */, 
      "extensionGrantType": string /* from externaloauth2module */, 
      "usesOldReturnUri": boolean /* from externaloauth2module */, 
      "serverUrl": string /* from externalauthmodule */, 
      "connectionTimeout": int /* from externalauthmodule */, 
      "readTimeout": int /* from externalauthmodule */, 
      "groupMappings": [authModuleGroupMapping, ...] /* from externalauthmodule */, 
      "attributeMappings": [authModuleCustomAttributeMapping, ...] /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from userCreationAuthModule */, 
      "id": string /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "isDefault": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
  }

oktadetails

extends details


  {
    "identifier": string, 
    "userName": string, 
    "fullName": string, 
    "groupNames": [string, ...], 
      "id": 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 */, 
      "groupMappings": [authModuleGroupMapping, ...] /* from externalauthmodule */, 
      "attributeMappings": [authModuleCustomAttributeMapping, ...] /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from userCreationAuthModule */, 
      "id": string /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "isDefault": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
  }

openiddetails

extends details


  {
    "identifier": string, 
    "fullName": string, 
    "avatar": string, 
      "id": 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 */
  }

organization


  {
    "id": string, 
    "aliases": [alias, ...], 
    "key": string, 
    "name": string, 
    "description": string, 
    "emailDomain": string, 
    "creationTime": calendar, 
    "projects": [project, ...], 
    "ownUsers": [user, ...], 
    "users": [user, ...], 
    "allUsers": boolean, 
    "groups": [userGroup, ...], 
    "teams": [projectTeam, ...], 
    "projectsCount": int, 
    "iconUrl": string, 
    "icon": string, 
    "defaultIcon": boolean, 
    "organizationRoles": [organizationRole, ...]
  }

organizationMember

extends user


  {
    "organizationOwnUser": boolean, 
    "organizationGroups": [userGroup, ...], 
      "login": string /* from user */, 
      "banned": boolean /* from user */, 
      "banReason": string /* from user */, 
      "banBadge": string /* from user */, 
      "guest": boolean /* from user */, 
      "avatar": avatar /* from user */, 
      "profile": profile /* from user */, 
      "groups": [userGroup, ...] /* from user */, 
      "organizations": [organization, ...] /* from user */, 
      "transitiveOrganizations": [organization, ...] /* from user */, 
      "transitiveGroups": [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 */, 
      "helpdeskProjectSettings": [projectHelpdeskSettings, ...] /* from user */, 
      "creationTime": calendar /* from user */, 
      "lastAccessTime": calendar /* from user */, 
      "refreshTokens": [refreshToken, ...] /* from user */, 
      "permanentTokens": [permanentToken, ...] /* from user */, 
      "approvedScopes": [approvedScope, ...] /* from user */, 
      "applicationPasswords": [applicationPassword, ...] /* from user */, 
      "favoriteProjects": [project, ...] /* from user */, 
      "endUserAgreementConsent": endUserAgreementConsent /* from user */, 
      "eraseTimestamp": calendar /* from user */, 
      "twoFactorAuthentication": twoFactorAuthentication /* from user */, 
      "requiredTwoFactorAuthentication": boolean /* from user */, 
      "pendingTwoFactorAuthentication": twoFactorAuthenticationSecret /* from user */, 
      "webauthnDevice": webauthnDevice /* from user */, 
      "userType": userType /* from user */, 
      "permissions": [string, ...] /* from user */, 
      "id": string /* from authorityHolder */, 
      "aliases": [alias, ...] /* from authorityHolder */, 
      "name": string /* from authorityHolder */, 
      "projectRoles": [projectRole, ...] /* from authorityHolder */, 
      "transitiveProjectRoles": [projectRole, ...] /* from authorityHolder */, 
      "sourcedProjectRoles": [sourcedProjectRole, ...] /* from authorityHolder */, 
      "organizationRoles": [organizationRole, ...] /* from authorityHolder */, 
      "transitiveOrganizationRoles": [organizationRole, ...] /* from authorityHolder */, 
      "sourcedOrganizationRoles": [sourcedOrganizationRole, ...] /* from authorityHolder */
  }

organizationRole

extended by sourcedOrganizationRole


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

ownProjectRoleSource

extends ownRoleSource

  {
  }
  

ownRoleSource

extends roleSource

extended by ownProjectRoleSource

  {
  }
  

password

extended by bcryptpassword, md5password, plainpassword, shapassword

  {
    "oldValue": string
  }
  

passwordStrength

  {
    "referenceScore": int, 
    "score": int, 
    "maxScore": int, 
    "referenceEntropy": int, 
    "entropy": int, 
    "maxEntropy": int, 
    "feedbackMessage": string
  }
  

permanentToken


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

permission


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

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, 
    "locale": locale, 
    "attributes": [profileAttribute, ...]
  }

profileAttribute


  {
    "id": string, 
    "aliases": [alias, ...], 
    "value": string, 
    "prototype": profileAttributePrototype
  }

profileAttributePrototype


  {
    "id": string, 
    "aliases": [alias, ...], 
    "name": string, 
    "type": string, 
    "showOnUserList": boolean
  }

project


  {
    "id": string, 
    "aliases": [alias, ...], 
    "key": string, 
    "name": string, 
    "archived": boolean, 
    "description": string, 
    "creationTime": calendar, 
    "iconUrl": string, 
    "icon": string, 
    "defaultIcon": boolean, 
    "resources": [resource, ...], 
    "projectRoles": [projectRole, ...], 
    "transitiveProjectRoles": [projectRole, ...], 
    "myFavorite": boolean, 
    "team": projectTeam, 
    "owner": user, 
    "global": boolean, 
    "restricted": boolean, 
    "dashboard": raw, 
    "organization": organization, 
    "projectType": projectType, 
    "helpdeskSettings": projectHelpdeskSettings
  }

projectHelpdeskSettings


  {
    "id": string, 
    "aliases": [alias, ...], 
    "parent": project, 
    "reporters": [user, ...]
  }

projectRole

extended by sourcedProjectRole


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

projectTeam

extends authorityHolder


  {
    "groups": [userGroup, ...], 
    "users": [user, ...], 
    "ownUsers": [user, ...], 
    "project": project, 
    "userCount": int, 
    "organizations": [organization, ...], 
      "id": string /* from authorityHolder */, 
      "aliases": [alias, ...] /* from authorityHolder */, 
      "name": string /* from authorityHolder */, 
      "projectRoles": [projectRole, ...] /* from authorityHolder */, 
      "transitiveProjectRoles": [projectRole, ...] /* from authorityHolder */, 
      "sourcedProjectRoles": [sourcedProjectRole, ...] /* from authorityHolder */, 
      "organizationRoles": [organizationRole, ...] /* from authorityHolder */, 
      "transitiveOrganizationRoles": [organizationRole, ...] /* from authorityHolder */, 
      "sourcedOrganizationRoles": [sourcedOrganizationRole, ...] /* from authorityHolder */
  }

projectTeamDashboardPermission

extends dashboardPermission


  {
    "projectTeam": projectTeam, 
      "permission": string /* from dashboardPermission */, 
      "id": 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 */, 
      "banBadge": string /* from user */, 
      "guest": boolean /* from user */, 
      "avatar": avatar /* from user */, 
      "profile": profile /* from user */, 
      "groups": [userGroup, ...] /* from user */, 
      "organizations": [organization, ...] /* from user */, 
      "transitiveOrganizations": [organization, ...] /* from user */, 
      "transitiveGroups": [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 */, 
      "helpdeskProjectSettings": [projectHelpdeskSettings, ...] /* from user */, 
      "creationTime": calendar /* from user */, 
      "lastAccessTime": calendar /* from user */, 
      "refreshTokens": [refreshToken, ...] /* from user */, 
      "permanentTokens": [permanentToken, ...] /* from user */, 
      "approvedScopes": [approvedScope, ...] /* from user */, 
      "applicationPasswords": [applicationPassword, ...] /* from user */, 
      "favoriteProjects": [project, ...] /* from user */, 
      "endUserAgreementConsent": endUserAgreementConsent /* from user */, 
      "eraseTimestamp": calendar /* from user */, 
      "twoFactorAuthentication": twoFactorAuthentication /* from user */, 
      "requiredTwoFactorAuthentication": boolean /* from user */, 
      "pendingTwoFactorAuthentication": twoFactorAuthenticationSecret /* from user */, 
      "webauthnDevice": webauthnDevice /* from user */, 
      "userType": userType /* from user */, 
      "permissions": [string, ...] /* from user */, 
      "id": string /* from authorityHolder */, 
      "aliases": [alias, ...] /* from authorityHolder */, 
      "name": string /* from authorityHolder */, 
      "projectRoles": [projectRole, ...] /* from authorityHolder */, 
      "transitiveProjectRoles": [projectRole, ...] /* from authorityHolder */, 
      "sourcedProjectRoles": [sourcedProjectRole, ...] /* from authorityHolder */, 
      "organizationRoles": [organizationRole, ...] /* from authorityHolder */, 
      "transitiveOrganizationRoles": [organizationRole, ...] /* from authorityHolder */, 
      "sourcedOrganizationRoles": [sourcedOrganizationRole, ...] /* from authorityHolder */
  }

projectType

  {
    "id": string, 
    "name": string
  }
  

providerMetadata

extends uuid

extended by identityProviderMetadata, serviceProviderMetadata


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

publicSettings

extends settings


  {
    "locale": locale, 
    "hubMottoHidden": boolean, 
    "companyLogo": string, 
    "loginMessage": string, 
    "loginFieldPlaceholder": string, 
    "systemMessage": string, 
    "endUserAgreement": endUserAgreement, 
    "installationType": string, 
    "emailVerificationRequired": boolean, 
    "hostServiceName": string, 
    "hostServiceApplicationName": string, 
    "helpdeskEnabled": boolean, 
      "id": 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, 
    "expires": calendar
  }

resource


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

role


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

roleSource

extended by groupProjectRoleSource, groupRoleSource, ownProjectRoleSource, ownRoleSource, teamProjectRoleSource, teamRoleSource

  {
  }
  

samlAuthModule

extends externalauthmodule


  {
    "spEntityId": string, 
    "ascUrl": string, 
    "keyStore": keyStore, 
    "spMetadataUrl": string, 
    "idpEntityId": string, 
    "certificateFingerprint": string, 
    "certificateFingerprintAlgorithm": string, 
    "contactUser": user, 
    "loginAttributeName": string, 
    "firstNameAttributeName": string, 
    "lastNameAttributeName": string, 
    "fullNameAttributeName": string, 
    "emailAttributeName": string, 
    "emailVerified": boolean, 
    "groupsAttributeName": string, 
    "iconUrl": string, 
      "serverUrl": string /* from externalauthmodule */, 
      "connectionTimeout": int /* from externalauthmodule */, 
      "readTimeout": int /* from externalauthmodule */, 
      "groupMappings": [authModuleGroupMapping, ...] /* from externalauthmodule */, 
      "attributeMappings": [authModuleCustomAttributeMapping, ...] /* from externalauthmodule */, 
      "allowedCreateNewUsers": boolean /* from userCreationAuthModule */, 
      "id": string /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "isDefault": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
  }

samlUserDetails

extends details


  {
    "nameId": string, 
    "login": string, 
    "fullName": string, 
    "groupNames": [string, ...], 
      "id": 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 */
  }

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 */, 
      "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, ...], 
    "viewers": [authorityHolder, ...], 
    "licenseSettings": license, 
    "trusted": boolean, 
    "secret": string, 
    "apiVersion": string, 
      "id": string /* from authorityHolder */, 
      "aliases": [alias, ...] /* from authorityHolder */, 
      "name": string /* from authorityHolder */, 
      "projectRoles": [projectRole, ...] /* from authorityHolder */, 
      "transitiveProjectRoles": [projectRole, ...] /* from authorityHolder */, 
      "sourcedProjectRoles": [sourcedProjectRole, ...] /* from authorityHolder */, 
      "organizationRoles": [organizationRole, ...] /* from authorityHolder */, 
      "transitiveOrganizationRoles": [organizationRole, ...] /* from authorityHolder */, 
      "sourcedOrganizationRoles": [sourcedOrganizationRole, ...] /* from authorityHolder */
  }

serviceProviderMetadata

extends providerMetadata


  {
    "description": string, 
    "assertionConsumerUrl": string, 
    "logoutResponseSupported": boolean, 
    "loginAttributeName": string, 
    "fullNameAttributeName": string, 
    "emailAttributeName": string, 
    "groupsAttributeName": string, 
    "externalIdAttributeName": string, 
      "entityId": string /* from providerMetadata */, 
      "name": string /* from providerMetadata */, 
      "id": string /* from uuid */, 
      "aliases": [alias, ...] /* from uuid */
  }

settings

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


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

setup2FA

  {
    "confirm": boolean
  }
  

shapassword

extends password

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

smtpMessage


  {
    "to": user, 
    "subject": string, 
    "htmlText": string, 
    "unsubscribeURL": string
  }

smtpSettings

extends settings


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

sourcedOrganizationRole

extends organizationRole


  {
    "sources": [roleSource, ...], 
      "id": string /* from organizationRole */, 
      "aliases": [alias, ...] /* from organizationRole */, 
      "role": role /* from organizationRole */, 
      "organization": organization /* from organizationRole */, 
      "owner": authorityHolder /* from organizationRole */
  }

sourcedProjectRole

extends projectRole


  {
    "sources": [roleSource, ...], 
      "id": string /* from projectRole */, 
      "aliases": [alias, ...] /* from projectRole */, 
      "role": role /* from projectRole */, 
      "project": project /* from projectRole */, 
      "owner": authorityHolder /* from projectRole */, 
      "teamMember": boolean /* from projectRole */
  }

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

team


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

teamProjectRoleSource

extends teamRoleSource


  {
      "team": projectTeam /* from teamRoleSource */
  }

teamRoleSource

extends roleSource

extended by teamProjectRoleSource


  {
    "team": projectTeam
  }

throttlingSettings

extends settings


  {
    "enabled": boolean, 
    "whiteList": [string, ...], 
    "maxTrackingKeys": int, 
    "maxFailuresPerKey": int, 
    "cooldownValue": int, 
    "cooldownPeriodSec": long, 
    "blockedKeys": blockedKeys, 
      "id": string /* from settings */, 
      "aliases": [alias, ...] /* from settings */
  }

tokenInfo

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

twoFactorAuthentication

extends twoFactorAuthenticationSecret

  {
    "enabled": boolean, 
      "secretKey": string /* from twoFactorAuthenticationSecret */, 
      "qrCodeUri": string /* from twoFactorAuthenticationSecret */, 
      "scratchCodes": [int, ...] /* from twoFactorAuthenticationSecret */, 
      "failedAttemptsCounter": int /* from twoFactorAuthenticationSecret */
  }
  

twoFactorAuthenticationSecret

extended by twoFactorAuthentication

  {
    "secretKey": string, 
    "qrCodeUri": string, 
    "scratchCodes": [int, ...], 
    "failedAttemptsCounter": int
  }
  

untrustedRedirectURI

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

urlavatar

extends avatar

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

user

extends authorityHolder

extended by invitedUser, organizationMember, projectTeamMember


  {
    "login": string, 
    "banned": boolean, 
    "banReason": string, 
    "banBadge": string, 
    "guest": boolean, 
    "avatar": avatar, 
    "profile": profile, 
    "groups": [userGroup, ...], 
    "organizations": [organization, ...], 
    "transitiveOrganizations": [organization, ...], 
    "transitiveGroups": [userGroup, ...], 
    "teams": [projectTeam, ...], 
    "transitiveTeams": [projectTeam, ...], 
    "details": [details, ...], 
    "VCSUserNames": [vcsUserName, ...], 
    "sshPublicKeys": [sshPublicKey, ...], 
    "licenses": [license, ...], 
    "helpdeskProjectSettings": [projectHelpdeskSettings, ...], 
    "creationTime": calendar, 
    "lastAccessTime": calendar, 
    "refreshTokens": [refreshToken, ...], 
    "permanentTokens": [permanentToken, ...], 
    "approvedScopes": [approvedScope, ...], 
    "applicationPasswords": [applicationPassword, ...], 
    "favoriteProjects": [project, ...], 
    "endUserAgreementConsent": endUserAgreementConsent, 
    "eraseTimestamp": calendar, 
    "twoFactorAuthentication": twoFactorAuthentication, 
    "requiredTwoFactorAuthentication": boolean, 
    "pendingTwoFactorAuthentication": twoFactorAuthenticationSecret, 
    "webauthnDevice": webauthnDevice, 
    "userType": userType, 
    "permissions": [string, ...], 
      "id": string /* from authorityHolder */, 
      "aliases": [alias, ...] /* from authorityHolder */, 
      "name": string /* from authorityHolder */, 
      "projectRoles": [projectRole, ...] /* from authorityHolder */, 
      "transitiveProjectRoles": [projectRole, ...] /* from authorityHolder */, 
      "sourcedProjectRoles": [sourcedProjectRole, ...] /* from authorityHolder */, 
      "organizationRoles": [organizationRole, ...] /* from authorityHolder */, 
      "transitiveOrganizationRoles": [organizationRole, ...] /* from authorityHolder */, 
      "sourcedOrganizationRoles": [sourcedOrganizationRole, ...] /* from authorityHolder */
  }

userCreationAuthModule

extends authmodule

extended by azureauthmodule, externalauthmodule, externaloauth2module, externalpasswordauthmodule, githubauthmodule, googleauthmodule, jbaoauthauthmodule, jiraauthmodule, ldapauthmodule, oauth2authmodule, oktaAuthmodule, openidauthmodule, samlAuthModule


  {
    "allowedCreateNewUsers": boolean, 
      "id": string /* from authmodule */, 
      "aliases": [alias, ...] /* from authmodule */, 
      "name": string /* from authmodule */, 
      "ordinal": int /* from authmodule */, 
      "accountsSize": int /* from authmodule */, 
      "disabled": boolean /* from authmodule */, 
      "isDefault": boolean /* from authmodule */, 
      "autoJoinGroups": [userGroup, ...] /* from authmodule */
  }

userDashboard

extends uuid


  {
    "dashboard": dashboard, 
    "user": user, 
    "favorite": boolean, 
    "ordinal": int, 
      "id": 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 */, 
      "aliases": [alias, ...] /* from uuid */
  }

userGroup

extends authorityHolder


  {
    "description": string, 
    "iconUrl": string, 
    "autoJoin": boolean, 
    "autoJoinDomain": string, 
    "requiredTwoFactorAuthentication": boolean, 
    "parentsRequireTwoFactorAuthentication": boolean, 
    "users": [user, ...], 
    "ownUsers": [user, ...], 
    "userCount": int, 
    "parent": userGroup, 
    "subgroups": [userGroup, ...], 
    "teams": [projectTeam, ...], 
    "organizations": [organization, ...], 
    "project": project, 
    "allUsers": boolean, 
    "registeredUsers": boolean, 
    "implicit": boolean, 
    "queriedSingleton": boolean, 
    "removable": boolean, 
    "immutable": boolean, 
      "id": string /* from authorityHolder */, 
      "aliases": [alias, ...] /* from authorityHolder */, 
      "name": string /* from authorityHolder */, 
      "projectRoles": [projectRole, ...] /* from authorityHolder */, 
      "transitiveProjectRoles": [projectRole, ...] /* from authorityHolder */, 
      "sourcedProjectRoles": [sourcedProjectRole, ...] /* from authorityHolder */, 
      "organizationRoles": [organizationRole, ...] /* from authorityHolder */, 
      "transitiveOrganizationRoles": [organizationRole, ...] /* from authorityHolder */, 
      "sourcedOrganizationRoles": [sourcedOrganizationRole, ...] /* from authorityHolder */
  }

userGroupDashboardPermission

extends dashboardPermission


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

userType

  {
    "id": string, 
    "name": string
  }
  

uuid

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


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

vcsUserName

  {
    "name": string
  }
  

webauthnDevice

  {
    "enabled": boolean, 
    "name": string, 
    "vendor": string, 
    "url": string, 
    "iconUrl": string
  }
  

extends uuid


  {
    "key": string, 
    "version": string, 
    "installedVersion": string, 
    "latestVersion": string, 
    "installedFromRepository": boolean, 
    "archiveId": string, 
    "manifest": raw, 
    "disabled": boolean, 
    "applicationNames": [string, ...], 
    "accessibleServices": [service, ...], 
    "capabilities": [string, ...], 
    "repositoryUrl": string, 
    "repositoryIconUrl": string, 
      "id": string /* from uuid */, 
      "aliases": [alias, ...] /* from uuid */
  }

Last modified: 7 November 2024