Skip to main content

Patch a blueprint's permissions

PATCH 
/v1/blueprints/:blueprint_identifier/permissions

This route allows you to patch the permissions of a blueprint.

To learn more about permissions, check out the documentation.

Request​

Path Parameters

    blueprint_identifier stringrequired

    Possible values: non-empty

    The identifier of the blueprint whose permissions you want to patch.

Body

    entities

    object

    register

    object

    Define who has permissions to create entities of this blueprint.

    users string[]

    List of users (email addresses) that are allowed to create entities of this blueprint.

    teams string[]

    List of teams that are allowed to create entities of this blueprint.

    roles string[]

    List of roles that are allowed to create entities of this blueprint.

    ownedByTeam boolean

    If true, permissions will be determined by team ownership, rather than by roles or direct assignment to users. Every user will be able to create entities belonging to their team/s.

    update

    object

    Define who has permissions to modify entities of this blueprint.

    users string[]

    List of users (email addresses) that are allowed to modify entities of this blueprint.

    teams string[]

    List of teams that are allowed to modify entities of this blueprint.

    roles string[]

    List of roles that are allowed to modify entities of this blueprint.

    ownedByTeam boolean

    If true, permissions will be determined by team ownership, rather than by roles or direct assignment to users. Every user will be able to modify entities belonging to their team/s.

    unregister

    object

    Define who has permissions to delete entities of this blueprint.

    users string[]

    List of users (email addresses) that are allowed to delete entities of this blueprint.

    teams string[]

    List of teams that are allowed to delete entities of this blueprint.

    roles string[]

    List of roles that are allowed to delete entities of this blueprint.

    ownedByTeam boolean

    If true, permissions will be determined by team ownership, rather than by roles or direct assignment to users. Every user will be able to delete entities belonging to their team/s.

    updateProperties

    object

    Define who has permissions to modify specific properties in entities of this blueprint.

    property name*

    object

    users string[]

    List of users (email addresses) that are allowed to modify properties in entities of this blueprint.

    teams string[]

    List of teams that are allowed to modify properties in entities of this blueprint.

    roles string[]

    List of roles that are allowed to modify properties in entities of this blueprint.

    ownedByTeam boolean

    If true, permissions will be determined by team ownership, rather than by roles or direct assignment to users. Every user will be able to modify properties in entities belonging to their team/s.

    updateRelations

    object

    Define who has permissions to modify specific relations in entities of this blueprint.

    property name*

    object

    users string[]

    List of users (email addresses) that are allowed to modify relations in entities of this blueprint.

    teams string[]

    List of teams that are allowed to modify relations in entities of this blueprint.

    roles string[]

    List of roles that are allowed to modify relations in entities of this blueprint.

    ownedByTeam boolean

    If true, permissions will be determined by team ownership, rather than by roles or direct assignment to users. Every user will be able to modify relations in entities belonging to their team/s.

Responses​

Default Response

Loading...
Last updated on