Identity__roles

Requires a signed-in staff user. Needs the `identity__Role` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

QUERYidentity__roles(where: CommonPaginationDto): RolesWithPagination!

Requires a signed-in staff user. Needs the identity__Role read permission. Send the x-tenant header (the gateway sets it from your API key).

Arguments

where?

Returns

identity__roles

meta?

nodes?

Example Request

query Identity__roles {
  identity__roles {
    meta {
      currentPage
      hasNextPage
      totalCount
      totalPages
    }
    nodes {
      _id
      assignedUserCount
      createdAt
      name
      permissions {
        actions
        collectionName
      }
      tenant
      updatedAt
    }
  }
}

query Identity__roles {  identity__roles {    meta {      currentPage      hasNextPage      totalCount      totalPages    }    nodes {      _id      assignedUserCount      createdAt      name      permissions {        actions        collectionName      }      tenant      updatedAt    }  }}

Example Response

{
  "data": {
    "identity__roles": {
      "meta": {
        "currentPage": 10.5,
        "hasNextPage": true,
        "totalCount": 10.5,
        "totalPages": 10.5
      },
      "nodes": [
        {
          "_id": "1",
          "assignedUserCount": 10,
          "createdAt": "<DateTime>",
          "name": "string",
          "permissions": [
            {
              "actions": [
                "string"
              ],
              "collectionName": "string"
            }
          ],
          "tenant": "string",
          "updatedAt": "<DateTime>"
        }
      ]
    }
  }
}

Example Response

{  "data": {    "identity__roles": {      "meta": {        "currentPage": 10.5,        "hasNextPage": true,        "totalCount": 10.5,        "totalPages": 10.5      },      "nodes": [        {          "_id": "1",          "assignedUserCount": 10,          "createdAt": "<DateTime>",          "name": "string",          "permissions": [            {              "actions": [                "string"              ],              "collectionName": "string"            }          ],          "tenant": "string",          "updatedAt": "<DateTime>"        }      ]    }  }}

ArgumentsCopy Anchor Link

ReturnsCopy Anchor Link

Arguments

Returns