role_user_assignments

GET /role_user_assignments/{id}/

Changed on

Use this endpoint to give a user permission to a resource or an organization. The needed data is the user, the role definition, and the object id. The object must be of the type specified in the role definition. The type given in the role definition and the provided object_id are used to look up the resource.

After creation, the assignment cannot be edited, but can be deleted to remove those permissions.

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_user_assignments/{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 user assignment.

Response

idinteger required
urlstring required
relatedobject required
summary_fieldsobject required
createdstring date-time required

The date/time this resource was created

created_byinteger nullable required

The user who created this resource

content_type'eda.activation' | 'eda.auditrule' | 'eda.decisionenvironment' | 'eda.edacredential' | 'eda.eventstream' | 'eda.project' | 'eda.rulebook' | 'eda.rulebookprocess' | 'shared.organization' | 'shared.team' required
  • eda.activation - Activation
  • eda.auditrule - Audit Rule
  • eda.decisionenvironment - Decision Environment
  • eda.edacredential - Eda Credential
  • eda.eventstream - Event Stream
  • eda.project - Project
  • eda.rulebook - Rulebook
  • eda.rulebookprocess - Rulebook Process
  • shared.organization - Organization
  • shared.team - Team
object_idstring nullable

Primary key of the object this assignment applies to, null value indicates system-wide assignment

object_ansible_idstring uuid nullable

Resource id of the object this role applies to. Alternative to the object_id field.

role_definitioninteger required

The role definition which defines permissions conveyed by this assignment

userinteger
user_ansible_idstring uuid nullable

Resource id of the user who will receive permissions from this assignment. Alternative to user field.

Changes

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • warning

      added the new eda.eventstream enum value to 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.extravar enum value from the //// response property for the response status