role

get a role by id

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

get/api/v1/roles/{id}

Path parameters

idstring required

Role id

Response

Role data

idstring
namestring
permissionsPermissions[]
scopestring
createdAtstring
updatedAtstring
isGlobalboolean
descriptionstring

Changes

Changed in 7 of the 19 revisions of this API.1411

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

      api-path-removed-without-deprecation

    • endpoint added

      endpoint-added

    • added the optional property description to the response with the 200 status

      response-optional-property-added

    • added the optional property isGlobal to the response with the 200 status

      response-optional-property-added

    • removed the optional property isCreated from the response with the 200 status

      response-optional-property-removed

    • removed the optional property isUpdated from the response with the 200 status

      response-optional-property-removed

    • added the optional property createdAt to the response with the 200 status

      response-optional-property-added

    • added the optional property updatedAt to the response with the 200 status

      response-optional-property-added

    • added the optional property id to the response with the 200 status

      response-optional-property-added

    • added the optional property isCreated to the response with the 200 status

      response-optional-property-added

    • added the optional property isUpdated to the response with the 200 status

      response-optional-property-added

    • removed the optional property description from the response with the 200 status

      response-optional-property-removed

    • added the optional property scope to the response with the 200 status

      response-optional-property-added

    • removed the optional property scope from the response with the 200 status

      response-optional-property-removed

    • added the optional property description to the response with the 200 status

      response-optional-property-added

    • 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