Documentation's navigation


On this page


 

Prefix

The Space Privacy API prefix is /rest/extranet/1.0/ for all endpoints listed below.

REST API

The stability of the REST API is not guaranteed.
{"openapi":"3.0.1","paths":{"/darkfeature":{"get":{"operationId":"getDarkFeatures","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DarkFeatureDto"}}}}}}}},"/darkfeature/disable/{featureKey}":{"get":{"operationId":"disableDarkFeature","parameters":[{"name":"featureKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/darkfeature/enable/{featureKey}":{"get":{"operationId":"enableDarkFeature","parameters":[{"name":"featureKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/customfilter":{"get":{"operationId":"getCustomFilters","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomFilterDto"}}}}}}},"put":{"operationId":"saveCustomFilters","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/CustomFilterDto"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/extranet-privacy-granted-field-values":{"get":{"operationId":"get","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UiSupportValue"}}}}}}},"/config/autosynchronization":{"get":{"operationId":"getAutoSynchronizationConfig","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoSynchronizationDto"}}}}}}},"/config/autosynchronization/enable":{"put":{"operationId":"enableAutoSynchronization","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/config/autosynchronization/disable":{"put":{"operationId":"disableAutoSynchronization","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/check/user-directory-permissions":{"get":{"operationId":"getUserDirectoryPermissions","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDirectoriesStateDto"}}}}}}},"/export":{"get":{"operationId":"export","responses":{"default":{"description":"default response","content":{"application/octet-stream":{}}}}}},"/reindex/user":{"post":{"operationId":"reindexUsers","responses":{"default":{"description":"default response","content":{"*/*":{}}}}},"delete":{"operationId":"skipReindex","responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/reindex/user/require":{"post":{"operationId":"setReindexMarker","responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/postinstall/post-install-info-confirmation":{"post":{"operationId":"setPostInstallInfoConfirmation","requestBody":{"content":{"application/json":{"schema":{"type":"string","enum":["CONFIRMED","UNCONFIRMED"]}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/administrator/space/{spaceKey}":{"get":{"operationId":"getExtranetUserManagersLegacy","parameters":[{"name":"spaceKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConfluenceUserDto"}}}}}}},"put":{"operationId":"assignExtranetUserManager","parameters":[{"name":"spaceKey","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfluenceSpaceDto"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/administrator/space/{spaceKey}/users":{"get":{"operationId":"getExtranetUserManagers","parameters":[{"name":"spaceKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConfluenceUserDto"}}}}}}}},"/administrator/space/{spaceKey}/managers":{"get":{"operationId":"searchExtranetManagers","parameters":[{"name":"spaceKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"userManager","in":"query","schema":{"type":"boolean"}},{"name":"spaceManager","in":"query","schema":{"type":"boolean"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConfluenceUserDto"}}}}}}}},"/administrator/space/{spaceKey}/search":{"get":{"operationId":"searchExtranetManagers_1","parameters":[{"name":"spaceKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","schema":{"type":"string","default":""}},{"name":"managerType","in":"query","schema":{"type":"string","enum":["ALL_MANAGERS","SPACE_MANAGERS_ONLY","USER_MANAGERS_ONLY"],"default":"ALL_MANAGERS"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageExtranetUserRelationDto"}}}}}}},"/administrator/space/{spaceKey}/{userKey}":{"delete":{"operationId":"removeExtranetUserManager","parameters":[{"name":"spaceKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"userKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/administrator/group/space/{spaceKey}":{"delete":{"operationId":"removeExtranetAdminGroupFromExtranet","parameters":[{"name":"spaceKey","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/administrator/space/{spaceKey}/groups":{"get":{"operationId":"getExtranetGroupRelations","parameters":[{"name":"spaceKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageExtranetGroupRelationDto"}}}}}}},"/administrator/convert/default":{"post":{"operationId":"convertAllExtranetSpacesToDefaultSpaces","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/cleanup/group-permissions-status":{"get":{"operationId":"getCleanupExtranetGroupPermissionsProgress","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Progress"}}}}}}},"/cleanup/group-permissions":{"post":{"operationId":"cleanupGroupPermissions","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/cleanup/extranet-space-access-status":{"get":{"operationId":"getCleanupExtranetSpaceAccessProgress","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Progress"}}}}}}},"/cleanup/extranet-space-access":{"post":{"operationId":"cleanupExtranetSpaceAccess","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/cleanup/global-extranet-access-status":{"get":{"operationId":"getCleanupGlobalExtranetAccessProgress","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Progress"}}}}}}},"/cleanup/global-extranet-access":{"post":{"operationId":"cleanupGlobalExtranetAccess","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/group/space/{spaceKey}":{"get":{"operationId":"getExtranetGroupRelations_1","parameters":[{"name":"spaceKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageExtranetGroupRelationDto"}}}}}},"put":{"operationId":"assignGroupsToExtranet","parameters":[{"name":"spaceKey","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetGroupDto"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"delete":{"operationId":"removeExtranetGroupFromExtranet","parameters":[{"name":"spaceKey","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/index-state/{spaceKey}/checkandfix":{"get":{"operationId":"checkAndFix","parameters":[{"name":"spaceKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAndFixResultDto"}}}}}}},"/index-state/{spaceKey}/canupdatelist":{"get":{"operationId":"userListIsUpdatable","parameters":[{"name":"spaceKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserListStateForSpaceDto"}}}}}}},"/role/{roleName}/active":{"put":{"operationId":"toggleActive","parameters":[{"name":"roleName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/role/{roleName}/spacepermission":{"get":{"operationId":"getSpacePermissionsForRole","parameters":[{"name":"roleName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtranetRoleDto"}}}}}}},"/role/spacepermission":{"get":{"operationId":"getSpacePermissionsForAllRoles","parameters":[{"name":"onlyActive","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetRoleDto"}}}}}}},"put":{"operationId":"updatePermissionsForRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtranetRoleDto"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtranetRoleDto"}}}}}}},"/role/update-progress":{"get":{"operationId":"getUpdateProgress","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgressDto"}}}}}}},"/role":{"get":{"operationId":"list","parameters":[{"name":"onlyActive","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetRoleDto"}}}}}}},"put":{"operationId":"update","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetRoleDto"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetRoleDto"}}}}}}}},"/space/statistics":{"get":{"operationId":"getStatistics","parameters":[{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageExtranetSpaceStatisticsDto"}}}}}}},"/space":{"post":{"operationId":"createExtranetSpace","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfluenceSpaceDto"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/space/{spaceKey}":{"post":{"operationId":"convertExtranetSpace","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfluenceSpaceDto"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/space/convert/default/{spaceKey}":{"post":{"operationId":"convertExtranetSpaceToDefaultSpace","parameters":[{"name":"spaceKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/sync/activation-sync-status":{"get":{"operationId":"getActivationSyncStatus","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Progress"}}}}}}},"/sync/activation-sync":{"post":{"operationId":"runActivationSync","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/sync/progress":{"get":{"operationId":"getSyncProgress","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Progress"}}}}}}},"/user/space/{spaceKey}":{"get":{"operationId":"getExtranetUsers","parameters":[{"name":"spaceKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","schema":{"type":"string"}},{"name":"roleName","in":"query","schema":{"type":"string"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageExtranetUserRelationDto"}}}}}},"put":{"operationId":"assignUsersToExtranet","parameters":[{"name":"spaceKey","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetUserDto"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"operationId":"saveExtranetUser","parameters":[{"name":"spaceKey","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfluenceUserDto"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/user/exists":{"get":{"operationId":"userAlreadyExists","parameters":[{"name":"username","in":"query","schema":{"type":"string"}},{"name":"spaceKey","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/user/roles":{"get":{"operationId":"getExtranetUserRoles","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetRoleDto"}}}}}}}},"/user/space/{spaceKey}/{userKey}":{"delete":{"operationId":"removeExtranetUserFromExtranet","parameters":[{"name":"spaceKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"userKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/welcomemail":{"get":{"operationId":"getWelcomeMailTranslations","parameters":[{"name":"spaceKey","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WelcomeMailDto"}}}}}}}},"/welcomemail/example":{"get":{"operationId":"getExampleWelcomeMailTranslations","parameters":[{"name":"spaceKey","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WelcomeMailDto"}}}}}}}},"/settings/extranet-space-access-mode":{"get":{"operationId":"getExtranetSpaceAccessMode","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"string","enum":["BY_GROUP_PERMISSIONS","BY_SINGLE_PERMISSIONS"]}}}}}},"put":{"operationId":"setExtranetSpaceAccessMode","requestBody":{"content":{"application/json":{"schema":{"type":"string","enum":["BY_GROUP_PERMISSIONS","BY_SINGLE_PERMISSIONS"]}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/visibilitycheck/canseeuser":{"get":{"operationId":"canSeeUser","parameters":[{"name":"selectedUserName","in":"query","schema":{"type":"string"}},{"name":"userNameToCheck","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/admin/allowedadminroles":{"get":{"operationId":"getAllowedAdminRoles","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}},"post":{"operationId":"setAllowedAdminRoles","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/predefined-admin-roles":{"put":{"operationId":"addInitialExtranetPermissions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PredefinedAdminsDto"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/predefined-admin-roles/groups":{"get":{"operationId":"getInitialAdminGroups","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageExtranetGroupRelationDto"}}}}}}},"/predefined-admin-roles/groups/{groupName}":{"delete":{"operationId":"removeInitialAdminGroup","parameters":[{"name":"groupName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/predefined-admin-roles/users":{"get":{"operationId":"getInitialAdminUsers","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageExtranetUserRelationDto"}}}}}}},"/predefined-admin-roles/users/{userKey}":{"delete":{"operationId":"removeInitialAdminUser","parameters":[{"name":"userKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/predefined-admin-roles/user-managers":{"get":{"operationId":"getInitialUserAdmins","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserOrGroupDto"}}}}}}}},"/predefined-admin-roles/space-managers":{"get":{"operationId":"getInitialSpaceAdmins","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserOrGroupDto"}}}}}}}},"/admin/createuser":{"get":{"operationId":"isUserCreateModeActive","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreateDto"}}}}}},"post":{"operationId":"saveUserCreateSettings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreateDto"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/config/visibility":{"get":{"operationId":"getVisibilityConfig","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VisibilityConfigDto"}}}}}},"post":{"operationId":"saveVisibilityConfig","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VisibilityConfigDto"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}}},"components":{"schemas":{"DarkFeatureDto":{"type":"object","properties":{"featureKey":{"type":"string"},"enabled":{"type":"boolean"}}},"CustomFilterDto":{"type":"object","properties":{"filterUrl":{"type":"string"}}},"UiFieldValue":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"}}},"UiSupportValue":{"type":"object","properties":{"suggestedResults":{"type":"array","items":{"$ref":"#/components/schemas/UiFieldValue"}},"searchResults":{"type":"array","items":{"$ref":"#/components/schemas/UiFieldValue"}}}},"AutoSynchronizationDto":{"type":"object","properties":{"activationSyncEnabled":{"type":"boolean"}}},"UserDirectoriesStateDto":{"type":"object","properties":{"writableDirectories":{"type":"array","items":{"$ref":"#/components/schemas/UserDirectoryDto"}},"nonWritableDirectories":{"type":"array","items":{"$ref":"#/components/schemas/UserDirectoryDto"}},"userDirectoryStateMessage":{"$ref":"#/components/schemas/UserDirectoryStateMessage"}}},"UserDirectoryDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string"}}},"UserDirectoryStateMessage":{"type":"object","properties":{"messageType":{"type":"string"},"message":{"type":"string"}}},"ConfluenceSpaceDto":{"type":"object","properties":{"spaceKey":{"type":"string"},"spaceName":{"type":"string"},"extranetUserManagers":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetUserDto"}},"extranetSpaceManagers":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetUserDto"}},"extranetUserManagerGroups":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetGroupDto"}},"extranetSpaceManagerGroups":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetGroupDto"}}}},"ConfluenceUser":{"type":"object","properties":{"lowerName":{"type":"string"},"key":{"$ref":"#/components/schemas/UserKey"},"email":{"type":"string"},"fullName":{"type":"string"},"name":{"type":"string"}}},"ExtranetGroupDto":{"type":"object","properties":{"role":{"type":"string"},"welcomeMailParameters":{"$ref":"#/components/schemas/WelcomeMailParameters"},"groupname":{"$ref":"#/components/schemas/Groupname"},"id":{"type":"string"}}},"ExtranetUserDto":{"type":"object","properties":{"role":{"type":"string"},"welcomeMailParameters":{"$ref":"#/components/schemas/WelcomeMailParameters"},"userKey":{"type":"string"},"username":{"type":"string"},"idType":{"type":"string","enum":["UserKey","Username"]},"id":{"type":"string"}}},"Groupname":{"type":"object"},"UserKey":{"type":"object","properties":{"stringValue":{"type":"string"}}},"WelcomeMailParameters":{"type":"object","properties":{"sendMail":{"type":"boolean"},"sender":{"$ref":"#/components/schemas/ConfluenceUser"},"receiver":{"$ref":"#/components/schemas/ConfluenceUser"},"spaceKey":{"type":"string"},"mailLanguage":{"type":"string","enum":["EN","DE"]}}},"ConfluenceUserDto":{"type":"object","properties":{"userKey":{"type":"string"},"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"password":{"type":"string"},"role":{"type":"string"},"kind":{"type":"string"},"welcomeMailParameters":{"$ref":"#/components/schemas/WelcomeMailParameters"},"sendResetPasswordMail":{"type":"boolean"}}},"ExtranetDto":{"type":"object","properties":{"spaceKey":{"type":"string"},"spaceName":{"type":"string"}}},"ExtranetGroupRelationDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"extranet":{"$ref":"#/components/schemas/ExtranetDto"},"groupname":{"$ref":"#/components/schemas/Groupname"},"role":{"$ref":"#/components/schemas/ExtranetRoleDto"},"kind":{"type":"string","enum":["PARTICIPANT","USER_MANAGER","EXTRANET_MANAGER","GROUP_PARTICIPANT","GROUP_RELATION"]},"spaceAdmin":{"type":"boolean"}}},"ExtranetRoleDto":{"type":"object","properties":{"defined":{"type":"boolean"},"name":{"type":"string"},"active":{"type":"boolean"},"i18nKey":{"type":"string"},"permissionsForRole":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExtranetSpacePermissionDto"}},"label":{"type":"string"}}},"ExtranetSpacePermissionDto":{"type":"object","properties":{"name":{"type":"string"},"enabled":{"type":"boolean"},"editable":{"type":"boolean"}}},"ExtranetUserRelationDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"user":{"$ref":"#/components/schemas/ConfluenceUserDto"},"extranet":{"$ref":"#/components/schemas/ExtranetDto"},"role":{"$ref":"#/components/schemas/ExtranetRoleDto"},"kinds":{"type":"array","items":{"type":"string","enum":["PARTICIPANT","USER_MANAGER","EXTRANET_MANAGER","GROUP_PARTICIPANT","GROUP_RELATION"]}},"groupRelations":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetGroupRelationDto"}},"spaceAdmin":{"type":"boolean"},"groupRelation":{"type":"boolean"},"participant":{"type":"boolean"},"userManager":{"type":"boolean"},"active":{"type":"boolean"}}},"PageExtranetUserRelationDto":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetUserRelationDto"}}}},"PageExtranetGroupRelationDto":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetGroupRelationDto"}}}},"Progress":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"currentCount":{"type":"integer","format":"int32"},"percentage":{"type":"integer","format":"int32"},"timeRemaining":{"type":"string"},"running":{"type":"boolean"}}},"CheckAndFixResultDto":{"type":"object","properties":{"usersInExtranet":{"type":"integer","format":"int32"},"usersInIndex":{"type":"integer","format":"int32"},"inSync":{"type":"boolean"},"message":{"type":"string"}}},"UserListStateForSpaceDto":{"type":"object","properties":{"operation":{"type":"string","enum":["CHANGE","INDEX","DONE"]},"totalUsers":{"type":"integer","format":"int32"},"progressedUsers":{"type":"integer","format":"int32"},"usersToProgress":{"type":"integer","format":"int32"}}},"ProgressDto":{"type":"object","properties":{"currentTotal":{"type":"integer","format":"int32"},"alreadyProcessed":{"type":"integer","format":"int32"},"done":{"type":"boolean"}}},"ExtranetSpaceStatisticsDto":{"type":"object","properties":{"extranet":{"$ref":"#/components/schemas/ExtranetDto"},"userCount":{"type":"integer","format":"int32"}}},"PageExtranetSpaceStatisticsDto":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"totalResults":{"type":"integer","format":"int32"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetSpaceStatisticsDto"}}}},"WelcomeMailDto":{"type":"object"},"PredefinedAdminsDto":{"type":"object","properties":{"extranetUserManagers":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetUserDto"}},"extranetSpaceManagers":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetUserDto"}},"extranetUserManagerGroups":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetGroupDto"}},"extranetSpaceManagerGroups":{"type":"array","items":{"$ref":"#/components/schemas/ExtranetGroupDto"}}}},"UserOrGroupDto":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"text":{"type":"string"},"imgSrc":{"type":"string"}}},"UserCreateDto":{"type":"object","properties":{"additionalGroupNames":{"type":"array","items":{"type":"string"}},"userCreateModeEnabled":{"type":"boolean"}}},"VisibilityConfigDto":{"type":"object","properties":{"internalGroupsMode":{"type":"string","enum":["ALL","RESTRICTED"]},"internalGroupsNames":{"type":"array","items":{"type":"string"}},"visibilityMode":{"type":"string","enum":["CONFLUENCE_STANDARD","RESTRICTED"]},"restrictExtranetUserManager":{"type":"boolean"}}}}}}



Link to this page: https://seibert.biz/sp-apis


This page was last edited on 09/28/2023.