Skip to main content
PATCH
/
library
/
v1
/
{libId}
cURL
curl --request PATCH \
  --url https://aodocs.altirnao.com/api/library/v1/{libId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowNonGoogleUsersInDriveOnlyPermissions": true,
  "appMetadata": {},
  "attachmentMode": "COMPOSITE",
  "attachmentSearchEngine": "DRIVE",
  "categoryDefinitions": {
    "items": [
      {
        "kind": "<string>",
        "name": "<string>",
        "name_i18n": "<string>",
        "value": "<string>"
      }
    ],
    "kind": "<string>"
  },
  "createdAt": 123,
  "creator": "<string>",
  "currentUserRight": "NONE",
  "daysBeforeDelete": 123,
  "defaultDocumentType": "<string>",
  "defaultOnlyAdminCanDelete": true,
  "defaultOnlyAdminCanShare": true,
  "defaultView": "<string>",
  "documentTypes": {
    "items": [
      {
        "kind": "<string>",
        "name": "<string>",
        "name_i18n": "<string>",
        "value": "<string>"
      }
    ],
    "kind": "<string>"
  },
  "domainName": "<string>",
  "driveShortcuts": {
    "sameLibrary": "KEEP"
  },
  "enableExternalSharingInDriveOnlyPermissions": true,
  "favorited": true,
  "findableBy": "READERS",
  "folderDefinition": {
    "dynamicValues": true,
    "folderId": "<string>",
    "folderVisibility": "PRIVATE",
    "id": "<string>",
    "kind": "<string>",
    "libraryId": "<string>",
    "name": "<string>",
    "onlyAdminCanEditRootFolder": true,
    "onlyAdminCanManage": true
  },
  "forwardRequestAccessRole": "<string>",
  "historyVisibility": {
    "classId": "<string>",
    "className": "<string>",
    "description": "<string>",
    "displayName": "<string>",
    "displayName_i18n": "<string>",
    "thumbnailPictureUrl": "<string>",
    "type": "USER",
    "value": "<string>"
  },
  "homeUrl": "<string>",
  "kind": "<string>",
  "lastAccessed": 123,
  "lastConfigModified": 123,
  "lastModified": 123,
  "libraryId": "<string>",
  "libraryLabels": [
    {
      "createdAt": 123,
      "deleted": true,
      "id": "<string>",
      "kind": "<string>",
      "lastModifiedAt": 123,
      "leaf": true,
      "level": 123,
      "name": "<string>",
      "parent": "<string>",
      "parentIds": [
        "<string>"
      ],
      "rank": 123,
      "referenceCatalogId": "<string>"
    }
  ],
  "locale": "<string>",
  "logoUrl": "<string>",
  "name": "<string>",
  "name_i18n": "<string>",
  "notifyUsersAboutPushToMyDrive": true,
  "objectStorageLocation": "<string>",
  "onlyAdminsCanEditRootFolder": true,
  "onlyAdminsCanManageFolders": true,
  "permissionMode": "HIGH_SECURITY_PRISON",
  "permissions": [
    {
      "kind": "<string>",
      "name": "<string>",
      "role": "<string>",
      "thumbnailPhotoUrl": "<string>",
      "type": "<string>",
      "value": "<string>",
      "withLink": true
    }
  ],
  "pushToMyDrive": true,
  "redirectUrl": "<string>",
  "relations": [
    {
      "description": "<string>",
      "fromDescending": true,
      "fromDisplayColumns": [
        {
          "kind": "<string>",
          "name": "<string>",
          "name_i18n": "<string>",
          "value": "<string>"
        }
      ],
      "fromId": "<string>",
      "fromName": "<string>",
      "fromName_i18n": "<string>",
      "fromSort": "<string>",
      "id": "<string>",
      "kind": "<string>",
      "libraryId": "<string>",
      "name": "<string>",
      "name_i18n": "<string>",
      "selfRelated": true,
      "toDescending": true,
      "toDisplayColumns": [
        {
          "kind": "<string>",
          "name": "<string>",
          "name_i18n": "<string>",
          "value": "<string>"
        }
      ],
      "toId": "<string>",
      "toName": "<string>",
      "toName_i18n": "<string>",
      "toSort": "<string>"
    }
  ],
  "restrictedDownload": true,
  "rootFolderId": "<string>",
  "sequenceId": 123,
  "state": "INITIALIZING",
  "storageAdmin": "<string>",
  "technicalNotificationAddress": "<string>",
  "timeZone": "<string>",
  "trashResourceId": "<string>",
  "views": {
    "items": [
      {
        "canDisplay": true,
        "kind": "<string>",
        "name": "<string>",
        "name_i18n": "<string>",
        "value": "<string>"
      }
    ],
    "kind": "<string>"
  },
  "visibility": {
    "level": "READ",
    "scope": "NONE",
    "withLink": true
  },
  "welcomeText": "<string>",
  "wokflows": {
    "kind": "<string>",
    "workflows": [
      {
        "classId": "<string>",
        "id": "<string>",
        "kind": "<string>",
        "name": "<string>",
        "name_i18n": "<string>",
        "states": [
          {
            "description": "<string>",
            "displayFlags": [
              "HIDDEN_FROM_WORKFLOW_TASKS"
            ],
            "kind": "<string>",
            "name": "<string>",
            "name_i18n": "<string>",
            "noAction": true,
            "transitions": [
              {
                "condition": "<string>",
                "fromStateId": "<string>",
                "fromStateName": "<string>",
                "fromStateName_i18n": "<string>",
                "id": "<string>",
                "kind": "<string>",
                "mandatoryComment": true,
                "name": "<string>",
                "name_i18n": "<string>",
                "parallel": true,
                "targetStateId": "<string>",
                "targetStateName": "<string>",
                "targetStateName_i18n": "<string>",
                "validators": [
                  {
                    "kind": "<string>",
                    "user": {
                      "email": "<string>",
                      "kind": "<string>",
                      "name": "<string>",
                      "nonGoogle": true,
                      "thumbnailPictureUrl": "<string>"
                    },
                    "validated": true
                  }
                ],
                "value": "<string>",
                "workflowId": "<string>"
              }
            ],
            "value": "<string>"
          }
        ]
      }
    ]
  }
}
'
{
  "allowNonGoogleUsersInDriveOnlyPermissions": true,
  "appMetadata": {},
  "attachmentMode": "COMPOSITE",
  "attachmentSearchEngine": "DRIVE",
  "categoryDefinitions": {
    "items": [
      {
        "kind": "<string>",
        "name": "<string>",
        "name_i18n": "<string>",
        "value": "<string>"
      }
    ],
    "kind": "<string>"
  },
  "createdAt": 123,
  "creator": "<string>",
  "currentUserRight": "NONE",
  "daysBeforeDelete": 123,
  "defaultDocumentType": "<string>",
  "defaultOnlyAdminCanDelete": true,
  "defaultOnlyAdminCanShare": true,
  "defaultView": "<string>",
  "documentTypes": {
    "items": [
      {
        "kind": "<string>",
        "name": "<string>",
        "name_i18n": "<string>",
        "value": "<string>"
      }
    ],
    "kind": "<string>"
  },
  "domainName": "<string>",
  "driveShortcuts": {
    "sameLibrary": "KEEP"
  },
  "enableExternalSharingInDriveOnlyPermissions": true,
  "favorited": true,
  "findableBy": "READERS",
  "folderDefinition": {
    "dynamicValues": true,
    "folderId": "<string>",
    "folderVisibility": "PRIVATE",
    "id": "<string>",
    "kind": "<string>",
    "libraryId": "<string>",
    "name": "<string>",
    "onlyAdminCanEditRootFolder": true,
    "onlyAdminCanManage": true
  },
  "forwardRequestAccessRole": "<string>",
  "historyVisibility": {
    "classId": "<string>",
    "className": "<string>",
    "description": "<string>",
    "displayName": "<string>",
    "displayName_i18n": "<string>",
    "thumbnailPictureUrl": "<string>",
    "type": "USER",
    "value": "<string>"
  },
  "homeUrl": "<string>",
  "kind": "<string>",
  "lastAccessed": 123,
  "lastConfigModified": 123,
  "lastModified": 123,
  "libraryId": "<string>",
  "libraryLabels": [
    {
      "createdAt": 123,
      "deleted": true,
      "id": "<string>",
      "kind": "<string>",
      "lastModifiedAt": 123,
      "leaf": true,
      "level": 123,
      "name": "<string>",
      "parent": "<string>",
      "parentIds": [
        "<string>"
      ],
      "rank": 123,
      "referenceCatalogId": "<string>"
    }
  ],
  "locale": "<string>",
  "logoUrl": "<string>",
  "name": "<string>",
  "name_i18n": "<string>",
  "notifyUsersAboutPushToMyDrive": true,
  "objectStorageLocation": "<string>",
  "onlyAdminsCanEditRootFolder": true,
  "onlyAdminsCanManageFolders": true,
  "permissionMode": "HIGH_SECURITY_PRISON",
  "permissions": [
    {
      "kind": "<string>",
      "name": "<string>",
      "role": "<string>",
      "thumbnailPhotoUrl": "<string>",
      "type": "<string>",
      "value": "<string>",
      "withLink": true
    }
  ],
  "pushToMyDrive": true,
  "redirectUrl": "<string>",
  "relations": [
    {
      "description": "<string>",
      "fromDescending": true,
      "fromDisplayColumns": [
        {
          "kind": "<string>",
          "name": "<string>",
          "name_i18n": "<string>",
          "value": "<string>"
        }
      ],
      "fromId": "<string>",
      "fromName": "<string>",
      "fromName_i18n": "<string>",
      "fromSort": "<string>",
      "id": "<string>",
      "kind": "<string>",
      "libraryId": "<string>",
      "name": "<string>",
      "name_i18n": "<string>",
      "selfRelated": true,
      "toDescending": true,
      "toDisplayColumns": [
        {
          "kind": "<string>",
          "name": "<string>",
          "name_i18n": "<string>",
          "value": "<string>"
        }
      ],
      "toId": "<string>",
      "toName": "<string>",
      "toName_i18n": "<string>",
      "toSort": "<string>"
    }
  ],
  "restrictedDownload": true,
  "rootFolderId": "<string>",
  "sequenceId": 123,
  "state": "INITIALIZING",
  "storageAdmin": "<string>",
  "technicalNotificationAddress": "<string>",
  "timeZone": "<string>",
  "trashResourceId": "<string>",
  "views": {
    "items": [
      {
        "canDisplay": true,
        "kind": "<string>",
        "name": "<string>",
        "name_i18n": "<string>",
        "value": "<string>"
      }
    ],
    "kind": "<string>"
  },
  "visibility": {
    "level": "READ",
    "scope": "NONE",
    "withLink": true
  },
  "welcomeText": "<string>",
  "wokflows": {
    "kind": "<string>",
    "workflows": [
      {
        "classId": "<string>",
        "id": "<string>",
        "kind": "<string>",
        "name": "<string>",
        "name_i18n": "<string>",
        "states": [
          {
            "description": "<string>",
            "displayFlags": [
              "HIDDEN_FROM_WORKFLOW_TASKS"
            ],
            "kind": "<string>",
            "name": "<string>",
            "name_i18n": "<string>",
            "noAction": true,
            "transitions": [
              {
                "condition": "<string>",
                "fromStateId": "<string>",
                "fromStateName": "<string>",
                "fromStateName_i18n": "<string>",
                "id": "<string>",
                "kind": "<string>",
                "mandatoryComment": true,
                "name": "<string>",
                "name_i18n": "<string>",
                "parallel": true,
                "targetStateId": "<string>",
                "targetStateName": "<string>",
                "targetStateName_i18n": "<string>",
                "validators": [
                  {
                    "kind": "<string>",
                    "user": {
                      "email": "<string>",
                      "kind": "<string>",
                      "name": "<string>",
                      "nonGoogle": true,
                      "thumbnailPictureUrl": "<string>"
                    },
                    "validated": true
                  }
                ],
                "value": "<string>",
                "workflowId": "<string>"
              }
            ],
            "value": "<string>"
          }
        ]
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
libId
string
required

The ID of the library

Query Parameters

​
securityCode
string

The security code

​
domain
string

The G Suite domain

Body

application/json
​
allowNonGoogleUsersInDriveOnlyPermissions
boolean

Allows sharing Google Drive attachments with non Google email addresses

​
appMetadata
object

App Metadata let developers associate metadata with various configuration entities. The metadata is isolated within app namespaces in order to prevent one application from interfering with another's metadata.

​
attachmentMode
enum<string>

Type of the library (it cannot be changed after the creation)

Available options:
COMPOSITE,
GOOGLE_DRIVE,
DRIVE_CONTROLLED
​
attachmentSearchEngine
enum<string>

Engine to index and search the content of attachments

Available options:
DRIVE,
AODOCS
​
categoryDefinitions
object
​
createdAt
integer<int64>

The instant this resource was created (read-only

​
creator
string

Creator of the library (read-only)

​
currentUserRight
enum<string>

Permission of the current user on the library (read-only)

Available options:
NONE,
READER,
COMMENTER,
ATTACHMENT_EDITOR,
WRITER,
ADMIN,
SUPER_ADMIN
​
daysBeforeDelete
integer<int32>

The number of days before a trashed document is permanently deleted

​
defaultDocumentType
string

Default document class for the library

​
defaultOnlyAdminCanDelete
boolean

onlyAdminCanDelete setting of the default class (read-only)

​
defaultOnlyAdminCanShare
boolean

onlyAdminCanShare setting of the default class (read-only)

​
defaultView
string

ID of the default view

​
documentTypes
object
​
domainName
string

The domain the library belong to (read-only)

​
driveShortcuts
object
​
enableExternalSharingInDriveOnlyPermissions
boolean

Allows sharing Google Drive attachments with users and groups which might not be part of the AODocs tenant allowlists

​
favorited
boolean

Whether this library is starred by the current user (read only)

​
findableBy
enum<string>

Determines which users the library will appear to in searches and listings.

Available options:
READERS,
CONTRIBUTORS,
ADMINS,
NONE
​
folderDefinition
object
​
forwardRequestAccessRole
string

Sharing requests are forwarded to the users of this role (defaults to Administrators)

​
historyVisibility
object
​
homeUrl
string

A short URL to access the library

​
kind
string
​
lastAccessed
integer<int64>

The instant the current user last accessed this library (read-only)

​
lastConfigModified
integer<int64>

The instant the library configuration was last modified (not only this resource) (read only)

​
lastModified
integer<int64>

The instant this resource was last modified (read-only)

​
libraryId
string

The ID of the library

​
libraryLabels
object[]

Labels of the library

​
locale
string

The locale defines the user's language and is used to display fields whose output format may change given this setting

​
logoUrl
string

The url of the logo for the library (expected size is 240x103, with transparent background)

​
name
string

The name of the library

​
name_i18n
string

The internationalized name of the library (read-only)

​
notifyUsersAboutPushToMyDrive
boolean

Whether the users of the library should receive a notification when it is pushed to their My Drive

​
objectStorageLocation
string

Location of the bucket to store attachments, either a customer owned bucket or a AODocs owned bucket(AODOCS_MANAGED)

​
onlyAdminsCanEditRootFolder
boolean

Whether only the admins can create, move or delete document and subfolders in the root of library (true is only supported on Secured Folder library type)

​
onlyAdminsCanManageFolders
boolean

Whether only the admins can manage folders (true is not supported on Team Folder library type)

​
permissionMode
enum<string>

Permission mode of the library

Available options:
HIGH_SECURITY_PRISON,
LOW_SECURITY_PRISON,
CLUB_MED
​
permissions
object[]

Permissions for the library

​
pushToMyDrive
boolean

Whether the Push to My Drive feature is enabled for this library (Team Folders and Secure Folders libraries only)

​
redirectUrl
string

An optional URL to redirect to when accessing the library

​
relations
object[]

Deprecated - List of relations on the library (read-only) - use the relation API instead

​
restrictedDownload
boolean

Whether document readers should be allowed to download, copy or print (library level configuration)

​
rootFolderId
string

ID of the root folder of the library (read-only)

​
sequenceId
integer<int64>

Sequence id of the library (read-only)

​
state
enum<string>

State of the library (The update is possible between the following states: STANDARD, ARCHIVED for SuperAdmin users

Available options:
INITIALIZING,
STANDARD,
ARCHIVED,
DELETING
​
storageAdmin
string

The storage account for this library (cannot be modified after the creation)

​
technicalNotificationAddress
string

The email address that should be notified of custom script failures

​
timeZone
string

The timezone id of the library used to used to format times in sent emails. Formatted as a IANA Time Zone Database Name (ie: 'Europe/Paris', see: http://www.iana.org/time-zones).

​
trashResourceId
string

ID of the trash folder of the library (read-only)

​
views
object
​
visibility
object
​
welcomeText
string

The rich text displayed on the library homepage (accepts HTML)

​
wokflows
object

Response

200 - application/json

A ApiLibrary response

​
allowNonGoogleUsersInDriveOnlyPermissions
boolean

Allows sharing Google Drive attachments with non Google email addresses

​
appMetadata
object

App Metadata let developers associate metadata with various configuration entities. The metadata is isolated within app namespaces in order to prevent one application from interfering with another's metadata.

​
attachmentMode
enum<string>

Type of the library (it cannot be changed after the creation)

Available options:
COMPOSITE,
GOOGLE_DRIVE,
DRIVE_CONTROLLED
​
attachmentSearchEngine
enum<string>

Engine to index and search the content of attachments

Available options:
DRIVE,
AODOCS
​
categoryDefinitions
object
​
createdAt
integer<int64>

The instant this resource was created (read-only

​
creator
string

Creator of the library (read-only)

​
currentUserRight
enum<string>

Permission of the current user on the library (read-only)

Available options:
NONE,
READER,
COMMENTER,
ATTACHMENT_EDITOR,
WRITER,
ADMIN,
SUPER_ADMIN
​
daysBeforeDelete
integer<int32>

The number of days before a trashed document is permanently deleted

​
defaultDocumentType
string

Default document class for the library

​
defaultOnlyAdminCanDelete
boolean

onlyAdminCanDelete setting of the default class (read-only)

​
defaultOnlyAdminCanShare
boolean

onlyAdminCanShare setting of the default class (read-only)

​
defaultView
string

ID of the default view

​
documentTypes
object
​
domainName
string

The domain the library belong to (read-only)

​
driveShortcuts
object
​
enableExternalSharingInDriveOnlyPermissions
boolean

Allows sharing Google Drive attachments with users and groups which might not be part of the AODocs tenant allowlists

​
favorited
boolean

Whether this library is starred by the current user (read only)

​
findableBy
enum<string>

Determines which users the library will appear to in searches and listings.

Available options:
READERS,
CONTRIBUTORS,
ADMINS,
NONE
​
folderDefinition
object
​
forwardRequestAccessRole
string

Sharing requests are forwarded to the users of this role (defaults to Administrators)

​
historyVisibility
object
​
homeUrl
string

A short URL to access the library

​
kind
string
​
lastAccessed
integer<int64>

The instant the current user last accessed this library (read-only)

​
lastConfigModified
integer<int64>

The instant the library configuration was last modified (not only this resource) (read only)

​
lastModified
integer<int64>

The instant this resource was last modified (read-only)

​
libraryId
string

The ID of the library

​
libraryLabels
object[]

Labels of the library

​
locale
string

The locale defines the user's language and is used to display fields whose output format may change given this setting

​
logoUrl
string

The url of the logo for the library (expected size is 240x103, with transparent background)

​
name
string

The name of the library

​
name_i18n
string

The internationalized name of the library (read-only)

​
notifyUsersAboutPushToMyDrive
boolean

Whether the users of the library should receive a notification when it is pushed to their My Drive

​
objectStorageLocation
string

Location of the bucket to store attachments, either a customer owned bucket or a AODocs owned bucket(AODOCS_MANAGED)

​
onlyAdminsCanEditRootFolder
boolean

Whether only the admins can create, move or delete document and subfolders in the root of library (true is only supported on Secured Folder library type)

​
onlyAdminsCanManageFolders
boolean

Whether only the admins can manage folders (true is not supported on Team Folder library type)

​
permissionMode
enum<string>

Permission mode of the library

Available options:
HIGH_SECURITY_PRISON,
LOW_SECURITY_PRISON,
CLUB_MED
​
permissions
object[]

Permissions for the library

​
pushToMyDrive
boolean

Whether the Push to My Drive feature is enabled for this library (Team Folders and Secure Folders libraries only)

​
redirectUrl
string

An optional URL to redirect to when accessing the library

​
relations
object[]

Deprecated - List of relations on the library (read-only) - use the relation API instead

​
restrictedDownload
boolean

Whether document readers should be allowed to download, copy or print (library level configuration)

​
rootFolderId
string

ID of the root folder of the library (read-only)

​
sequenceId
integer<int64>

Sequence id of the library (read-only)

​
state
enum<string>

State of the library (The update is possible between the following states: STANDARD, ARCHIVED for SuperAdmin users

Available options:
INITIALIZING,
STANDARD,
ARCHIVED,
DELETING
​
storageAdmin
string

The storage account for this library (cannot be modified after the creation)

​
technicalNotificationAddress
string

The email address that should be notified of custom script failures

​
timeZone
string

The timezone id of the library used to used to format times in sent emails. Formatted as a IANA Time Zone Database Name (ie: 'Europe/Paris', see: http://www.iana.org/time-zones).

​
trashResourceId
string

ID of the trash folder of the library (read-only)

​
views
object
​
visibility
object
​
welcomeText
string

The rich text displayed on the library homepage (accepts HTML)

​
wokflows
object