@kattebak/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @kattebak/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://your-domain.atlassian.net

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AnalyticsApi | getViewers | GET /wiki/rest/api/analytics/content/{contentId}/viewers | Get viewers AnalyticsApi | getViews | GET /wiki/rest/api/analytics/content/{contentId}/views | Get views AuditApi | createAuditRecord | POST /wiki/rest/api/audit | Create audit record AuditApi | exportAuditRecords | GET /wiki/rest/api/audit/export | Export audit records AuditApi | getAuditRecords | GET /wiki/rest/api/audit | Get audit records AuditApi | getAuditRecordsForTimePeriod | GET /wiki/rest/api/audit/since | Get audit records for time period AuditApi | getRetentionPeriod | GET /wiki/rest/api/audit/retention | Get retention period AuditApi | setRetentionPeriod | PUT /wiki/rest/api/audit/retention | Set retention period ContentApi | archivePages | POST /wiki/rest/api/content/archive | Archive pages ContentApi | publishLegacyDraft | POST /wiki/rest/api/content/blueprint/instance/{draftId} | Publish legacy draft ContentApi | publishSharedDraft | PUT /wiki/rest/api/content/blueprint/instance/{draftId} | Publish shared draft ContentApi | searchContentByCQL | GET /wiki/rest/api/content/search | Search content by CQL ContentAttachmentsApi | createAttachment | POST /wiki/rest/api/content/{id}/child/attachment | Create attachment ContentAttachmentsApi | createOrUpdateAttachments | PUT /wiki/rest/api/content/{id}/child/attachment | Create or update attachment ContentAttachmentsApi | downloadAttatchment | GET /wiki/rest/api/content/{id}/child/attachment/{attachmentId}/download | Get URI to download attachment ContentAttachmentsApi | updateAttachmentData | POST /wiki/rest/api/content/{id}/child/attachment/{attachmentId}/data | Update attachment data ContentAttachmentsApi | updateAttachmentProperties | PUT /wiki/rest/api/content/{id}/child/attachment/{attachmentId} | Update attachment properties ContentBodyApi | asyncConvertContentBodyRequest | POST /wiki/rest/api/contentbody/convert/async/{to} | Asynchronously convert content body ContentBodyApi | asyncConvertContentBodyResponse | GET /wiki/rest/api/contentbody/convert/async/{id} | Get asynchronously converted content body from the id or the current status of the task. ContentBodyApi | bulkAsyncConvertContentBodyRequest | POST /wiki/rest/api/contentbody/convert/async/bulk/tasks | Create asynchronous content body conversion tasks in bulk ContentBodyApi | bulkAsyncConvertContentBodyResponse | GET /wiki/rest/api/contentbody/convert/async/bulk/tasks | Get asynchronous content body conversion task result in bulk ContentChildrenAndDescendantsApi | copyPage | POST /wiki/rest/api/content/{id}/copy | Copy single page ContentChildrenAndDescendantsApi | copyPageHierarchy | POST /wiki/rest/api/content/{id}/pagehierarchy/copy | Copy page hierarchy ContentChildrenAndDescendantsApi | getContentDescendants | GET /wiki/rest/api/content/{id}/descendant | Get content descendants ContentChildrenAndDescendantsApi | getDescendantsOfType | GET /wiki/rest/api/content/{id}/descendant/{type} | Get content descendants by type ContentChildrenAndDescendantsApi | movePage | PUT /wiki/rest/api/content/{pageId}/move/{position}/{targetId} | Move a page to a new location relative to a target page ContentLabelsApi | addLabelsToContent | POST /wiki/rest/api/content/{id}/label | Add labels to content ContentLabelsApi | removeLabelFromContent | DELETE /wiki/rest/api/content/{id}/label/{label} | Remove label from content ContentLabelsApi | removeLabelFromContentUsingQueryParameter | DELETE /wiki/rest/api/content/{id}/label | Remove label from content using query parameter ContentMacroBodyApi | getAndAsyncConvertMacroBodyByMacroId | GET /wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}/convert/async/{to} | Get macro body by macro ID and convert representation Asynchronously ContentMacroBodyApi | getAndConvertMacroBodyByMacroId | GET /wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}/convert/{to} | Get macro body by macro ID and convert the representation synchronously ContentMacroBodyApi | getMacroBodyByMacroId | GET /wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId} | Get macro body by macro ID ContentPermissionsApi | checkContentPermission | POST /wiki/rest/api/content/{id}/permission/check | Check content permissions ContentRestrictionsApi | addGroupToContentRestrictionByGroupId | PUT /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId} | Add group to content restriction ContentRestrictionsApi | addRestrictions | POST /wiki/rest/api/content/{id}/restriction | Add restrictions ContentRestrictionsApi | addUserToContentRestriction | PUT /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user | Add user to content restriction ContentRestrictionsApi | deleteRestrictions | DELETE /wiki/rest/api/content/{id}/restriction | Delete restrictions ContentRestrictionsApi | getContentRestrictionStatusForUser | GET /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user | Get content restriction status for user ContentRestrictionsApi | getIndividualGroupRestrictionStatusByGroupId | GET /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId} | Get content restriction status for group ContentRestrictionsApi | getRestrictions | GET /wiki/rest/api/content/{id}/restriction | Get restrictions ContentRestrictionsApi | getRestrictionsByOperation | GET /wiki/rest/api/content/{id}/restriction/byOperation | Get restrictions by operation ContentRestrictionsApi | getRestrictionsForOperation | GET /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey} | Get restrictions for operation ContentRestrictionsApi | removeGroupFromContentRestriction | DELETE /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId} | Remove group from content restriction ContentRestrictionsApi | removeUserFromContentRestriction | DELETE /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user | Remove user from content restriction ContentRestrictionsApi | updateRestrictions | PUT /wiki/rest/api/content/{id}/restriction | Update restrictions ContentStatesApi | getAvailableContentStates | GET /wiki/rest/api/content/{id}/state/available | Gets available content states for content. ContentStatesApi | getContentState | GET /wiki/rest/api/content/{id}/state | Get content state ContentStatesApi | getContentStateSettings | GET /wiki/rest/api/space/{spaceKey}/state/settings | Get content state settings for space ContentStatesApi | getContentsWithState | GET /wiki/rest/api/space/{spaceKey}/state/content | Get content in space with given content state ContentStatesApi | getCustomContentStates | GET /wiki/rest/api/content-states | Get Custom Content States ContentStatesApi | getSpaceContentStates | GET /wiki/rest/api/space/{spaceKey}/state | Get space suggested content states ContentStatesApi | removeContentState | DELETE /wiki/rest/api/content/{id}/state | Removes the content state of a content and publishes a new version. ContentStatesApi | setContentState | PUT /wiki/rest/api/content/{id}/state | Set the content state of a content and publishes a new version of the content. ContentVersionsApi | deleteContentVersion | DELETE /wiki/rest/api/content/{id}/version/{versionNumber} | Delete content version ContentVersionsApi | restoreContentVersion | POST /wiki/rest/api/content/{id}/version | Restore content version ContentWatchesApi | addContentWatcher | POST /wiki/rest/api/user/watch/content/{contentId} | Add content watcher ContentWatchesApi | addLabelWatcher | POST /wiki/rest/api/user/watch/label/{labelName} | Add label watcher ContentWatchesApi | addSpaceWatcher | POST /wiki/rest/api/user/watch/space/{spaceKey} | Add space watcher ContentWatchesApi | getContentWatchStatus | GET /wiki/rest/api/user/watch/content/{contentId} | Get content watch status ContentWatchesApi | getWatchersForSpace | GET /wiki/rest/api/space/{spaceKey}/watch | Get space watchers ContentWatchesApi | getWatchesForPage | GET /wiki/rest/api/content/{id}/notification/child-created | Get watches for page ContentWatchesApi | getWatchesForSpace | GET /wiki/rest/api/content/{id}/notification/created | Get watches for space ContentWatchesApi | isWatchingLabel | GET /wiki/rest/api/user/watch/label/{labelName} | Get label watch status ContentWatchesApi | isWatchingSpace | GET /wiki/rest/api/user/watch/space/{spaceKey} | Get space watch status ContentWatchesApi | removeContentWatcher | DELETE /wiki/rest/api/user/watch/content/{contentId} | Remove content watcher ContentWatchesApi | removeLabelWatcher | DELETE /wiki/rest/api/user/watch/label/{labelName} | Remove label watcher ContentWatchesApi | removeSpaceWatch | DELETE /wiki/rest/api/user/watch/space/{spaceKey} | Remove space watch DynamicModulesApi | getModules | GET /atlassian-connect/1/app/module/dynamic | Get modules DynamicModulesApi | registerModules | POST /atlassian-connect/1/app/module/dynamic | Register modules DynamicModulesApi | removeModules | DELETE /atlassian-connect/1/app/module/dynamic | Remove modules ExperimentalApi | addLabelsToSpace | POST /wiki/rest/api/space/{spaceKey}/label | Add labels to a space ExperimentalApi | deleteLabelFromSpace | DELETE /wiki/rest/api/space/{spaceKey}/label | Remove label from a space ExperimentalApi | deletePageTree | DELETE /wiki/rest/api/content/{id}/pageTree | Delete page tree ExperimentalApi | getLabelsForSpace | GET /wiki/rest/api/space/{spaceKey}/label | Get Space Labels GroupApi | addUserToGroupByGroupId | POST /wiki/rest/api/group/userByGroupId | Add member to group by groupId GroupApi | createGroup | POST /wiki/rest/api/group | Create new user group GroupApi | getGroupByGroupId | GET /wiki/rest/api/group/by-id | Get group GroupApi | getGroupMembersByGroupId | GET /wiki/rest/api/group/{groupId}/membersByGroupId | Get group members GroupApi | getGroups | GET /wiki/rest/api/group | Get groups GroupApi | removeGroupById | DELETE /wiki/rest/api/group/by-id | Delete user group GroupApi | removeMemberFromGroupByGroupId | DELETE /wiki/rest/api/group/userByGroupId | Remove member from group using group id GroupApi | searchGroups | GET /wiki/rest/api/group/picker | Search groups by partial query LabelInfoApi | getAllLabelContent | GET /wiki/rest/api/label | Get label information LongRunningTaskApi | getTask | GET /wiki/rest/api/longtask/{id} | Get long-running task LongRunningTaskApi | getTasks | GET /wiki/rest/api/longtask | Get long-running tasks RelationApi | createRelationship | PUT /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey} | Create relationship RelationApi | deleteRelationship | DELETE /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey} | Delete relationship RelationApi | findSourcesForTarget | GET /wiki/rest/api/relation/{relationName}/to/{targetType}/{targetKey}/from/{sourceType} | Find source entities related to a target entity RelationApi | findTargetFromSource | GET /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType} | Find target entities related to a source entity RelationApi | getRelationship | GET /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey} | Find relationship from source to target SearchApi | searchByCQL | GET /wiki/rest/api/search | Search content SearchApi | searchUser | GET /wiki/rest/api/search/user | Search users SettingsApi | getLookAndFeelSettings | GET /wiki/rest/api/settings/lookandfeel | Get look and feel settings SettingsApi | getSystemInfo | GET /wiki/rest/api/settings/systemInfo | Get system info SettingsApi | resetLookAndFeelSettings | DELETE /wiki/rest/api/settings/lookandfeel/custom | Reset look and feel settings SettingsApi | updateLookAndFeel | PUT /wiki/rest/api/settings/lookandfeel | Select look and feel settings SettingsApi | updateLookAndFeelSettings | POST /wiki/rest/api/settings/lookandfeel/custom | Update look and feel settings SpaceApi | createPrivateSpace | POST /wiki/rest/api/space/_private | Create private space SpaceApi | createSpace | POST /wiki/rest/api/space | Create space SpaceApi | deleteSpace | DELETE /wiki/rest/api/space/{spaceKey} | Delete space SpaceApi | updateSpace | PUT /wiki/rest/api/space/{spaceKey} | Update space SpacePermissionsApi | addCustomContentPermissions | POST /wiki/rest/api/space/{spaceKey}/permission/custom-content | Add new custom content permission to space SpacePermissionsApi | addPermissionToSpace | POST /wiki/rest/api/space/{spaceKey}/permission | Add new permission to space SpacePermissionsApi | removePermission | DELETE /wiki/rest/api/space/{spaceKey}/permission/{id} | Remove a space permission SpaceSettingsApi | getSpaceSettings | GET /wiki/rest/api/space/{spaceKey}/settings | Get space settings SpaceSettingsApi | updateSpaceSettings | PUT /wiki/rest/api/space/{spaceKey}/settings | Update space settings TemplateApi | createContentTemplate | POST /wiki/rest/api/template | Create content template TemplateApi | getBlueprintTemplates | GET /wiki/rest/api/template/blueprint | Get blueprint templates TemplateApi | getContentTemplate | GET /wiki/rest/api/template/{contentTemplateId} | Get content template TemplateApi | getContentTemplates | GET /wiki/rest/api/template/page | Get content templates TemplateApi | removeTemplate | DELETE /wiki/rest/api/template/{contentTemplateId} | Remove template TemplateApi | updateContentTemplate | PUT /wiki/rest/api/template | Update content template ThemesApi | getGlobalTheme | GET /wiki/rest/api/settings/theme/selected | Get global theme ThemesApi | getSpaceTheme | GET /wiki/rest/api/space/{spaceKey}/theme | Get space theme ThemesApi | getTheme | GET /wiki/rest/api/settings/theme/{themeKey} | Get theme ThemesApi | getThemes | GET /wiki/rest/api/settings/theme | Get themes ThemesApi | resetSpaceTheme | DELETE /wiki/rest/api/space/{spaceKey}/theme | Reset space theme ThemesApi | setSpaceTheme | PUT /wiki/rest/api/space/{spaceKey}/theme | Set space theme UserPropertiesApi | createUserProperty | POST /wiki/rest/api/user/{userId}/property/{key} | Create user property by key UserPropertiesApi | deleteUserProperty | DELETE /wiki/rest/api/user/{userId}/property/{key} | Delete user property UserPropertiesApi | getUserProperties | GET /wiki/rest/api/user/{userId}/property | Get user properties UserPropertiesApi | getUserProperty | GET /wiki/rest/api/user/{userId}/property/{key} | Get user property UserPropertiesApi | updateUserProperty | PUT /wiki/rest/api/user/{userId}/property/{key} | Update user property UsersApi | getAnonymousUser | GET /wiki/rest/api/user/anonymous | Get anonymous user UsersApi | getBulkUserLookup | GET /wiki/rest/api/user/bulk | Get multiple users using ids UsersApi | getCurrentUser | GET /wiki/rest/api/user/current | Get current user UsersApi | getGroupMembershipsForUser | GET /wiki/rest/api/user/memberof | Get group memberships for user UsersApi | getPrivacyUnsafeUserEmail | GET /wiki/rest/api/user/email | Get user email address UsersApi | getPrivacyUnsafeUserEmailBulk | GET /wiki/rest/api/user/email/bulk | Get user email addresses in batch UsersApi | getUser | GET /wiki/rest/api/user | Get user

