Skip to content

API / API reference / Members

Get a member

Lunedo 0.1.0
Other versions
0.1.0 Nov 1, 2026

Opens the documentation of that release on GitHub.

GET
/api/v1/organizations/{organizationId}/members/{accountId}
Code sample: cURL
sh
curl -H "Authorization: Bearer ld_..." \
"https://wiki.example.org/api/v1/organizations/{organizationId}/members/{accountId}"

Returns a member with how they joined and sign in, their groups with the provider that manages them, and their roles in the spaces of the organization. Spaces are left out unless the caller may view the spaces of the organization; personal and confidential spaces never appear.

Requires the permission organization.members.manage on the organization in organizationId.

organizationId
required
string format: uuid

ID of the organization.

accountId
required
string format: uuid

ID of the member’s account.

The member.

Media typeapplication/json

A member of an organization with groups, spaces and sign-in.

object
accountId
required

ID of the account.

string format: uuid
name
required

Display name of the account.

string
jobTitle
required

Job title the person entered on their profile, or null.

string | null
pictureRef
required

Version of the profile picture, or null without one. Changes whenever the picture changes; load the picture from GET /api/v1/accounts/{accountId}/picture.

string | null
email
required

E-mail address, or null for service accounts.

string | null
accountType
required

standard, guest, portal or service.

string
kind
required

Kind of membership in the organization.

string
Allowed values: member collaborator guest
expiresAt
required
Any of:
string format: date-time
responsibleAccountId
required
Any of:
string format: uuid
roles
required

Roles assigned directly to the account in this organization.

Array<object>

A role assigned directly to the account.

object
assignmentId
required

ID of the role assignment.

string format: uuid
role
required

Name of the role.

string
customRoleId
required
Any of:
string format: uuid
expiresAt
required
Any of:
string format: date-time
groups
required

Groups of this organization the account belongs to, ordered by name.

Array<object>

A group of the organization the account belongs to.

object
id
required

ID of the group.

string format: uuid
name
required

Name of the group.

string
twoFactorActive
required

Whether the account has a confirmed authenticator app or a passkey.

boolean
managedBy
required
Any of:
object
providerId
required

ID of the identity provider.

string format: uuid
providerName
required

Name of the identity provider.

string
providerType
required

Kind of identity provider. New values can be added in later versions; handle unknown values.

string
source
required

Why the provider manages the account: identity when an identity of the provider is linked, domain when the e-mail domain of the account is assigned to the provider.

string
Allowed values: identity domain
since
required

Since when the provider manages the account. ISO 8601 timestamp in UTC.

string format: date-time
lastActiveAt
required
Any of:
string format: date-time
joinedAt
required

When the person joined the organization. ISO 8601 timestamp in UTC.

string format: date-time
invitedBy
required
Any of:
object
id
required

Account ID.

string format: uuid
name
required

Name.

string
homeOrganization
required

Whether this is the home organization of the account.

boolean
twoFactorRequired
required

Whether the organization requires a second factor.

boolean
signIn
required

How the person signs in.

object
password
required

Whether the account has a password.

boolean
providers
required

Identity providers linked to the account.

Array<object>

An identity provider.

object
providerId
required

ID of the identity provider.

string format: uuid
providerName
required

Name of the identity provider.

string
groupDetails
required

Groups of this organization the person belongs to, ordered by name.

Array<object>

A group the person belongs to.

object
id
required

ID of the group.

string format: uuid
name
required

Name of the group.

string
managedBy
required
Any of:

An identity provider.

object
providerId
required

ID of the identity provider.

string format: uuid
providerName
required

Name of the identity provider.

string
viaProvider
required
Any of:

An identity provider.

object
providerId
required

ID of the identity provider.

string format: uuid
providerName
required

Name of the identity provider.

string
spaces
required

How many spaces give the group a role.

integer
<= 9007199254740991
spaces
required
Any of:
Array<object>

A space the person has a role in.

object
id
required

ID of the space.

string format: uuid
key
required

Key of the space.

string
name
required

Name of the space.

string
role
required

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
sources
required

Where the roles come from; the highest is shown as role.

Array<object>

Where a role comes from.

object
kind
required

A role of the person, of a group or of all members.

string
Allowed values: direct group organizationMembers
groupId

The group, for group.

string format: uuid
groupName

Name of the group, for group.

string

Example

