{
  "opencollection": "1.0.0",
  "info": {
    "name": "SyllableSDK Roles API",
    "version": "0.0.3"
  },
  "items": [
    {
      "info": {
        "name": "roles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.syllable.cloud/api/v1/roles/",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page number from which to start (0-based)"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return"
              },
              {
                "name": "search_fields",
                "value": "",
                "type": "query",
                "description": "String names of fields to search. Correspond by index to search field values"
              },
              {
                "name": "search_field_values",
                "value": "",
                "type": "query",
                "description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
              },
              {
                "name": "order_by",
                "value": "",
                "type": "query",
                "description": "The field whose value should be used to order the results"
              },
              {
                "name": "order_by_direction",
                "value": "",
                "type": "query",
                "description": "The direction in which to order the results"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "The fields to include in the response"
              },
              {
                "name": "start_datetime",
                "value": "",
                "type": "query",
                "description": "The start datetime for filtering results"
              },
              {
                "name": "end_datetime",
                "value": "",
                "type": "query",
                "description": "The end datetime for filtering results"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Syllable-API-Key",
              "value": "{{Syllable-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "List the existing roles."
        },
        {
          "info": {
            "name": "Create Role",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.syllable.cloud/api/v1/roles/",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Syllable-API-Key",
              "value": "{{Syllable-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Create a new role."
        },
        {
          "info": {
            "name": "Update Role",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.syllable.cloud/api/v1/roles/",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Syllable-API-Key",
              "value": "{{Syllable-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Update an existing role."
        },
        {
          "info": {
            "name": "Get Role",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.syllable.cloud/api/v1/roles/:role_id",
            "params": [
              {
                "name": "role_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Syllable-API-Key",
              "value": "{{Syllable-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Fetch a given role."
        },
        {
          "info": {
            "name": "Delete Role",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.syllable.cloud/api/v1/roles/:role_id",
            "params": [
              {
                "name": "role_id",
                "value": "",
                "type": "path",
                "description": "The ID of the role to delete"
              },
              {
                "name": "reason",
                "value": "",
                "type": "query",
                "description": "The reason for deleting the role"
              },
              {
                "name": "new_role_id",
                "value": "",
                "type": "query",
                "description": "Users with the deleted role will be reassigned to the new role, if a new role ID is provided"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Syllable-API-Key",
              "value": "{{Syllable-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Delete a role. Optionally, reassign existing users with that role to a new role."
        }
      ]
    }
  ],
  "bundled": true
}