Documentation For Models

• AccountId
• AccountIdEmailRecord
• AddContentRestriction
• AddContentRestrictionRestrictions
• AddContentRestrictionRestrictionsGroupInner
• AddContentRestrictionRestrictionsUserInner
• AddLabelsToContentRequest
• AffectedObject
• ArchivePagesRequest
• ArchivePagesRequestPagesInner
• AsyncContentBody
• AsyncContentBodyExpandable
• AsyncContentBodyMediaToken
• AsyncId
• AttachmentPropertiesUpdateBody
• AttachmentPropertiesUpdateBodyMetadata
• AttachmentUpdate
• AttachmentUpdateContainer
• AttachmentUpdateMetadata
• AttachmentUpdateVersion
• AuditRecord
• AuditRecordArray
• AuditRecordAuthor
• AuditRecordCreate
• AuditRecordCreateAuthor
• AvailableContentStates
• BlueprintTemplate
• BlueprintTemplateArray
• BlueprintTemplateExpandable
• BlueprintTemplateOriginalTemplate
• Breadcrumb
• BulkContentBodyConversionInput
• BulkUserLookup
• BulkUserLookupArray
• BulkUserLookupExpandable
• ButtonLookAndFeel
• CQLPersonalDataConvertedQueries
• CQLPersonalDataMigrationRequest
• ChangedValue
• ConnectModules
• ContainerLookAndFeel
• ContainerSummary
• Content
• ContentArray
• ContentBlogpost
• ContentBlueprintDraft
• ContentBlueprintDraftAncestorsInner
• ContentBlueprintDraftSpace
• ContentBlueprintDraftVersion
• ContentBody
• ContentBodyConversionInput
• ContentBodyCreate
• ContentBodyCreateStorage
• ContentBodyExpandable
• ContentChildType
• ContentChildTypeAttachment
• ContentChildTypeExpandable
• ContentChildren
• ContentChildrenExpandable
• ContentCreate
• ContentCreateAncestorsInner
• ContentCreateBody
• ContentCreateContainer
• ContentCreateContainerId
• ContentCreateSpace
• ContentCreateSpaceDescription
• ContentCreateSpaceDescriptionExpandable
• ContentCreateSpaceHistory
• ContentCreateSpaceMetadata
• ContentExpandable
• ContentHistory
• ContentHistoryContributors
• ContentHistoryExpandable
• ContentLookAndFeel
• ContentMetadata
• ContentMetadataCurrentuser
• ContentMetadataCurrentuserExpandable
• ContentMetadataCurrentuserFavourited
• ContentMetadataCurrentuserLastcontributed
• ContentMetadataCurrentuserLastmodified
• ContentMetadataCurrentuserViewed
• ContentMetadataLabels
• ContentPageResponse
• ContentPermissionRequest
• ContentProperty
• ContentPropertyArray
• ContentPropertyCreate
• ContentPropertyCreateNoKey
• ContentPropertyExpandable
• ContentPropertyUpdate
• ContentPropertyUpdateVersion
• ContentPropertyUpdateVersionNumber
• ContentPropertyValue
• ContentPropertyVersion
• ContentRestriction
• ContentRestrictionAddOrUpdateArray
• ContentRestrictionAddOrUpdateArrayOneOf
• ContentRestrictionArray
• ContentRestrictionExpandable
• ContentRestrictionRestrictions
• ContentRestrictionRestrictionsExpandable
• ContentRestrictionUpdate
• ContentRestrictionUpdateRestrictions
• ContentRestrictionUpdateRestrictionsGroupInner
• ContentRestrictionUpdateRestrictionsUser
• ContentRestrictions
• ContentRestrictionsExpandable
• ContentState
• ContentStateResponse
• ContentStateRestInput
• ContentStateSettings
• ContentTemplate
• ContentTemplateArray
• ContentTemplateBody
• ContentTemplateBodyCreate
• ContentTemplateCreate
• ContentTemplateCreateSpace
• ContentTemplateOriginalTemplate
• ContentTemplateUpdate
• ContentTemplateUpdateSpace
• ContentUpdate
• ContentUpdateAncestorsInner
• ContentUpdateAncestorsInnerId
• ContentUpdateBody
• ContentUpdateVersion
• CopyPageHierarchyRequest
• CopyPageHierarchyTitleOptions
• CopyPageRequest
• CopyPageRequestBody
• CopyPageRequestDestination
• DynamicModulesErrorMessage
• EmbeddedContent
• GenericLinksValue
• GetRestrictionsByOperation200ResponseValue
• GetViewers200Response
• GetViews200Response
• GlobalSpaceIdentifier
• Group
• GroupArray
• GroupArrayWithLinks
• GroupCreate
• GroupName
• HeaderLookAndFeel
• HorizontalHeaderLookAndFeel
• Icon
• Label
• LabelArray
• LabelCreate
• LabelDetails
• LabeledContent
• LabeledContentPageResponse
• LabeledContentType
• LongTask
• LongTaskLinks
• LongTaskStatus
• LongTaskStatusAdditionalDetails
• LongTaskStatusArray
• LongTaskStatusName
• LongTaskStatusWithLinks
• LongTaskStatusWithLinksAdditionalDetails
• LookAndFeel
• LookAndFeelHeadings
• LookAndFeelSelection
• LookAndFeelSettings
• LookAndFeelWithLinks
• MacroInstance
• MenusLookAndFeel
• MenusLookAndFeelHoverOrFocus
• Message
• MessageArgsInner
• MovePage200Response
• NavigationLookAndFeel
• NavigationLookAndFeelHoverOrFocus
• OperationCheckResult
• PermissionCheckResponse
• PermissionSubject
• PermissionSubjectWithGroupId
• PropertyValue
• Relation
• RelationArray
• RelationData
• RelationExpandable
• RelationSource
• RetentionPeriod
• ScreenLookAndFeel
• ScreenLookAndFeelLayer
• SearchFieldLookAndFeel
• SearchPageResponseSearchResult
• SearchResult
• Space
• SpaceArray
• SpaceCreate
• SpaceDescription
• SpaceDescriptionCreate
• SpaceDescriptionCreatePlain
• SpaceExpandable
• SpaceMetadata
• SpacePermission
• SpacePermissionCreate
• SpacePermissionCreateSubjects
• SpacePermissionCreateSubjectsGroup
• SpacePermissionCreateSubjectsUser
• SpacePermissionCustomContent
• SpacePermissionCustomContentOperationsInner
• SpacePermissionRequest
• SpacePermissionSubjects
• SpacePermissionSubjectsGroup
• SpacePermissionSubjectsUser
• SpacePermissionV2
• SpacePermissionV2Operation
• SpaceProperty
• SpacePropertyArray
• SpacePropertyCreate
• SpacePropertyCreateNoKey
• SpacePropertyCreateSpace
• SpacePropertyExpandable
• SpacePropertyUpdate
• SpacePropertyValue
• SpaceSettings
• SpaceSettingsEditor
• SpaceSettingsUpdate
• SpaceUpdate
• SpaceWatch
• SpaceWatchArray
• SuperBatchWebResources
• SuperBatchWebResourcesTags
• SuperBatchWebResourcesUris
• SuperBatchWebResourcesUrisAll
• SystemInfoEntity
• Task
• TaskPageResponse
• TaskStatusUpdate
• Theme
• ThemeArray
• ThemeNoLinks
• ThemeUpdate
• TopNavigationLookAndFeel
• TopNavigationLookAndFeelHoverOrFocus
• User
• UserAnonymous
• UserAnonymousExpandable
• UserArray
• UserDetails
• UserDetailsBusiness
• UserDetailsPersonal
• UserProperty
• UserPropertyCreate
• UserPropertyKeyArray
• UserPropertyKeyArrayResultsInner
• UserPropertyUpdate
• UserWatch
• UsersUserKeys
• Version
• VersionArray
• VersionExpandable
• VersionRestore
• VersionRestoreParams
• Watch
• WatchArray
• WatchUser
• WebResourceDependencies
• WebResourceDependenciesExpandable
• WebResourceDependenciesTags
• WebResourceDependenciesUris
• WebResourceDependenciesUrisExpandable

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

oAuthDefinitions

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://auth.atlassian.com/authorize
• Scopes:
• read:confluence-content.all: Read all content, including content body (expansions permitted). Note, APIs using this scope may also return data allowed by read:confluence-space.summary. However, this scope is not a substitute for read:confluence-space.summary.
• read:confluence-content.permission: Read content permissions.
• read:confluence-content.summary: Read a summary of the content, which is the content without expansions. Note, APIs using this scope may also return data allowed by read:confluence-space.summary. However, this scope is not a substitute for read:confluence-space.summary.
• write:confluence-content: Permits the creation of pages, blogs, comments and questions.
• read:confluence-space.summary: Read a summary of space information without expansions.
• write:confluence-space: Create, update and delete space information.
• write:confluence-file: Upload attachments.
• read:confluence-props: Read content properties.
• write:confluence-props: Write content properties.
• search:confluence: Search Confluence. Note, APIs using this scope may also return data allowed by read:confluence-space.summary and read:confluence-content.summary. However, this scope is not a substitute for read:confluence-space.summary or read:confluence-content.summary.
• manage:confluence-configuration: Manage global settings.
• read:confluence-groups: Read user groups.
• write:confluence-groups: Create, remove and update user groups.
• read:confluence-user: Read users.
• readonly:content.attachment:confluence: Download attachments of a Confluence page or blogpost that you have access to.
• read:content:confluence: View content.
• read:content-details:confluence: View content details.
• write:content:confluence: Create and update content.
• delete:content:confluence: Delete content.
• read:space-details:confluence: View space details.
• read:analytics.content:confluence: View analytics for content.
• read:audit-log:confluence: View audit records.
• write:audit-log:confluence: Create audit records.
• read:configuration:confluence: View Confluence settings.
• write:configuration:confluence: Update Confluence settings.
• read:page:confluence: View pages.
• write:page:confluence: Create and update pages.
• delete:page:confluence: Delete pages.
• read:blogpost:confluence: View blogposts.
• write:blogpost:confluence: Create and update blogposts.
• delete:blogpost:confluence: Delete blogposts.
• read:whiteboard:confluence: View whiteboards.
• write:whiteboard:confluence: Create and update whiteboards.
• delete:whiteboard:confluence: Delete whiteboards.
• read:custom-content:confluence: View custom content.
• write:custom-content:confluence: Create and update custom content.
• delete:custom-content:confluence: Delete custom content.
• read:attachment:confluence: View and download content attachments.
• write:attachment:confluence: Create and update attachments.
• delete:attachment:confluence: Delete attachments.
• read:comment:confluence: View comments.
• write:comment:confluence: Create and update comments.
• delete:comment:confluence: Delete comments.
• read:template:confluence: View content templates.
• write:template:confluence: Create, update and delete content templates.
• read:label:confluence: View labels.
• write:label:confluence: Add and remove labels.
• read:content.permission:confluence: Check content permissions.
• read:content.property:confluence: View content properties.
• write:content.property:confluence: Create, update and delete content properties.
• read:content.restriction:confluence: View content restrictions.
• write:content.restriction:confluence: Update content restrictions.
• read:content.metadata:confluence: View content summaries.
• read:watcher:confluence: View content watchers.
• write:watcher:confluence: Add and remove content watchers.
• read:group:confluence: View groups.
• write:group:confluence: Create and delete groups.
• read:inlinetask:confluence: View tasks.
• write:inlinetask:confluence: Update tasks.
• read:relation:confluence: View entity relationships.
• write:relation:confluence: Create and update entity relationships.
• read:space:confluence: View spaces.
• write:space:confluence: Create and update spaces.
• delete:space:confluence: Delete spaces.
• read:space.permission:confluence: View space permissions.
• write:space.permission:confluence: Update space permissions.
• read:space.property:confluence: View space properties.
• write:space.property:confluence: Create, update and delete space properties.
• read:user.property:confluence: View user properties.
• write:user.property:confluence: Create, update and delete user properties.
• read:space.setting:confluence: View space settings.
• write:space.setting:confluence: Update space settings.
• read:user:confluence: View user details.
• moderate:core-content:confluence: Moderate core contents
• moderate:comment:confluence: Moderate comments
• read:email-address:confluence: View email addresses of all users regardless of the user’s profile visibility settings.