{
"accountId": "01929b1e-8d4b-7e3f-a05c-4d3e2f1a6b7c",
"name": "Ada Lovelace",
"jobTitle": "Head of Engineering",
"pictureRef": "5f2b8c1d9a0e4b7c",
"email": "[email protected]",
"accountType": "standard",
"kind": "member",
"expiresAt": null,
"responsibleAccountId": null,
"roles": [
{
"assignmentId": "01929b1e-9e5c-7f40-b16d-5e4f3a2b7c8d",
"role": "administrator",
"customRoleId": null,
"expiresAt": null
}
],
"groups": [
{
"id": "01929b1e-7a3b-7c2d-8e1f-0a9b8c7d6e5f",
"name": "Engineering"
}
],
"twoFactorActive": true,
"managedBy": null,
"lastActiveAt": "2026-10-24T08:15:00.000Z",
"joinedAt": "2026-08-21T09:58:00.000Z",
"invitedBy": {
"id": "01929b1e-8d4b-7e3f-a05c-4d3e2f1a6b70",
"name": "Olivia Owner"
},
"homeOrganization": true,
"twoFactorRequired": false,
"signIn": {
"password": true,
"providers": []
},
"groupDetails": [
{
"id": "01929b1e-7a3b-7c2d-8e1f-0a9b8c7d6e5f",
"name": "Engineering",
"managedBy": null,
"viaProvider": null,
"spaces": 2
}
],
"spaces": [
{
"id": "01929b1e-7a3b-7c2d-8e1f-0a9b8c7d6e60",
"key": "ITOPS",
"name": "IT Operations",
"role": "editor",
"sources": [
{
"kind": "group",
"groupId": "01929b1e-7a3b-7c2d-8e1f-0a9b8c7d6e5f",
"groupName": "Engineering"
}
]
}
]
}

ambiguousCredentials: The request carries both a session and an API token. invalidInput: The request is not valid.

Media typeapplication/problem+json

Error response following RFC 9457 Problem Details.

object
type
required

Stable identifier of the error kind. Clients branch on this value.

string
title
required

Short summary of the error kind. It does not change between occurrences.

string
status
required

HTTP status code of the response.

integer
>= -9007199254740991 <= 9007199254740991
detail

Explanation of this occurrence, for people.

string
code
required

The last part of type, for clients that prefer a short key.

string
fields

Invalid fields, for invalidInput, invalidStorageSettings, invalidBackupSettings and the codes about the address of a chat channel.

Array<string>
denials

Why the request was not allowed, for forbidden.

Array<string>
retryAfterSeconds

Seconds to wait before retrying, for rateLimited, locked and busy.

integer
>= -9007199254740991 <= 9007199254740991
problem

Which password rule failed, for passwordPolicy; why the address of a chat channel was refused, for invalidChatAddress; which storage setting was refused (invalidThresholds, invalidS3Limit, invalidContacts or invalidTeamsWebhook), for invalidStorageSettings; which backup setting was refused, for invalidBackupSettings; whether a backup or a testRestore is running, for backupRunning; why the backup target could not be used (a failure of Test connection, such as notFound or credentials, or missingSecret), for backupTargetFailed.

string
step

What Lunedo was doing with the backup target when it failed, for backupTargetFailed.

string
Allowed values: write read delete list
refusal

What the full storage refuses, for storageFull: an upload, or a large write such as an import.

string
Allowed values: upload largeWrite
minLength

Minimum password length, for passwordPolicy.

integer
>= -9007199254740991 <= 9007199254740991
lockedBy

Level that locked the setting, for settingLocked.

string
minimum

Lowest allowed value, for settingBelowMinimum.

number
maximum
Any of:
number
maxLifetimeDays

Maximum lifetime of API tokens in days, for expiryRequired and expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
domains

Domains that belong to another identity provider, for domainInUse.

Array<string>
instanceUrl

The current address of the instance, for instanceMoved.

string
providerId

ID of the identity provider that manages the account, for managedAccount and managedDomain.

string
providerName

Name of the identity provider that manages the account, for managedAccount and managedDomain.

string
accounts

Number of accounts still linked to the identity provider, for providerHasAccounts.

integer
>= -9007199254740991 <= 9007199254740991
maxBytes

Largest allowed file size in bytes, for fileTooLarge and uploadTooLarge; storage limit of the organization’s imports, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
usedBytes

Bytes the organization’s imports use already, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
missing

Number of parts still missing, for uploadIncomplete.

integer
>= -9007199254740991 <= 9007199254740991
uncoveredPages

Number of pages below that your own role does not cover, for shareBeyondOwnAccess.

integer
>= -9007199254740991 <= 9007199254740991
maxDays

Longest allowed lifetime of a link for anyone in days, for expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
pages

