Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.

data

Membership

Object describes membership information.

string

required

>= 1 characters

organization

object

required

account

object

required

role

Role

required

Object describes role information.

400

Bad Request

Body

meta

Meta

Meta data object.

Example:

{"code":200,"type":"OK","message":"Everything worked as expected."}

code

number

required

Default:

200

Example:

200

type

string

required

>= 1 characters

message

string

required

>= 1 characters

errors

array[Error]

Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.

data

object

401

Unauthorized

Body

meta

Meta

Meta data object.

Example:

{"code":200,"type":"OK","message":"Everything worked as expected."}

code

number

required

Default:

200

Example:

200

type

string

required

>= 1 characters

message

string

required

>= 1 characters

errors

array[Error]

Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.

data

object

403

Forbidden

Body

meta

Meta

Meta data object.

Example:

{"code":200,"type":"OK","message":"Everything worked as expected."}

code

number

required

Default:

200

Example:

200

type

string

required

>= 1 characters

message

string

required

>= 1 characters

errors

array[Error]

Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.

data

object

404

Not Found

Body

meta

Meta

Meta data object.

Example:

{"code":200,"type":"OK","message":"Everything worked as expected."}

code

number

required

Default:

200

Example:

200

type

string

required

>= 1 characters

message

string

required

>= 1 characters

errors

array[Error]

Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.

data

object

422

Unprocessable Entity (WebDAV)

Body

meta

Meta

Meta data object.

Example:

{"code":200,"type":"OK","message":"Everything worked as expected."}

code

number

required

Default:

200

Example:

200

type

string

required

>= 1 characters

message

string

required

>= 1 characters

errors

array[Error]

Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.

data

object

500

Internal Server Error

Body

meta

Meta

Meta data object.

Example:

{"code":200,"type":"OK","message":"Everything worked as expected."}

code

number

required

Default:

200

Example:

200

type

string

required

>= 1 characters

message

string

required

>= 1 characters

errors

array[Error]

Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.

data

object

Auth

Parameters

Body

{
  "role": {
    "code": "admin"
  }
}

Response Example

{
  "meta": {
    "code": 200,
    "type": "OK",
    "message": "Everything worked as expected."
  },
  "data": {
    "id": "3ea1910b07394a95bf7cdaa611d3cc3f",
    "organization": {
      "id": "511ceb52969b400a93e3422c743ae34a"
    },
    "account": {
      "id": "74d998151a1b4668bee5a283712dd57e",
      "email": "[email protected]"
    },
    "role": {
      "code": "admin",
      "name": "Admin"
    }
  }
}