Roles

List Role Permissions

get

Return a list of permissions available for Roles.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Object of available role permissions

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

get

/api/v1/roles/permissions

HTTPcURLJavaScriptPython

GET /api/v1/roles/permissions HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "resource": "text",
    "description": "text",
    "fetch": true,
    "create": true,
    "update": true,
    "delete": true
  }
]

List Roles

get

Return a list of all Roles.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Role response object

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

get

/api/v1/roles

HTTPcURLJavaScriptPython

GET /api/v1/roles HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "id": "text",
    "name": "text",
    "description": "text",
    "canMasquerade": true,
    "canSendFlow": true,
    "system": true,
    "permissions": [
      {
        "resource": "text",
        "description": "text",
        "fetch": true,
        "create": true,
        "update": true,
        "delete": true
      }
    ]
  }
}

Create Role

post

Create a Role from the supplied object. Do NOT submit an ID. IDs are auto generated and immutable.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptional

Responses

201

Role response object

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

post

/api/v1/roles

HTTPcURLJavaScriptPython

POST /api/v1/roles HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 267

{
  "name": "my_role",
  "description": "Role for Testing",
  "canMasquerade": true,
  "canSendFlow": true,
  "permissions": [
    {
      "resource": "account",
      "fetch": true,
      "create": true,
      "update": true,
      "delete": true
    },
    {
      "resource": "customer",
      "fetch": true,
      "create": false,
      "update": false,
      "delete": false
    }
  ]
}

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "id": "text",
    "name": "text",
    "description": "text",
    "canMasquerade": true,
    "canSendFlow": true,
    "system": true,
    "permissions": [
      {
        "resource": "text",
        "description": "text",
        "fetch": true,
        "create": true,
        "update": true,
        "delete": true
      }
    ]
  }
}

Get Role

get

Fetches a specific Role from the ID supplied in the path.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

String ID of the role to get

Responses

200

Role response object

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

get

/api/v1/roles/{id}

HTTPcURLJavaScriptPython

GET /api/v1/roles/{id} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "id": "text",
    "name": "text",
    "description": "text",
    "canMasquerade": true,
    "canSendFlow": true,
    "system": true,
    "permissions": [
      {
        "resource": "text",
        "description": "text",
        "fetch": true,
        "create": true,
        "update": true,
        "delete": true
      }
    ]
  }
}

Update Role

put

Update a Role given the provided object. This does not do a diff. You must send the complete object.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The ID of the Role to be updated

Body

application/json

objectOptional

Responses

200

Role response object

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

put

/api/v1/roles/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/roles/{id} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 267

{
  "name": "my_role",
  "description": "Role for Testing",
  "canMasquerade": true,
  "canSendFlow": true,
  "permissions": [
    {
      "resource": "account",
      "fetch": true,
      "create": true,
      "update": true,
      "delete": true
    },
    {
      "resource": "customer",
      "fetch": true,
      "create": false,
      "update": false,
      "delete": false
    }
  ]
}

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "id": "text",
    "name": "text",
    "description": "text",
    "canMasquerade": true,
    "canSendFlow": true,
    "system": true,
    "permissions": [
      {
        "resource": "text",
        "description": "text",
        "fetch": true,
        "create": true,
        "update": true,
        "delete": true
      }
    ]
  }
}

Delete Role

delete

Deletes the Role. API will return a 409 Conflict if the role is in use.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The ID of the Role to be retrieved

Responses

204

An empty array

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

delete

/api/v1/roles/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/roles/{id} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content