API Reference

Failure

Properties

NameTypeDescriptionRestrictions
errors[object]
errors.codestringAn application-specific error code, expressed as a string value
errors.detailstringA human-readable explanation specific to this occurrence of the problem. Like 'title', this field's value can be localized.
errors.idstringA unique identifier for this particular occurrence of the problem
errors.linksobject
errors.links.aboutstringA link that leads to further details about this particular occurrence of the problem
errors.metaobjectNon-standard meta-information that cannot be represented as an attribute or relationship.
errors.sourceobject
errors.source.parameterstringA string indicating which URI query parameter caused the error
errors.source.pointerstringA JSON Pointer [RFC6901] to the associated entity in the request document
errors.statusstringThe HTTP status code applicable to this problem, expressed as a string value
errors.titlestringA short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization
jsonapiobject
jsonapi.versionstring
linksobjectA list of URLs.
metaobjectNon-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

NameTypeDescriptionRestrictions
data[object]
data.attributesobject
data.attributes.activeboolean¦null
data.attributes.displayNamestring¦null
data.attributes.emailstring¦null
data.attributes.firstNamestring¦null
data.attributes.lastLoginstring¦null
data.attributes.lastNamestring¦null
data.attributes.licenses[string]¦null
data.attributes.organizationRoles[string]¦null
data.attributes.samlIdstring¦null
data.attributes.userNamestring¦null
data.attributes.workspaceMemberships[object]¦null
data.attributes.workspaceMemberships.idstringThe Workspace ID
data.attributes.workspaceMemberships.workspaceNamestring¦null
data.attributes.workspaceMemberships.workspaceRoles[string]¦null
data.idstringThe resource ID
data.linksobjectA list of URLs.
data.relationshipsobject
data.typestringThe resource type (File)
included[object]Any additional included resources
included.attributesobject
included.idstringThe resource ID
included.typestringThe resource type
jsonapiobject
jsonapi.versionstring
linksobject
links.nextstring(uri)¦nullThe next page of data
metaobjectNon-standard meta-information that cannot be represented as an attribute or relationship.

Enumerated Values

PropertyValue
typeFile

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": {}
}