Child pages
  • Space Privacy - Extranet for Confluence - Developer Guide 2.6
Skip to end of metadata
Go to start of metadata

REST API

The stability of the REST API is not guaranteed.
{ "swagger": "2.0", "info": { "version": "2.3.2", "title": "Space Privacy - Extranet for Confluence" }, "paths": { "/admin/allowedadminroles": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "type": "string" } } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/admin/createuser": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/UserCreateDto" } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserCreateDto" } } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/administrator/convert/default": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { } } } } }, "/administrator/group/space/{spaceKey}/{groupName}": { "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "groupName", "in": "path", "required": true }, { "type": "string", "name": "spaceKey", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/administrator/space/{spaceKey}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "spaceKey", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/ConfluenceUserDto" } } }, "404": { "description": "Not Found", "headers": { }, "schema": { "type": "string" } } }, "deprecated": true }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "spaceKey", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfluenceSpaceDto" } } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/administrator/space/{spaceKey}/groups": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "spaceKey", "in": "path", "required": true }, { "type": "integer", "name": "page", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ExtranetGroupRelationDto;>" } }, "404": { "description": "Not Found", "headers": { }, "schema": { "type": "string" } } } } }, "/administrator/space/{spaceKey}/search": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "spaceKey", "in": "path", "required": true }, { "type": "integer", "name": "maxResults", "in": "query", "required": true }, { "type": "integer", "name": "page", "in": "query", "required": true }, { "type": "string", "name": "search", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/UserSearchPagination" } }, "404": { "description": "Not Found", "headers": { }, "schema": { "type": "string" } } } } }, "/administrator/space/{spaceKey}/users": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "spaceKey", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/ConfluenceUserDto" } } }, "404": { "description": "Not Found", "headers": { }, "schema": { "type": "string" } } }, "deprecated": true } }, "/administrator/space/{spaceKey}/{userKey}": { "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "spaceKey", "in": "path", "required": true }, { "type": "string", "name": "userKey", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/check/user-directory-permissions": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/UserDirectoriesStateDto" } } } } }, "/cleanup/extranet-space-access": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/cleanup/global-group-memberships": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/cleanup/global-group-memberships-status": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ExtranetTaskProgressDto" } } } } }, "/cleanup/group-permissions": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/cleanup/group-permissions-status": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ExtranetTaskProgressDto" } } } } }, "/cleanup/managed-groups-status": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ExtranetTaskProgressDto" } } } } }, "/config/autosynchronization": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/AutoSynchronizationDto" } } } } }, "/config/autosynchronization/disable": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/config/autosynchronization/enable": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/config/visibility": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/VisibilityConfigDto" } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VisibilityConfigDto" } } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/customfilter": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/CustomFilterDto" } } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/CustomFilterDto" } } } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/darkfeature": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/DarkFeatureDto" } } } } } }, "/darkfeature/disable/{featureKey}": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "featureKey", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "boolean" } } } } }, "/darkfeature/enable/{featureKey}": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "featureKey", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "boolean" } } } } }, "/extranet-privacy-granted-field-values": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ExtranetPrivacyGrantedFieldValuesResource$UiSupportValue" } } } } }, "/group/space/{spaceKey}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "spaceKey", "in": "path", "required": true }, { "type": "integer", "name": "page", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ExtranetGroupRelationDto;>" } }, "404": { "description": "Not Found", "headers": { }, "schema": { "type": "string" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "spaceKey", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/ExtranetGroupDto" } } } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/group/space/{spaceKey}/{groupName}": { "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "groupName", "in": "path", "required": true }, { "type": "string", "name": "spaceKey", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/postinstall/post-install-info-confirmation": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "string", "enum": [ "CONFIRMED", "UNCONFIRMED" ] } } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/predefined-admin-roles": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PredefinedAdminsDto" } } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/predefined-admin-roles/groups": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "integer", "name": "page", "in": "query", "required": false, "default": "0" } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ExtranetGroupRelationDto;>" } } } } }, "/predefined-admin-roles/groups/{groupName}": { "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "groupName", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/predefined-admin-roles/space-managers": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/UserOrGroupDto" } } } } } }, "/predefined-admin-roles/user-managers": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/UserOrGroupDto" } } } } } }, "/predefined-admin-roles/users": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "integer", "name": "page", "in": "query", "required": false, "default": "0" } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/UserSearchPagination" } } } } }, "/predefined-admin-roles/users/{userKey}": { "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "userKey", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/role": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "boolean", "name": "onlyActive", "in": "query", "required": false, "default": "false" } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/ExtranetRoleDto" } } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/ExtranetRoleDto" } } } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/ExtranetRoleDto" } } } } } }, "/role/spacepermission": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "boolean", "name": "onlyActive", "in": "query", "required": false, "default": "false" } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/ExtranetRoleDto" } } } }, "deprecated": true }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExtranetRoleDto" } } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ExtranetRoleDto" } } }, "deprecated": true } }, "/role/update-progress": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ProgressDto" } } } } }, "/role/{roleName}/active": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "roleName", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content", "headers": { } } }, "deprecated": true } }, "/role/{roleName}/spacepermission": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "roleName", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ExtranetRoleDto" } } }, "deprecated": true } }, "/settings/extranet-space-access-mode": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "string", "enum": [ "BY_GROUP_PERMISSIONS", "BY_SINGLE_PERMISSIONS" ] } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "string", "enum": [ "BY_GROUP_PERMISSIONS", "BY_SINGLE_PERMISSIONS" ] } } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/space": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfluenceSpaceDto" } } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/space/convert/default/{spaceKey}": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "spaceKey", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/space/{spaceKey}": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfluenceSpaceDto" } } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/sync/activation-sync": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/sync/activation-sync-status": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ExtranetTaskProgressDto" } } } } }, "/sync/progress": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ExtranetTaskProgressDto" } } } } }, "/user/exists": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "spaceKey", "in": "query", "required": true }, { "type": "string", "name": "username", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "boolean" } } } } }, "/user/progress/{spaceKey}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "spaceKey", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ProgressDto" } } } } }, "/user/roles": { "get": { "description": "Returns all active extranet user roles", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/ExtranetRoleDto" } } } } } }, "/user/space/{spaceKey}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "spaceKey", "in": "path", "required": true }, { "type": "integer", "name": "maxResults", "in": "query", "required": true }, { "type": "integer", "name": "page", "in": "query", "required": true }, { "type": "string", "name": "roleName", "in": "query", "required": true }, { "type": "string", "name": "search", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/UserSearchPagination" } }, "404": { "description": "Not Found", "headers": { }, "schema": { "type": "string" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "spaceKey", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/ExtranetUserDto" } } } ], "responses": { "204": { "description": "No Content", "headers": { } } } }, "post": { "description": "Speichert einen neuen Extranetbenutzer.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "spaceKey", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfluenceUserDto" }, "description": "das DTO eines Extranetbenutzers." } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/user/space/{spaceKey}/{userKey}": { "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "spaceKey", "in": "path", "required": true }, { "type": "string", "name": "userKey", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/user/{spaceKey}/canupdatelist": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "spaceKey", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/UserListStateForSpaceDto" } }, "404": { "description": "Not Found", "headers": { }, "schema": { "type": "string" } } } } }, "/welcomemail": { "get": { "description": "All possible translations for the welcome mail", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "spaceKey", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/WelcomeMailDto" } } } } } } }, "definitions": { "AutoSynchronizationDto": { "properties": { "activationSyncEnabled": { "type": "boolean" } } }, "ConfluenceSpaceDto": { "properties": { "extranetSpaceManagerGroups": { "type": "array", "items": { "$ref": "#/definitions/ExtranetGroupDto" } }, "extranetSpaceManagers": { "type": "array", "items": { "$ref": "#/definitions/ExtranetUserDto" } }, "extranetUserManagerGroups": { "type": "array", "items": { "$ref": "#/definitions/ExtranetGroupDto" } }, "extranetUserManagers": { "type": "array", "items": { "$ref": "#/definitions/ExtranetUserDto" } }, "spaceKey": { "type": "string" }, "spaceName": { "type": "string" } } }, "ConfluenceUser": { "properties": { "email": { "type": "string" }, "fullName": { "type": "string" }, "key": { "$ref": "#/definitions/UserKey" }, "name": { "type": "string" } } }, "ConfluenceUserDto": { "properties": { "email": { "type": "string" }, "fullName": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "role": { "type": "string" }, "sendResetPasswordMail": { "type": "boolean" }, "userKey": { "type": "string" }, "welcomeMailParameters": { "$ref": "#/definitions/WelcomeMailParameters" } } }, "CustomFilterDto": { "properties": { "filterUrl": { "type": "string" } } }, "DarkFeatureDto": { "properties": { "enabled": { "type": "boolean" }, "featureKey": { "type": "string" } } }, "ExtranetGroupDto": { "properties": { "groupname": { "$ref": "#/definitions/Groupname" }, "id": { "type": "string" }, "role": { "type": "string" }, "welcomeMailParameters": { "$ref": "#/definitions/WelcomeMailParameters" } } }, "ExtranetGroupRelationDto;>": { "properties": { "currentPage": { "type": "integer" }, "currentPagesElements": { "type": "object" } } }, "ExtranetPrivacyGrantedFieldValuesResource$UiFieldValue": { "properties": { "id": { "type": "string" }, "text": { "type": "string" } } }, "ExtranetPrivacyGrantedFieldValuesResource$UiSupportValue": { "properties": { "searchResults": { "type": "array", "items": { "$ref": "#/definitions/ExtranetPrivacyGrantedFieldValuesResource$UiFieldValue" } }, "suggestedResults": { "type": "array", "items": { "$ref": "#/definitions/ExtranetPrivacyGrantedFieldValuesResource$UiFieldValue" } } } }, "ExtranetRoleDto": { "properties": { "active": { "type": "boolean" }, "defined": { "type": "boolean" }, "i18nKey": { "type": "string" }, "label": { "type": "string" }, "name": { "type": "string" }, "permissionsForRole": { "type": "object" } } }, "ExtranetTaskProgressDto": { "properties": { "percentage": { "type": "integer" }, "running": { "type": "boolean" }, "timeRemaining": { "type": "string" } } }, "ExtranetUserDto": { "properties": { "id": { "type": "string" }, "idType": { "type": "string", "enum": [ "UserKey", "Username" ] }, "role": { "type": "string" }, "userKey": { "type": "string" }, "username": { "type": "string" }, "welcomeMailParameters": { "$ref": "#/definitions/WelcomeMailParameters" } } }, "Groupname": { "type": "string" }, "PredefinedAdminsDto": { "properties": { "extranetSpaceManagerGroups": { "type": "array", "items": { "$ref": "#/definitions/ExtranetGroupDto" } }, "extranetSpaceManagers": { "type": "array", "items": { "$ref": "#/definitions/ExtranetUserDto" } }, "extranetUserManagerGroups": { "type": "array", "items": { "$ref": "#/definitions/ExtranetGroupDto" } }, "extranetUserManagers": { "type": "array", "items": { "$ref": "#/definitions/ExtranetUserDto" } } } }, "ProgressDto": { "properties": { "alreadyProcessed": { "type": "integer" }, "currentTotal": { "type": "integer" }, "done": { "type": "boolean" } } }, "UserCreateDto": { "properties": { "additionalGroupNames": { "type": "array", "items": { "type": "string" } }, "userCreateModeEnabled": { "type": "boolean" } } }, "UserDirectoriesStateDto": { "properties": { "nonWritableDirectories": { "type": "array", "items": { "$ref": "#/definitions/UserDirectoryDto" } }, "userDirectoryStateMessage": { "$ref": "#/definitions/UserDirectoryStateMessage" }, "writableDirectories": { "type": "array", "items": { "$ref": "#/definitions/UserDirectoryDto" } } } }, "UserDirectoryDto": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "type": "string" } } }, "UserDirectoryStateMessage": { "properties": { "message": { "type": "string" }, "messageType": { "type": "string" } } }, "UserKey": { "properties": { "stringValue": { "type": "string" } } }, "UserListStateForSpaceDto": { "properties": { "operation": { "type": "string", "enum": [ "CHANGE", "DONE", "INDEX" ] }, "progressedUsers": { "type": "integer" }, "totalUsers": { "type": "integer" } } }, "UserOrGroupDto": { "properties": { "id": { "type": "string" }, "imgSrc": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string" } } }, "UserSearchPagination": { "properties": { "currentPage": { "type": "integer" }, "pages": { "type": "integer" }, "users": { "type": "object" } } }, "VisibilityConfigDto": { "properties": { "internalGroupsNames": { "type": "array", "items": { "type": "string" } }, "restrictExtranetUserManager": { "type": "boolean" }, "visibilityMode": { "type": "string" } } }, "WelcomeMailDto": { "properties": { "message": { "type": "string" }, "welcomeMailLocale": { "type": "string", "enum": [ "DE", "EN" ] } } }, "WelcomeMailParameters": { "properties": { "mailLanguage": { "type": "string", "enum": [ "DE", "EN" ] }, "receiver": { "$ref": "#/definitions/ConfluenceUser" }, "sendMail": { "type": "boolean" }, "sender": { "$ref": "#/definitions/ConfluenceUser" }, "spaceKey": { "type": "string" } } } } }
  • No labels