Additional Objects

Action

Properties

Name	Type	Description	Restrictions
dateTime	string(date-time)	When the action was performed	read-only
user	User¦null	The user's ID, display name, and email address

Example

{
  "dateTime": "2019-10-30T15:03:27Z",
  "user": {
    "displayName": "string",
    "email": "string",
    "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
  }
}

Failure

Properties

Name	Type	Description
errors	[object]
errors.code	string	An application-specific error code, expressed as a string value
errors.detail	string	A human-readable explanation specific to this occurrence of the problem. Like 'title', this field's value can be localized.
errors.id	string	A unique identifier for this particular occurrence of the problem
errors.links	object
errors.links.about	string	A link that leads to further details about this particular occurrence of the problem
errors.meta	object	Non-standard meta-information that cannot be represented as an attribute or relationship.
errors.source	object
errors.source.parameter	string	A string indicating which URI query parameter caused the error
errors.source.pointer	string	A JSON Pointer [RFC6901] to the associated entity in the request document
errors.status	string	The HTTP status code applicable to this problem, expressed as a string value
errors.title	string	A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization
jsonapi	object
jsonapi.version	string
links	object	A list of URLs.
meta	object	Non-standard meta-information that cannot be represented as an attribute or relationship.

Example

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "id": "string",
      "links": {
        "about": "string"
      },
      "meta": {},
      "source": {
        "parameter": "string",
        "pointer": "string"
      },
      "status": "string",
      "title": "string"
    }
  ],
  "jsonapi": {
    "version": "string"
  },
  "links": {},
  "meta": {}
}

GetOrgReportUsersResponse

Properties

Name	Type	Description
data	[object]
data.attributes	object
data.attributes.active	boolean¦null
data.attributes.displayName	string¦null
data.attributes.email	string¦null
data.attributes.firstName	string¦null
data.attributes.lastLogin	string¦null
data.attributes.lastName	string¦null
data.attributes.licenses	[string]¦null
data.attributes.organizationRoles	[string]¦null
data.attributes.samlId	string¦null
data.attributes.userName	string¦null
data.attributes.workspaceMemberships	[object]¦null
data.attributes.workspaceMemberships.id	string	The Workspace ID
data.attributes.workspaceMemberships.workspaceName	string¦null
data.attributes.workspaceMemberships.workspaceRoles	[string]¦null
data.id	string	The resource ID
data.links	object	A list of URLs.
data.relationships	object
data.type	string	The resource type (File)
included	[object]	Any additional included resources
included.attributes	object
included.id	string	The resource ID
included.type	string	The resource type
jsonapi	object
jsonapi.version	string
links	object
links.next	string(uri)¦null	The next page of data
meta	object	Non-standard meta-information that cannot be represented as an attribute or relationship.

Enumerated Values

Property	Value
type	`File`

Example

{
  "data": [
    {
      "attributes": {
        "active": true,
        "displayName": "string",
        "email": "string",
        "firstName": "string",
        "lastLogin": "string",
        "lastName": "string",
        "licenses": [
          "string"
        ],
        "organizationRoles": [
          "string"
        ],
        "samlId": "string",
        "userName": "string",
        "workspaceMemberships": [
          {
            "id": "string",
            "workspaceName": "string",
            "workspaceRoles": [
              "string"
            ]
          }
        ]
      },
      "id": "string",
      "links": {},
      "relationships": {},
      "type": "File"
    }
  ],
  "included": [
    {
      "attributes": {},
      "id": "string",
      "type": "string"
    }
  ],
  "jsonapi": {
    "version": "string"
  },
  "links": {
    "next": "http://example.com"
  },
  "meta": {}
}