RECENT UPDATES:
05-Jun-2026 | v7.10.7 | All new article

Change Log

  • 05-Jun-2026 | v7.10.7 | All new article

Contributors:

{
  "id": 2418,
  "name": "Adam Wilson",
  "url": "/adam-wilson"
}
Adam Wilson - Logo Pogo

Admin User Roles API

Create, Retrieve, Update and Delete Admin Roles via the public API endpoint using "where" filtering. The default restrictions schema for Admin Roles can also be retrieved via this API.

GET Admin Roles List

Retrieves a list of Admin Roles as a JSON response based on your provided query parameters.

/api/v2/admin/admin-roles

Parameters

Parameter
Values
Required
Where
{<where query>}
Order_By
<propertyAlias>
Semantic_Query
<string>
Min_Score
<double>
Offset
<integer>
Limit
<integer>

Data / Response:

N/A

{
  "Items": [
    {
      "Id": "string",
      "Name": "string"
    }
  ],
  "TotalItemsCount": 0
}

POST Admin Role Create

Creates a new Admin Role based on the provided data.

/api/v2/admin/admin-roles

Data / Response:

{
  "Name": "string",
  "Restrictions": {
    "<GroupAlias1>": {
      "Restrictions": {
        "<PermissionAlias1>": {
          "Value": true,
          "Weight": 0
        },
        "<PermissionAlias2>": {
          "Value": true,
          "Weight": 0
        }
      }
    },
    "<GroupAlias2>": {
      "Restrictions": {
        "<PermissionAlias1>": {
          "Value": true,
          "Weight": 0
        },
        "<PermissionAlias2>": {
          "Value": true,
          "Weight": 0
        }
      }
    }
  }
}

{
  "Id": "string",
  "Name": "string",
  "Restrictions": {
    "<GroupAlias1>": {
      "Restrictions": {
        "<PermissionAlias1>": {
          "Value": true,
          "Weight": 0
        },
        "<PermissionAlias2>": {
          "Value": true,
          "Weight": 0
        }
      }
    },
    "<GroupAlias2>": {
      "Restrictions": {
        "<PermissionAlias1>": {
          "Value": true,
          "Weight": 0
        },
        "<PermissionAlias2>": {
          "Value": true,
          "Weight": 0
        }
      }
    }
  },
  "HasAccessToFtp": true
}

GET Admin Role Item

Retrieves a single Admin Role based on the ID passed in the endpoint URL.

/api/v2/admin/admin-roles/{id}

Data / Response:

N/A

{
  "Id": "string",
  "Name": "string",
  "Restrictions": {
    "<GroupAlias1>": {
      "Restrictions": {
        "<PermissionAlias1>": {
          "Value": true,
          "Weight": 0
        },
        "<PermissionAlias2>": {
          "Value": true,
          "Weight": 0
        }
      }
    },
    "<GroupAlias2>": {
      "Restrictions": {
        "<PermissionAlias1>": {
          "Value": true,
          "Weight": 0
        },
        "<PermissionAlias2>": {
          "Value": true,
          "Weight": 0
        }
      }
    }
  },
  "HasAccessToFtp": true
}

PUT Admin Role Update

Updates a single Admin Role based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/admin-roles/{id}

Data / Response:

{
  "Name": "string",
  "Restrictions": {
    "<GroupAlias1>": {
      "Restrictions": {
        "<PermissionAlias1>": {
          "Value": true,
          "Weight": 0
        },
        "<PermissionAlias2>": {
          "Value": true,
          "Weight": 0
        }
      }
    },
    "<GroupAlias2>": {
      "Restrictions": {
        "<PermissionAlias1>": {
          "Value": true,
          "Weight": 0
        },
        "<PermissionAlias2>": {
          "Value": true,
          "Weight": 0
        }
      }
    }
  }
}

{
  "Id": "string",
  "Name": "string",
  "Restrictions": {
    "<GroupAlias1>": {
      "Restrictions": {
        "<PermissionAlias1>": {
          "Value": true,
          "Weight": 0
        },
        "<PermissionAlias2>": {
          "Value": true,
          "Weight": 0
        }
      }
    },
    "<GroupAlias2>": {
      "Restrictions": {
        "<PermissionAlias1>": {
          "Value": true,
          "Weight": 0
        },
        "<PermissionAlias2>": {
          "Value": true,
          "Weight": 0
        }
      }
    }
  },
  "HasAccessToFtp": true
}

DELETE Admin Role Delete

Deletes a single Admin Role based on the ID passed in the endpoint URL.

/api/v2/admin/admin-roles/{id}

Data / Response:

N/A

Status 204

GET Admin Role Default Restrictions List

Retrieves the default restrictions schema for Admin Roles as a JSON response, including all available permission groups, their aliases, and default values.

/api/v2/admin/admin-roles/admin-roles-default-restrictions

Data / Response:

N/A

[
  {
    "EntityAlias": "string",
    "EntityType": "string",
    "Name": "string",
    "Alias": "string",
    "Restrictions": [
      {
        "Label": "string",
        "Alias": "string",
        "Value": true
      }
    ]
  }
]