object.list

Description

This call returns a list of object types.

Some object types may appear in the list returned that are not officially supported.  Check this documentation for supported object types.

Parameters

There are no parameters to object.list.

Response

An array of strings is returned.  Each element in the array represents an object type.

Examples

A Sample JSON-RPC Request

{
    "method": "object.list",
    "params": [],
    "id": 1
}

The JSON-RPC Response

{
    "result": [
        "application",
        "member",
        "key",
        "role",
        "service"
    ],
    "error": null,
    "id": 1
}

Permissions Required

The user who owns the key used to authenticate the object.list call must be a member of one of the following roles

  • Administrator
  • Program Manager
  • Community Manager
  • Content Manager
  • Portal Manager
  • Api Manager

See authentication.

Errors

This method returns only standard json-rpc errors and authentication errors.

Docs Navigation