Number of pages that give access to groups or through broad links, for confidentialSharing; number of pages that would lose the status, for statusInUse; number of pages the caller cannot open, for hiddenContent.

integer
>= -9007199254740991 <= 9007199254740991
sections

Required sections that are empty or missing, for requiredSectionsEmpty.

Array<object>

A required section.

object
key
required

Key of the section.

string
title
required

Heading of the section.

string
articles

Number of articles more people could read, for audienceWidening and categoryVisibilityWidening.

integer
>= -9007199254740991 <= 9007199254740991
translations

Number of translations into the language, for defaultLanguageTranslated.

integer
>= -9007199254740991 <= 9007199254740991
translationId

The existing translation, for translationExists.

string format: uuid
light

Check of the light mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
dark

Check of the dark mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
impact

Who gains and who loses access, with the confirmation to send, for moveChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the content leaves a confidential space and loses its protection.

boolean
confirmation
required

Send this with the move to confirm exactly this change, or null when access does not change. Valid for one hour.

string | null
copyImpact

Who could read the copy but not the source, with the confirmation to send, for copyChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the copy leaves a confidential space and is not protected by it.

boolean
widerAccess
required

True when people can read the copy who cannot read the source; the copy then needs the confirmation.

boolean
confirmation
required

Send this with the copy to confirm exactly this access, or null when nobody gains access. Valid for one hour.

string | null
items
required

Number of items the copy creates.

integer
>= -9007199254740991 <= 9007199254740991
hidden
required

Number of items below that are left out because the caller cannot read them.

integer
>= -9007199254740991 <= 9007199254740991
skipped
required

Number of items below that are left out because they cannot be copied.

integer
>= -9007199254740991 <= 9007199254740991
background
required

True when the copy is large and runs in the background.

boolean
formerParent
Any of:
object
id
required

ID of the former parent page.

string format: uuid
title
required

Title of the former parent page.

string
parentEntries

Number of trash entries of former parent pages the caller can restore together with the content, for restrictedParentInTrash; 0 when the caller cannot restore all of them.

integer
>= -9007199254740991 <= 9007199254740991
fileVersion

Format or editor schema version of the file, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
supportedVersion

Highest format or editor schema version this Lunedo reads, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
templateIndex

Position of the template in the file, counted from 0, for templateNameTaken.

integer
>= -9007199254740991 <= 9007199254740991
templateProblems

What is wrong with the templates of the file, for invalidTemplatesInFile.

Array<object>

A problem in a template of the file.

object
place
required

Where in the template, such as field 3 or content.

string | null
message
required

Explanation for people, naming the template and the place.

string
maintenanceMessage

The message of the instance administrators about the maintenance, for maintenanceMode and signInPaused. Empty when they wrote none.

string
problems

What is wrong with the document, for invalidDocument and invalidComment.

Array<object>

A problem in the document.

object
path
required

Position in the document, such as .content[2].content[0].

string
code
required

Kind of problem, such as unknownNode or invalidAttribute.

string
message
required

Explanation for people.

string

Examples

{
"type": "urn:lunedo:problem:ambiguousCredentials",
"title": "The request carries both a session and an API token",
"status": 400,
"code": "ambiguousCredentials"
}

invalidApiToken: The API token is not valid. notSignedIn: Sign in or send an API token.

Media typeapplication/problem+json

Error response following RFC 9457 Problem Details.

object
type
required

Stable identifier of the error kind. Clients branch on this value.

string
title
required

Short summary of the error kind. It does not change between occurrences.

string
status
required

HTTP status code of the response.

integer
>= -9007199254740991 <= 9007199254740991
detail

Explanation of this occurrence, for people.

string
code
required

The last part of type, for clients that prefer a short key.

string
fields

Invalid fields, for invalidInput, invalidStorageSettings, invalidBackupSettings and the codes about the address of a chat channel.

Array<string>
denials

Why the request was not allowed, for forbidden.

Array<string>
retryAfterSeconds

Seconds to wait before retrying, for rateLimited, locked and busy.

integer
>= -9007199254740991 <= 9007199254740991
problem

Which password rule failed, for passwordPolicy; why the address of a chat channel was refused, for invalidChatAddress; which storage setting was refused (invalidThresholds, invalidS3Limit, invalidContacts or invalidTeamsWebhook), for invalidStorageSettings; which backup setting was refused, for invalidBackupSettings; whether a backup or a testRestore is running, for backupRunning; why the backup target could not be used (a failure of Test connection, such as notFound or credentials, or missingSecret), for backupTargetFailed.

string
step

What Lunedo was doing with the backup target when it failed, for backupTargetFailed.

