Skip to main content
GET
/
domain
/
v1beta1
/
licensedUsers
cURL
curl --request GET \
  --url https://aodocs.altirnao.com/api/domain/v1beta1/licensedUsers \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "kind": "<string>",
  "licensedUserList": [
    {
      "archived": true,
      "email": "<string>",
      "kind": "<string>",
      "lastActivity": "2023-11-07T05:31:56Z",
      "lastEdit": "2023-11-07T05:31:56Z",
      "lastLogin": "2023-11-07T05:31:56Z",
      "lastView": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "orgUnitPath": "<string>",
      "overDomainLimit": true,
      "revokeCooldownDate": "2023-11-07T05:31:56Z",
      "suspended": true,
      "thumbnailPictureUrl": "<string>"
    }
  ],
  "maxSeats": 123,
  "nextPageToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
status
enum<string>
default:ACTIVE

The status of licenses to search for. (Possible values: ACTIVE, EXPIRED, OVER_DOMAIN_LIMIT. Default: ACTIVE)

Available options:
ACTIVE,
EXPIRED,
OVER_DOMAIN_LIMIT
​
query
string

The pattern to look for (substring)

​
domain
string

The domain

​
securityCode
string

The security code

​
limit
integer<int32>
default:50

The maximum number of licensed users per page. (Default: 50)

​
order
string

The attribute ('email', 'name', 'lastLogin' or 'lastActivity') used to sort the licensed users and the order ('asc' or 'desc'), e.g. 'lastActivity desc'

​
nextPageToken
string

DEPRECATED. Use pageToken instead.

​
pageToken
string

The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.

Response

200 - application/json

A ApiLicensedUserList response

​
count
integer<int32>
​
kind
string
​
licensedUserList
object[]
​
maxSeats
integer<int32>

The maximum number of licensed users (0 means unlimited)

​
nextPageToken
string