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

roles

array[Role]

Object describes role information.

parameter_string

string

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

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

Response Example

{
  "meta": {
    "code": 200,
    "type": "OK",
    "message": "Everything worked as expected."
  },
  "data": {
    "roles": [
      {
        "code": "admin",
        "name": "Admin"
      }
    ],
    "parameter_string": ""
  }
}