GRgrepr
Roles

Update a custom role

Updates an existing custom role. System roles cannot be updated.

put/v1/roles/{roleId}

Request

  • Base URL
    https://docs.grepr.ai (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

roleIdstring required

Request body

descriptionstring required

Description of the role

namestring required

The name of the role

permissionIdsstring[] required

Permission IDs to assign to this role

Example request

{
  "permissionIds": [
    "perm_001",
    "perm_002"
  ]
}

Response

Role updated successfully

builtinboolean

Whether this is a built-in role

createdAtstring date-time

When the role was created (null for system roles)

createdBystring

Who created the role (null for system roles)

descriptionstring required

Description of the role

effectstring

The effect of this role's permissions: 'allow' or 'deny'. Defaults to 'allow' for standard roles.

idstring required

The id of the role.

namestring required

The user-facing name of the role.

permissionIdsstring[] required

Permission IDs assigned to this role (empty for system roles)

Changes

No recorded changes to this operation across all 1 revision of this API.