string
Allowed values: write read delete list
refusal

What the full storage refuses, for storageFull: an upload, or a large write such as an import.

string
Allowed values: upload largeWrite
minLength

Minimum password length, for passwordPolicy.

integer
>= -9007199254740991 <= 9007199254740991
lockedBy

Level that locked the setting, for settingLocked.

string
minimum

Lowest allowed value, for settingBelowMinimum.

number
maximum
Any of:
number
maxLifetimeDays

Maximum lifetime of API tokens in days, for expiryRequired and expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
domains

Domains that belong to another identity provider, for domainInUse.

Array<string>
instanceUrl

The current address of the instance, for instanceMoved.

string
providerId

ID of the identity provider that manages the account, for managedAccount and managedDomain.

string
providerName

Name of the identity provider that manages the account, for managedAccount and managedDomain.

string
accounts

Number of accounts still linked to the identity provider, for providerHasAccounts.

integer
>= -9007199254740991 <= 9007199254740991
maxBytes

Largest allowed file size in bytes, for fileTooLarge and uploadTooLarge; storage limit of the organization’s imports, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
usedBytes

Bytes the organization’s imports use already, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
missing

Number of parts still missing, for uploadIncomplete.

integer
>= -9007199254740991 <= 9007199254740991
uncoveredPages

Number of pages below that your own role does not cover, for shareBeyondOwnAccess.

integer
>= -9007199254740991 <= 9007199254740991
maxDays

Longest allowed lifetime of a link for anyone in days, for expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
pages

Number of pages that give access to groups or through broad links, for confidentialSharing; number of pages that would lose the status, for statusInUse; number of pages the caller cannot open, for hiddenContent.

integer
>= -9007199254740991 <= 9007199254740991
sections

Required sections that are empty or missing, for requiredSectionsEmpty.

Array<object>

A required section.

object
key
required

Key of the section.

string
title
required

Heading of the section.

string
articles

Number of articles more people could read, for audienceWidening and categoryVisibilityWidening.

integer
>= -9007199254740991 <= 9007199254740991
translations

Number of translations into the language, for defaultLanguageTranslated.

integer
>= -9007199254740991 <= 9007199254740991
translationId

The existing translation, for translationExists.

string format: uuid
light

Check of the light mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
dark

Check of the dark mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
impact

Who gains and who loses access, with the confirmation to send, for moveChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the content leaves a confidential space and loses its protection.

boolean
confirmation
required

Send this with the move to confirm exactly this change, or null when access does not change. Valid for one hour.

string | null
copyImpact

Who could read the copy but not the source, with the confirmation to send, for copyChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the copy leaves a confidential space and is not protected by it.

boolean
widerAccess
required

True when people can read the copy who cannot read the source; the copy then needs the confirmation.

boolean
confirmation
required

Send this with the copy to confirm exactly this access, or null when nobody gains access. Valid for one hour.

string | null
items
required

Number of items the copy creates.

integer
>= -9007199254740991 <= 9007199254740991
hidden
required

Number of items below that are left out because the caller cannot read them.

integer
>= -9007199254740991 <= 9007199254740991
skipped
required

Number of items below that are left out because they cannot be copied.

integer
>= -9007199254740991 <= 9007199254740991
background
required

True when the copy is large and runs in the background.

boolean
formerParent
Any of:
object
id
required

ID of the former parent page.

string format: uuid
title
required

Title of the former parent page.

string
parentEntries

Number of trash entries of former parent pages the caller can restore together with the content, for restrictedParentInTrash; 0 when the caller cannot restore all of them.

integer
>= -9007199254740991 <= 9007199254740991
fileVersion

Format or editor schema version of the file, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
supportedVersion

Highest format or editor schema version this Lunedo reads, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
templateIndex

Position of the template in the file, counted from 0, for templateNameTaken.

integer
>= -9007199254740991 <= 9007199254740991
templateProblems

What is wrong with the templates of the file, for invalidTemplatesInFile.

Array<object>

A problem in a template of the file.

object
place
required

Where in the template, such as field 3 or content.

string | null
message
required

Explanation for people, naming the template and the place.

string
maintenanceMessage

The message of the instance administrators about the maintenance, for maintenanceMode and signInPaused. Empty when they wrote none.

string
problems

What is wrong with the document, for invalidDocument and invalidComment.

Array<object>

A problem in the document.

object
path
required

Position in the document, such as .content[2].content[0].

string
code
required

Kind of problem, such as unknownNode or invalidAttribute.

string
message
required

Explanation for people.

string

Examples

{
"type": "urn:lunedo:problem:invalidApiToken",
"title": "The API token is not valid",
"status": 401,
"code": "invalidApiToken"
}

forbidden: Not allowed.

Media typeapplication/problem+json

Error response following RFC 9457 Problem Details.

object
type
required

Stable identifier of the error kind. Clients branch on this value.

string
title
required

Short summary of the error kind. It does not change between occurrences.

string
status
required

HTTP status code of the response.

integer
>= -9007199254740991 <= 9007199254740991
detail

Explanation of this occurrence, for people.

string
code
required

The last part of type, for clients that prefer a short key.

string
fields

Invalid fields, for invalidInput, invalidStorageSettings, invalidBackupSettings and the codes about the address of a chat channel.

Array<string>
denials

Why the request was not allowed, for forbidden.

Array<string>
retryAfterSeconds

Seconds to wait before retrying, for rateLimited, locked and busy.

integer
>= -9007199254740991 <= 9007199254740991
problem

Which password rule failed, for passwordPolicy; why the address of a chat channel was refused, for invalidChatAddress; which storage setting was refused (invalidThresholds, invalidS3Limit, invalidContacts or invalidTeamsWebhook), for invalidStorageSettings; which backup setting was refused, for invalidBackupSettings; whether a backup or a testRestore is running, for backupRunning; why the backup target could not be used (a failure of Test connection, such as notFound or credentials, or missingSecret), for backupTargetFailed.

string
step

What Lunedo was doing with the backup target when it failed, for backupTargetFailed.

string
Allowed values: write read delete list
refusal

What the full storage refuses, for storageFull: an upload, or a large write such as an import.

string
Allowed values: upload largeWrite
minLength

Minimum password length, for passwordPolicy.

integer
>= -9007199254740991 <= 9007199254740991
lockedBy

Level that locked the setting, for settingLocked.

string
minimum

Lowest allowed value, for settingBelowMinimum.

number
maximum
Any of:
number
maxLifetimeDays

Maximum lifetime of API tokens in days, for expiryRequired and expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
domains

Domains that belong to another identity provider, for domainInUse.

Array<string>
instanceUrl

The current address of the instance, for instanceMoved.

string
providerId

ID of the identity provider that manages the account, for managedAccount and managedDomain.

string
providerName

Name of the identity provider that manages the account, for managedAccount and managedDomain.

string
accounts

Number of accounts still linked to the identity provider, for providerHasAccounts.

integer
>= -9007199254740991 <= 9007199254740991
maxBytes

Largest allowed file size in bytes, for fileTooLarge and uploadTooLarge; storage limit of the organization’s imports, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
usedBytes

Bytes the organization’s imports use already, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
missing

Number of parts still missing, for uploadIncomplete.

integer
>= -9007199254740991 <= 9007199254740991
uncoveredPages

Number of pages below that your own role does not cover, for shareBeyondOwnAccess.

integer
>= -9007199254740991 <= 9007199254740991
maxDays

Longest allowed lifetime of a link for anyone in days, for expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
pages

Number of pages that give access to groups or through broad links, for confidentialSharing; number of pages that would lose the status, for statusInUse; number of pages the caller cannot open, for hiddenContent.

integer
>= -9007199254740991 <= 9007199254740991
sections

Required sections that are empty or missing, for requiredSectionsEmpty.

Array<object>

A required section.

object
key
required

Key of the section.

string
title
required

Heading of the section.

string
articles

Number of articles more people could read, for audienceWidening and categoryVisibilityWidening.

integer
>= -9007199254740991 <= 9007199254740991
translations

Number of translations into the language, for defaultLanguageTranslated.

integer
>= -9007199254740991 <= 9007199254740991
translationId

The existing translation, for translationExists.

string format: uuid
light

Check of the light mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
dark

Check of the dark mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
impact

Who gains and who loses access, with the confirmation to send, for moveChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the content leaves a confidential space and loses its protection.

boolean
confirmation
required

Send this with the move to confirm exactly this change, or null when access does not change. Valid for one hour.

string | null
copyImpact

Who could read the copy but not the source, with the confirmation to send, for copyChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the copy leaves a confidential space and is not protected by it.

boolean
widerAccess
required

True when people can read the copy who cannot read the source; the copy then needs the confirmation.

boolean
confirmation
required

Send this with the copy to confirm exactly this access, or null when nobody gains access. Valid for one hour.

string | null
items
required

Number of items the copy creates.

integer
>= -9007199254740991 <= 9007199254740991
hidden
required

Number of items below that are left out because the caller cannot read them.

integer
>= -9007199254740991 <= 9007199254740991
skipped
required

Number of items below that are left out because they cannot be copied.

integer
>= -9007199254740991 <= 9007199254740991
background
required

True when the copy is large and runs in the background.

boolean
formerParent
Any of:
object
id
required

ID of the former parent page.

string format: uuid
title
required

Title of the former parent page.

string
parentEntries

Number of trash entries of former parent pages the caller can restore together with the content, for restrictedParentInTrash; 0 when the caller cannot restore all of them.

integer
>= -9007199254740991 <= 9007199254740991
fileVersion

Format or editor schema version of the file, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
supportedVersion

Highest format or editor schema version this Lunedo reads, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
templateIndex

Position of the template in the file, counted from 0, for templateNameTaken.

integer
>= -9007199254740991 <= 9007199254740991
templateProblems

What is wrong with the templates of the file, for invalidTemplatesInFile.

Array<object>

A problem in a template of the file.

object
place
required

Where in the template, such as field 3 or content.

string | null
message
required

Explanation for people, naming the template and the place.

string
maintenanceMessage

The message of the instance administrators about the maintenance, for maintenanceMode and signInPaused. Empty when they wrote none.

string
problems

What is wrong with the document, for invalidDocument and invalidComment.

Array<object>

A problem in the document.

object
path
required

Position in the document, such as .content[2].content[0].

string
code
required

Kind of problem, such as unknownNode or invalidAttribute.

string
message
required

Explanation for people.

string

Examples

Exampleforbidden
{
"type": "urn:lunedo:problem:forbidden",
"title": "Not allowed",
"status": 403,
"code": "forbidden"
}

notFound: Not found.

Media typeapplication/problem+json

Error response following RFC 9457 Problem Details.

object
type
required

Stable identifier of the error kind. Clients branch on this value.

string
title
required

Short summary of the error kind. It does not change between occurrences.

string
status
required

HTTP status code of the response.

integer
>= -9007199254740991 <= 9007199254740991
detail

Explanation of this occurrence, for people.

string
code
required

The last part of type, for clients that prefer a short key.

string
fields

Invalid fields, for invalidInput, invalidStorageSettings, invalidBackupSettings and the codes about the address of a chat channel.

Array<string>
denials

Why the request was not allowed, for forbidden.

Array<string>
retryAfterSeconds

Seconds to wait before retrying, for rateLimited, locked and busy.

integer
>= -9007199254740991 <= 9007199254740991
problem

Which password rule failed, for passwordPolicy; why the address of a chat channel was refused, for invalidChatAddress; which storage setting was refused (invalidThresholds, invalidS3Limit, invalidContacts or invalidTeamsWebhook), for invalidStorageSettings; which backup setting was refused, for invalidBackupSettings; whether a backup or a testRestore is running, for backupRunning; why the backup target could not be used (a failure of Test connection, such as notFound or credentials, or missingSecret), for backupTargetFailed.

string
step

What Lunedo was doing with the backup target when it failed, for backupTargetFailed.

string
Allowed values: write read delete list
refusal

What the full storage refuses, for storageFull: an upload, or a large write such as an import.

string
Allowed values: upload largeWrite
minLength

Minimum password length, for passwordPolicy.

integer
>= -9007199254740991 <= 9007199254740991
lockedBy

Level that locked the setting, for settingLocked.

string
minimum

Lowest allowed value, for settingBelowMinimum.

number
maximum
Any of:
number
maxLifetimeDays

Maximum lifetime of API tokens in days, for expiryRequired and expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
domains

Domains that belong to another identity provider, for domainInUse.

Array<string>
instanceUrl

The current address of the instance, for instanceMoved.

string
providerId

ID of the identity provider that manages the account, for managedAccount and managedDomain.

string
providerName

Name of the identity provider that manages the account, for managedAccount and managedDomain.

string
accounts

Number of accounts still linked to the identity provider, for providerHasAccounts.

integer
>= -9007199254740991 <= 9007199254740991
maxBytes

Largest allowed file size in bytes, for fileTooLarge and uploadTooLarge; storage limit of the organization’s imports, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
usedBytes

Bytes the organization’s imports use already, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
missing

Number of parts still missing, for uploadIncomplete.

integer
>= -9007199254740991 <= 9007199254740991
uncoveredPages

Number of pages below that your own role does not cover, for shareBeyondOwnAccess.

integer
>= -9007199254740991 <= 9007199254740991
maxDays

Longest allowed lifetime of a link for anyone in days, for expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
pages

Number of pages that give access to groups or through broad links, for confidentialSharing; number of pages that would lose the status, for statusInUse; number of pages the caller cannot open, for hiddenContent.

