role_definitions

GET /role_definitions/

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/
  • Auth
    • API key in cookie sessionid
    • or HTTP basic
    • or HTTP bearer
    • or API key in header X-DAB-JW-TOKEN

Query parameters

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

searchstring

A search term.

Response

countinteger
nextstring uri nullable
previousstring uri nullable
page_sizeinteger nullable
pageinteger nullable

Example response

{
  "count": 123,
  "next": "/eda/api/v1/example/?page=51&page_size=100",
  "previous": "/eda/api/v1/example/?page=49&page_size=100",
  "page_size": 100,
  "page": 50
}

Changes

    • 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

      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

    • 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