role_definitions

PATCH /role_definitions/{id}/

Changed on

Role Definitions (roles) contain a list of permissions and can be used to assign those permissions to a user or team through the respective assignment endpoints.

Custom roles can be created, modified, and deleted through this endpoint. System-managed roles are shown here, which cannot be edited or deleted, but can be assigned to users.

Request

  • Base URL
    /api/eda/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/eda/v1/role_definitions/{id}/
  • Auth
    • API key in cookie sessionid
    • or HTTP basic
    • or HTTP bearer
    • or API key in header X-DAB-JW-TOKEN

Path parameters

idinteger required

A unique integer value identifying this role definition.

Request body

idinteger
urlstring
relatedobject
summary_fieldsobject
permissionsPermissionsEnum[]
modifiedstring date-time

The date/time this resource was created

createdstring date-time

The date/time this resource was created

namestring
descriptionstring
managedboolean
modified_byinteger nullable

The user who last modified this resource

created_byinteger nullable

The user who created this resource

Response

idinteger required
urlstring required
relatedobject required
summary_fieldsobject required
permissionsPermissionsEnum[] required
modifiedstring date-time required

The date/time this resource was created

createdstring date-time required

The date/time this resource was created

namestring required
descriptionstring
managedboolean required
modified_byinteger nullable required

The user who last modified this resource

created_byinteger nullable required

The user who created this resource

