Skip to main content
GET
/
library
/
v2beta1
/
suggest
cURL
curl --request GET \
  --url https://aodocs.altirnao.com/api/library/v2beta1/suggest \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "currentUserRole": "NONE",
      "folderVisibility": "PRIVATE",
      "hidden": true,
      "id": "<string>",
      "kind": "<string>",
      "labelIds": [
        "<string>"
      ],
      "libraryType": "DMS",
      "logoUrl": "<string>",
      "name": "<string>",
      "objectStorageLocation": "<string>",
      "onlyAdminsCanManageFolders": true,
      "rootFolderId": "<string>",
      "storageAccount": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
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)

​
useSuperAdminAccess
boolean
default:false

(Super-admin only) Return libraries accessible with super admin role

​
minimumCurrentUserRole
enum<string>
default:READER

Return only libraries with at least this role for the current user. Only ADMIN, WRITER, READER are valid values

Available options:
NONE,
READER,
COMMENTER,
ATTACHMENT_EDITOR,
WRITER,
ADMIN,
SUPER_ADMIN
​
withHidden
boolean
default:false

Return libraries that would be hidden from the current user.

​
libTypes
enum<string>[]

Return libraries of these types

Available options:
DMS,
SF,
TF
​
storageAccount
string

Return only libraries of this storage account

​
labelIds
string[]

Return libraries with at least one of these labels

​
appMetadataTags
string[]

Return the libraries with all the provided app metadata tags. App metadata tags can be queried at three levels with the following syntax: 'appNamespaceId', 'appNamespaceId.tagName' or 'appNamespaceId.tagName:tagValue'. App metadata tags can be excluded by adding a '-' character before the tag name ('-appNamespaceId', '-appNamespaceId.tagName' or '-appNamespaceId.tagName:tagValue').

​
limit
integer<int32>
default:20

The maximum number of items to return(defaults to 20, max 1000)

​
domain
string

The G Suite domain

​
securityCode
string

The security code

Response

200 - application/json

A ApiLibrarySuggestionCollection response

An ordered list of ApiLibrarySuggestion

​
items
object[]