role

Modify a role by id

This can only be done by a logged in user who has the required privileges.

patch/api/v1/roles/{id}

Path parameters

idstring required

Role id

Request body

namestring
descriptionstring
permissionsPermissions[]
isGlobalboolean

Response

successful operation

Changes

Changed in 4 of the 19 revisions of this API.217

  • 016871a170fd11See the full diff
    • api path removed without deprecation

      api-path-removed-without-deprecation

    • endpoint added

      endpoint-added

    • removed the request property scope

      request-property-removed

    • added the new optional request property description

      new-optional-request-property

    • added the new optional request property isGlobal

      new-optional-request-property

    • the request's body type/format changed from / to object/

      request-body-type-changed

    • added the new optional request property name

      new-optional-request-property

    • added the new optional request property permissions

      new-optional-request-property

    • added the new optional request property scope

      new-optional-request-property

    • endpoint added

      endpoint-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog