Skip to main content
PUT
/
library
/
v1
cURL
curl --request PUT \
  --url https://aodocs.altirnao.com/api/library/v1 \
  --header 'Authorization: Bearer <token>'
{
  "hasMoreResults": true,
  "kind": "<string>",
  "libraries": [
    {
      "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.

Query Parameters

​
explicitAccessOnly
boolean
default:false

Whether to list only libraries with explicit access (for super administrators)

​
favoritesOnly
boolean
default:false

Whether to list only favorite libraries of the user

​
include
string[]

To filter the list of fields to have in the response (everything if left empty). The possible choices are: 'NONE', 'CLASSES', 'CATEGORY_DEFINITIONS', 'VIEWS', 'FOLDER_DEFINITION', 'WORKFLOWS', 'RELATIONS', 'PERMISSIONS', 'LIBRARY_LABELS'

​
securityCode
string

The security code

​
domain
string

The G Suite domain

​
query
string

Terms to search in the library name (will match word prefixes). You can search for exact phrases by quoting the whole parameter (example: "exact search" => will search for the whole words 'exact search' next to each other). You can also use the stemming operator to search for alternative forms of the search terms (example: ~"dog eat" => will also search for the dogs, eating in any order)

Response

200 - application/json

A ApiLibraryList response

​
hasMoreResults
boolean
​
kind
string
​
libraries
object[]