integer
>= -9007199254740991 <= 9007199254740991
sections

Required sections that are empty or missing, for requiredSectionsEmpty.

Array<object>

A required section.

object
key
required

Key of the section.

string
title
required

Heading of the section.

string
articles

Number of articles more people could read, for audienceWidening and categoryVisibilityWidening.

integer
>= -9007199254740991 <= 9007199254740991
translations

Number of translations into the language, for defaultLanguageTranslated.

integer
>= -9007199254740991 <= 9007199254740991
translationId

The existing translation, for translationExists.

string format: uuid
light

Check of the light mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
dark

Check of the dark mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
impact

Who gains and who loses access, with the confirmation to send, for moveChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the content leaves a confidential space and loses its protection.

boolean
confirmation
required

Send this with the move to confirm exactly this change, or null when access does not change. Valid for one hour.

string | null
copyImpact

Who could read the copy but not the source, with the confirmation to send, for copyChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the copy leaves a confidential space and is not protected by it.

boolean
widerAccess
required

True when people can read the copy who cannot read the source; the copy then needs the confirmation.

boolean
confirmation
required

Send this with the copy to confirm exactly this access, or null when nobody gains access. Valid for one hour.

string | null
items
required

Number of items the copy creates.

integer
>= -9007199254740991 <= 9007199254740991
hidden
required

Number of items below that are left out because the caller cannot read them.

integer
>= -9007199254740991 <= 9007199254740991
skipped
required

Number of items below that are left out because they cannot be copied.

integer
>= -9007199254740991 <= 9007199254740991
background
required

True when the copy is large and runs in the background.

boolean
formerParent
Any of:
object
id
required

ID of the former parent page.

string format: uuid
title
required

Title of the former parent page.

string
parentEntries

Number of trash entries of former parent pages the caller can restore together with the content, for restrictedParentInTrash; 0 when the caller cannot restore all of them.

integer
>= -9007199254740991 <= 9007199254740991
fileVersion

Format or editor schema version of the file, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
supportedVersion

Highest format or editor schema version this Lunedo reads, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
templateIndex

Position of the template in the file, counted from 0, for templateNameTaken.

integer
>= -9007199254740991 <= 9007199254740991
templateProblems

What is wrong with the templates of the file, for invalidTemplatesInFile.

Array<object>

A problem in a template of the file.

object
place
required

Where in the template, such as field 3 or content.

string | null
message
required

Explanation for people, naming the template and the place.

string
maintenanceMessage

The message of the instance administrators about the maintenance, for maintenanceMode and signInPaused. Empty when they wrote none.

string
problems

What is wrong with the document, for invalidDocument and invalidComment.

Array<object>

A problem in the document.

object
path
required

Position in the document, such as .content[2].content[0].

string
code
required

Kind of problem, such as unknownNode or invalidAttribute.

string
message
required

Explanation for people.

string

Examples

ExamplenotFound
{
"type": "urn:lunedo:problem:notFound",
"title": "Not found",
"status": 404,
"code": "notFound"
}

rateLimited: Too many requests.

Media typeapplication/problem+json

Error response following RFC 9457 Problem Details.

object
type
required

Stable identifier of the error kind. Clients branch on this value.

string
title
required

Short summary of the error kind. It does not change between occurrences.

string
status
required

HTTP status code of the response.

integer
>= -9007199254740991 <= 9007199254740991
detail

Explanation of this occurrence, for people.

string
code
required

The last part of type, for clients that prefer a short key.

string
fields

Invalid fields, for invalidInput, invalidStorageSettings, invalidBackupSettings and the codes about the address of a chat channel.

Array<string>
denials

Why the request was not allowed, for forbidden.

Array<string>
retryAfterSeconds

Seconds to wait before retrying, for rateLimited, locked and busy.

integer
>= -9007199254740991 <= 9007199254740991
problem

Which password rule failed, for passwordPolicy; why the address of a chat channel was refused, for invalidChatAddress; which storage setting was refused (invalidThresholds, invalidS3Limit, invalidContacts or invalidTeamsWebhook), for invalidStorageSettings; which backup setting was refused, for invalidBackupSettings; whether a backup or a testRestore is running, for backupRunning; why the backup target could not be used (a failure of Test connection, such as notFound or credentials, or missingSecret), for backupTargetFailed.

string
step

What Lunedo was doing with the backup target when it failed, for backupTargetFailed.

string
Allowed values: write read delete list
refusal

What the full storage refuses, for storageFull: an upload, or a large write such as an import.

