Skip to main content
PATCH
/
user
/
v1
/
me
cURL
curl --request PATCH \
  --url https://aodocs.altirnao.com/api/user/v1/me \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "landingLabel": {
    "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>",
  "timezone": "<string>"
}
'
{
  "aliases": [
    "<string>"
  ],
  "availableDomains": [
    "<string>"
  ],
  "availableStorageServices": [
    "GOOGLE_DRIVE"
  ],
  "canAccessDrive": true,
  "canCreateLibraries": true,
  "canCreateLibrariesOfTypes": [
    {
      "creationType": "TEAM_FOLDER"
    }
  ],
  "defaultDomain": "<string>",
  "domain": "<string>",
  "email": "<string>",
  "external": true,
  "googleEmailAddress": true,
  "groupAliases": [
    "<string>"
  ],
  "groups": [
    "<string>"
  ],
  "impersonable": true,
  "kind": "<string>",
  "landingLabel": {
    "createdAt": 123,
    "deleted": true,
    "id": "<string>",
    "kind": "<string>",
    "lastModifiedAt": 123,
    "leaf": true,
    "level": 123,
    "name": "<string>",
    "parent": "<string>",
    "parentIds": [
      "<string>"
    ],
    "rank": 123,
    "referenceCatalogId": "<string>"
  },
  "lastEdit": "2023-11-07T05:31:56Z",
  "lastLogin": "2023-11-07T05:31:56Z",
  "locale": "<string>",
  "name": "<string>",
  "namespace": "<string>",
  "permissionIds": [
    "<string>"
  ],
  "standalone": true,
  "superAdmin": true,
  "thumbnailPictureUrl": "<string>",
  "timezone": "<string>",
  "useDelayedVersion": true
}

Authorizations

Authorization
string
header
required

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

Query Parameters

securityCode
string

The security code

domain
string

The G Suite domain

Body

application/json
landingLabel
object
locale
string

The preferred locale of the user

timezone
string

The preferred timezone of the user

Response

200 - application/json

A ApiUser response

aliases
string[]

Email aliases of the user

availableDomains
string[]

The user available domains

availableStorageServices
enum<string>[]

Attachment storage services available for library creation.

Available options:
GOOGLE_DRIVE,
AODOCS_MANAGED_CLOUD,
GOOGLE_CLOUD_STORAGE,
AZURE_BLOB_STORAGE
canAccessDrive
boolean

Whether this user can access Drive

canCreateLibraries
boolean

Whether this user can creates libraries within this domain

canCreateLibrariesOfTypes
object[]

The types of library this user can create

defaultDomain
string

The user default domain

domain
string

The user domain

email
string

The user email

external
boolean

Whether this user is external

googleEmailAddress
boolean

Whether the email address is tied to a Google account

groupAliases
string[]

Aliases of the groups this user belongs to.

groups
string[]

The groups this user belongs to.

impersonable
boolean

Whether this user can be impersonated

kind
string
landingLabel
object
lastEdit
string<date-time>

The last time the user data has been edited

lastLogin
string<date-time>

The last time user logged in

locale
string

The preferred locale of the user

name
string

The user name

namespace
string

Immutable domain identifier

permissionIds
string[]

Permission ids this user has

standalone
boolean
superAdmin
boolean

Whether this user is a super administrator

thumbnailPictureUrl
string

The user thumbnail picture URL

timezone
string

The preferred timezone of the user

useDelayedVersion
boolean