Changes

    • breaking

      removed the enum value eda.add_credentialtype of the request property / (media type: application/json)

    • breaking

      removed the enum value eda.add_credentialtype of the request property / (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value eda.add_credentialtype of the request property / (media type: multipart/form-data)

    • breaking

      removed the enum value eda.add_team of the request property / (media type: application/json)

    • breaking

      removed the enum value eda.add_team of the request property / (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value eda.add_team of the request property / (media type: multipart/form-data)

    • breaking

      removed the enum value eda.change_credentialtype of the request property / (media type: application/json)

    • breaking

      removed the enum value eda.change_credentialtype of the request property / (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value eda.change_credentialtype of the request property / (media type: multipart/form-data)

    • breaking

      removed the enum value eda.change_organization of the request property / (media type: application/json)

    • breaking

      removed the enum value eda.change_organization of the request property / (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value eda.change_organization of the request property / (media type: multipart/form-data)

    • breaking

      removed the enum value eda.change_team of the request property / (media type: application/json)

    • breaking

      removed the enum value eda.change_team of the request property / (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value eda.change_team of the request property / (media type: multipart/form-data)

    • breaking

      removed the enum value eda.credentialtype of the request property //// (media type: application/json)

    • breaking

      removed the enum value eda.credentialtype of the request property //// (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value eda.credentialtype of the request property //// (media type: multipart/form-data)

    • breaking

      removed the enum value eda.delete_credentialtype of the request property / (media type: application/json)

    • breaking

      removed the enum value eda.delete_credentialtype of the request property / (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value eda.delete_credentialtype of the request property / (media type: multipart/form-data)

    • breaking

      removed the enum value eda.delete_organization of the request property / (media type: application/json)

    • breaking

      removed the enum value eda.delete_organization of the request property / (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value eda.delete_organization of the request property / (media type: multipart/form-data)

    • breaking

      removed the enum value eda.delete_team of the request property / (media type: application/json)

    • breaking

      removed the enum value eda.delete_team of the request property / (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value eda.delete_team of the request property / (media type: multipart/form-data)

    • breaking

      removed the enum value eda.member_organization of the request property / (media type: application/json)

    • breaking

      removed the enum value eda.member_organization of the request property / (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value eda.member_organization of the request property / (media type: multipart/form-data)

    • breaking

      removed the enum value eda.member_team of the request property / (media type: application/json)

    • breaking

      removed the enum value eda.member_team of the request property / (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value eda.member_team of the request property / (media type: multipart/form-data)

    • breaking

      removed the enum value eda.view_credentialtype of the request property / (media type: application/json)

    • breaking

      removed the enum value eda.view_credentialtype of the request property / (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value eda.view_credentialtype of the request property / (media type: multipart/form-data)

    • breaking

      removed the enum value eda.view_organization of the request property / (media type: application/json)

    • breaking

      removed the enum value eda.view_organization of the request property / (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value eda.view_organization of the request property / (media type: multipart/form-data)

    • breaking

      removed the enum value eda.view_team of the request property / (media type: application/json)

    • breaking

      removed the enum value eda.view_team of the request property / (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value eda.view_team of the request property / (media type: multipart/form-data)

    • warning

      added the new eda.add_eventstream enum value to the / response property for the response status

    • warning

      added the new eda.change_eventstream enum value to the / response property for the response status

    • warning

      added the new eda.delete_eventstream enum value to the / response property for the response status

    • warning

      added the new eda.eventstream enum value to the //// response property for the response status

    • warning

      added the new eda.sync_project enum value to the / response property for the response status

    • warning

      added the new eda.view_eventstream enum value to the / response property for the response status

    • warning

      added the new shared.add_team enum value to the / response property for the response status

    • warning

      added the new shared.change_organization enum value to the / response property for the response status

    • warning

      added the new shared.change_team enum value to the / response property for the response status

    • warning

      added the new shared.delete_organization enum value to the / response property for the response status

    • warning

      added the new shared.delete_team enum value to the / response property for the response status

    • warning

      added the new shared.member_organization enum value to the / response property for the response status

    • warning

      added the new shared.member_team enum value to the / response property for the response status

    • warning

      added the new shared.view_organization enum value to the / response property for the response status

    • warning

      added the new shared.view_team enum value to the / response property for the response status

    • info

      added the new eda.add_eventstream enum value to the request property / (media type: application/json)

    • info

      added the new eda.add_eventstream enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new eda.add_eventstream enum value to the request property / (media type: multipart/form-data)

    • info

      added the new eda.change_eventstream enum value to the request property / (media type: application/json)

    • info

      added the new eda.change_eventstream enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new eda.change_eventstream enum value to the request property / (media type: multipart/form-data)

    • info

      added the new eda.delete_eventstream enum value to the request property / (media type: application/json)

    • info

      added the new eda.delete_eventstream enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new eda.delete_eventstream enum value to the request property / (media type: multipart/form-data)

    • info

      added the new eda.eventstream enum value to the request property //// (media type: application/json)

    • info

      added the new eda.eventstream enum value to the request property //// (media type: application/x-www-form-urlencoded)

    • info

      added the new eda.eventstream enum value to the request property //// (media type: multipart/form-data)

    • info

      added the new eda.sync_project enum value to the request property / (media type: application/json)

    • info

      added the new eda.sync_project enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new eda.sync_project enum value to the request property / (media type: multipart/form-data)

    • info

      added the new eda.view_eventstream enum value to the request property / (media type: application/json)

    • info

      added the new eda.view_eventstream enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new eda.view_eventstream enum value to the request property / (media type: multipart/form-data)

    • info

      added the new shared.add_team enum value to the request property / (media type: application/json)

    • info

      added the new shared.add_team enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new shared.add_team enum value to the request property / (media type: multipart/form-data)

    • info

      added the new shared.change_organization enum value to the request property / (media type: application/json)

    • info

      added the new shared.change_organization enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new shared.change_organization enum value to the request property / (media type: multipart/form-data)

    • info

      added the new shared.change_team enum value to the request property / (media type: application/json)

    • info

      added the new shared.change_team enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new shared.change_team enum value to the request property / (media type: multipart/form-data)

    • info

      added the new shared.delete_organization enum value to the request property / (media type: application/json)

    • info

      added the new shared.delete_organization enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new shared.delete_organization enum value to the request property / (media type: multipart/form-data)

    • info

      added the new shared.delete_team enum value to the request property / (media type: application/json)

    • info

      added the new shared.delete_team enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new shared.delete_team enum value to the request property / (media type: multipart/form-data)

    • info

      added the new shared.member_organization enum value to the request property / (media type: application/json)

    • info

      added the new shared.member_organization enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new shared.member_organization enum value to the request property / (media type: multipart/form-data)

    • info

      added the new shared.member_team enum value to the request property / (media type: application/json)

    • info

      added the new shared.member_team enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new shared.member_team enum value to the request property / (media type: multipart/form-data)

    • info

      added the new shared.view_organization enum value to the request property / (media type: application/json)

    • info

      added the new shared.view_organization enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new shared.view_organization enum value to the request property / (media type: multipart/form-data)

    • info

      added the new shared.view_team enum value to the request property / (media type: application/json)

    • info

      added the new shared.view_team enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new shared.view_team enum value to the request property / (media type: multipart/form-data)

    • info

      removed the eda.add_credentialtype enum value from the / response property for the response status

    • info

      removed the eda.add_team enum value from the / response property for the response status

    • info

      removed the eda.change_credentialtype enum value from the / response property for the response status

    • info

      removed the eda.change_organization enum value from the / response property for the response status

    • info

      removed the eda.change_team enum value from the / response property for the response status

    • info

      removed the eda.credentialtype enum value from the //// response property for the response status

    • info

      removed the eda.delete_credentialtype enum value from the / response property for the response status

    • info

      removed the eda.delete_organization enum value from the / response property for the response status

    • info

      removed the eda.delete_team enum value from the / response property for the response status

    • info

      removed the eda.member_organization enum value from the / response property for the response status

    • info

      removed the eda.member_team enum value from the / response property for the response status

    • info

      removed the eda.view_credentialtype enum value from the / response property for the response status

    • info

      removed the eda.view_organization enum value from the / response property for the response status

    • info

      removed the eda.view_team enum value from the / response property for the response status

    • breaking

      removed the enum value eda.add_extravar of the request property / (media type: application/json)

    • breaking

      removed the enum value eda.add_extravar of the request property / (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value eda.add_extravar of the request property / (media type: multipart/form-data)

    • breaking

      removed the enum value eda.extravar of the request property //// (media type: application/json)

    • breaking

      removed the enum value eda.extravar of the request property //// (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value eda.extravar of the request property //// (media type: multipart/form-data)

    • breaking

      removed the enum value eda.view_extravar of the request property / (media type: application/json)

    • breaking

      removed the enum value eda.view_extravar of the request property / (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value eda.view_extravar of the request property / (media type: multipart/form-data)

    • info

      removed the eda.add_extravar enum value from the / response property for the response status

    • info

      removed the eda.extravar enum value from the //// response property for the response status

    • info

      removed the eda.view_extravar enum value from the / response property for the response status