Away 11:54 PM

4 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

GroupRole — openapi

A configurable property to grant specific privileges for members within a group.

Properties

NameTypeRequiredDescription
pathstringfalseThe resource path of the group role. Format: groups/{group_id}/roles/{group_role_id}
createTimestringfalseThe timestamp for when the group role was last updated. Visible only to owners of the group.
updateTimestringfalseThe timestamp when the group role was last updated. Visible only to owners of the group.
idstringfalseA unique ID that identifies a role. Distinct from a role's rank, which is only unique within the group.
displayNamestringfalseThe name of the role. Has a maximum limit of 100 characters. Names above the limit are rejected.
descriptionstringfalseThe description of the role. Has a maximum limit of 1000 characters. Strings above the limit are rejected. Visible only to owners of the group.
rankintegerfalseThe rank of the role. The minimum value is 0. The maximum value is 255.
memberCountintegerfalseTotal number of members within a role. This field is not returned for guest roles.
permissions#/components/schemas/GroupRole_RolePermissionsfalseThe permissions granted for this role. This value is populated based on the read scope and role of the authorized user or API key creator. If the user or creator is the owner of the parent group, they are able to view all role permissions in the group. If the user or creator is a member of the parent group, they are able to view their role's permissions in the group. Anyone can view guest permissions. In the case that someone can't view the permissions, this field is not returned.

Complete Schema

{
  "type": "object",
  "properties": {
    "path": {
      "example": "groups/123/roles/123",
      "type": "string",
      "description": "The resource path of the group role.\n\nFormat: `groups/{group_id}/roles/{group_role_id}`"
    },
    "createTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The timestamp for when the group role was last updated.\n\nVisible only to owners of the group.",
      "format": "date-time"
    },
    "updateTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The timestamp when the group role was last updated.\n\nVisible only to owners of the group.",
      "format": "date-time"
    },
    "id": {
      "readOnly": true,
      "example": "200",
      "type": "string",
      "description": "A unique ID that identifies a role.\n\nDistinct from a role's rank, which is only unique within the group."
    },
    "displayName": {
      "example": "Member",
      "type": "string",
      "description": "The name of the role.\n\nHas a maximum limit of 100 characters. Names above the limit are\nrejected."
    },
    "description": {
      "example": "This is a description for the role",
      "type": "string",
      "description": "The description of the role.\n\nHas a maximum limit of 1000 characters. Strings above the limit are\nrejected. Visible only to owners of the group."
    },
    "rank": {
      "example": 1,
      "type": "integer",
      "description": "The rank of the role.\n\nThe minimum value is 0. The maximum value is 255.",
      "format": "int32"
    },
    "memberCount": {
      "readOnly": true,
      "example": 10223136,
      "type": "integer",
      "description": "Total number of members within a role.\n\nThis field is not returned for guest roles.",
      "format": "int32"
    },
    "permissions": {
      "$ref": "#/components/schemas/GroupRole_RolePermissions",
      "description": "The permissions granted for this role.\n\nThis value is populated based on the read scope and role of the authorized\nuser or API key creator. If the user or creator is the owner of the parent\ngroup, they are able to view all role permissions in the group. If the user\nor creator is a member of the parent group, they are able to view their\nrole's permissions in the group. Anyone can view guest permissions. In\nthe case that someone can't view the permissions, this field is not\nreturned."
    }
  },
  "description": "A configurable property to grant specific privileges for members within a\ngroup.",
  "x-aep-resource": {
    "patterns": [
      "groups/{group_id}/roles/{group_role_id}"
    ],
    "plural": "group-roles",
    "singular": "group-role"
  },
  "x-resource": true,
  "x-oneOf": {
    "Description": [
      "description"
    ],
    "MemberCount": [
      "memberCount"
    ]
  }
}