string
Allowed values: upload largeWrite
minLength

Minimum password length, for passwordPolicy.

integer
>= -9007199254740991 <= 9007199254740991
lockedBy

Level that locked the setting, for settingLocked.

string
minimum

Lowest allowed value, for settingBelowMinimum.

number
maximum
Any of:
number
maxLifetimeDays

Maximum lifetime of API tokens in days, for expiryRequired and expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
domains

Domains that belong to another identity provider, for domainInUse.

Array<string>
instanceUrl

The current address of the instance, for instanceMoved.

string
providerId

ID of the identity provider that manages the account, for managedAccount and managedDomain.

string
providerName

Name of the identity provider that manages the account, for managedAccount and managedDomain.

string
accounts

Number of accounts still linked to the identity provider, for providerHasAccounts.

integer
>= -9007199254740991 <= 9007199254740991
maxBytes

Largest allowed file size in bytes, for fileTooLarge and uploadTooLarge; storage limit of the organization’s imports, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
usedBytes

Bytes the organization’s imports use already, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
missing

Number of parts still missing, for uploadIncomplete.

integer
>= -9007199254740991 <= 9007199254740991
uncoveredPages

Number of pages below that your own role does not cover, for shareBeyondOwnAccess.

integer
>= -9007199254740991 <= 9007199254740991
maxDays

Longest allowed lifetime of a link for anyone in days, for expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
pages

Number of pages that give access to groups or through broad links, for confidentialSharing; number of pages that would lose the status, for statusInUse; number of pages the caller cannot open, for hiddenContent.

integer
>= -9007199254740991 <= 9007199254740991
sections

Required sections that are empty or missing, for requiredSectionsEmpty.

Array<object>

A required section.

object
key
required

Key of the section.

string
title
required

Heading of the section.

string
articles

Number of articles more people could read, for audienceWidening and categoryVisibilityWidening.

integer
>= -9007199254740991 <= 9007199254740991
translations

Number of translations into the language, for defaultLanguageTranslated.

integer
>= -9007199254740991 <= 9007199254740991
translationId

The existing translation, for translationExists.

string format: uuid
light

Check of the light mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
dark

Check of the dark mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
impact

Who gains and who loses access, with the confirmation to send, for moveChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the content leaves a confidential space and loses its protection.

boolean
confirmation
required

Send this with the move to confirm exactly this change, or null when access does not change. Valid for one hour.

string | null
copyImpact

Who could read the copy but not the source, with the confirmation to send, for copyChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the copy leaves a confidential space and is not protected by it.

boolean
widerAccess
required

True when people can read the copy who cannot read the source; the copy then needs the confirmation.

boolean
confirmation
required

Send this with the copy to confirm exactly this access, or null when nobody gains access. Valid for one hour.

string | null
items
required

Number of items the copy creates.

integer
>= -9007199254740991 <= 9007199254740991
hidden
required

Number of items below that are left out because the caller cannot read them.

integer
>= -9007199254740991 <= 9007199254740991
skipped
required

Number of items below that are left out because they cannot be copied.

integer
>= -9007199254740991 <= 9007199254740991
background
required

True when the copy is large and runs in the background.

boolean
formerParent
Any of:
object
id
required

ID of the former parent page.

string format: uuid
title
required

Title of the former parent page.

string
parentEntries

Number of trash entries of former parent pages the caller can restore together with the content, for restrictedParentInTrash; 0 when the caller cannot restore all of them.

integer
>= -9007199254740991 <= 9007199254740991
fileVersion

Format or editor schema version of the file, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
supportedVersion

Highest format or editor schema version this Lunedo reads, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
templateIndex

Position of the template in the file, counted from 0, for templateNameTaken.

integer
>= -9007199254740991 <= 9007199254740991
templateProblems

What is wrong with the templates of the file, for invalidTemplatesInFile.

Array<object>

A problem in a template of the file.

object
place
required

Where in the template, such as field 3 or content.

string | null
message
required

Explanation for people, naming the template and the place.

string
maintenanceMessage

The message of the instance administrators about the maintenance, for maintenanceMode and signInPaused. Empty when they wrote none.

string
problems

What is wrong with the document, for invalidDocument and invalidComment.

Array<object>

A problem in the document.

object
path
required

Position in the document, such as .content[2].content[0].

string
code
required

Kind of problem, such as unknownNode or invalidAttribute.

string
message
required

Explanation for people.

string

Examples

ExamplerateLimited
{
"type": "urn:lunedo:problem:rateLimited",
"title": "Too many requests",
"status": 429,
"code": "rateLimited"
}