Return service account's information

This function lists a service account's information.

Authorizations:
query Parameters
full_username
required
string

The full username for the system account.

Example: full_username=username@example.com
type
required
string

The type of system account.

  • email
  • ftp
  • webdisk
Enum: "email" "ftp" "webdisk"
Example: type=email

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  UserManager \
  lookup_service_account \
  type='email' \
  full_username='username@example.com'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "lookup_service_account",
  • "module": "UserManager",
  • "result": {
    • "data": {
      • "dismissed_merge_candidates": [
        • {
          • "merge_candidates": [
            • {
              • "alternate_email": "user@example.com",
              • "can_delete": 0,
              • "can_set_password": 1,
              • "can_set_quota": 0,
              • "dismissed": 1,
              • "domain": "example.com",
              • "full_username": "user@example.com",
              • "guid": "N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4",
              • "has_expired_invite": 0,
              • "has_invite": 0,
              • "has_siblings": 0,
              • "invite_expiration": 1591718154,
              • "issues": [
                • {
                  • "area": "quota",
                  • "limit": 1500,
                  • "message": "Your account is over quota.",
                  • "service": "email",
                  • "type": "info",
                  • "used": 2000
                  }
                ],
              • "parent_type": "hypothetical",
              • "phone_number": "+15551234567",
              • "real_name": "John Doe",
              • "services": {
                • "email": {
                  • "enabled": 1,
                  • "quota": 100
                  },
                • "ftp": {
                  • "enabled": 0,
                  • "homedir": "/subaccount",
                  • "quota": 100
                  },
                • "webdisk": {
                  • "enabled": 0,
                  • "homedir": "/bob",
                  • "perms": "rw",
                  • "private": 0
                  }
                },
              • "special": 1,
              • "sub_account_exists": 0,
              • "synced_password": 0,
              • "type": "sub",
              • "username": "example",
              • "merge_candidates": [
                • { }
                ]
              }
            ]
          }
        ],
      • "alternate_email": "user@example.com",
      • "can_delete": 0,
      • "can_set_password": 1,
      • "can_set_quota": 0,
      • "dismissed": 1,
      • "domain": "example.com",
      • "full_username": "user@example.com",
      • "guid": "N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4",
      • "has_expired_invite": 0,
      • "has_invite": 0,
      • "has_siblings": 0,
      • "invite_expiration": 1591718154,
      • "issues": [
        • {
          • "area": "quota",
          • "limit": 1500,
          • "message": "Your account is over quota.",
          • "service": "email",
          • "type": "info",
          • "used": 2000
          }
        ],
      • "parent_type": "hypothetical",
      • "phone_number": "+15551234567",
      • "real_name": "John Doe",
      • "services": {
        • "email": {
          • "enabled": 1,
          • "quota": 100
          },
        • "ftp": {
          • "enabled": 0,
          • "homedir": "/subaccount",
          • "quota": 100
          },
        • "webdisk": {
          • "enabled": 0,
          • "homedir": "/bob",
          • "perms": "rw",
          • "private": 0
          }
        },
      • "special": 1,
      • "sub_account_exists": 0,
      • "synced_password": 0,
      • "type": "sub",
      • "username": "example",
      • "merge_candidates": [
        • {
          • "alternate_email": "user@example.com",
          • "can_delete": 0,
          • "can_set_password": 1,
          • "can_set_quota": 0,
          • "dismissed": 1,
          • "domain": "example.com",
          • "full_username": "user@example.com",
          • "guid": "N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4",
          • "has_expired_invite": 0,
          • "has_invite": 0,
          • "has_siblings": 0,
          • "invite_expiration": 1591718154,
          • "issues": [
            • {
              • "area": "quota",
              • "limit": 1500,
              • "message": "Your account is over quota.",
              • "service": "email",
              • "type": "info",
              • "used": 2000
              }
            ],
          • "parent_type": "hypothetical",
          • "phone_number": "+15551234567",
          • "real_name": "John Doe",
          • "services": {
            • "email": {
              • "enabled": 1,
              • "quota": 100
              },
            • "ftp": {
              • "enabled": 0,
              • "homedir": "/subaccount",
              • "quota": 100
              },
            • "webdisk": {
              • "enabled": 0,
              • "homedir": "/bob",
              • "perms": "rw",
              • "private": 0
              }
            },
          • "special": 1,
          • "sub_account_exists": 0,
          • "synced_password": 0,
          • "type": "sub",
          • "username": "example",
          • "merge_candidates": [
            • { }
            ]
          }
        ]
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}