- 8 minutes to read

Permission Set for the Repository Model

The Repository Model permission set decides who can read, create, and change the documentation of your integration landscape in the Repository Model. Architects can maintain Integrations, Systems, and Services, support teams can keep Knowledge Base Articles current, and everyone else can read what they need.

  • ✅ Role-based access control for every Repository Model entity
  • ✅ Separate Access (read), Create, and Modify rights
  • ✅ Self-service documentation without administrator rights
  • ✅ One set of rights per entity type, the same for every item of that type

Give the Role Contoso: Order Desk Repository Access and Create on Systems, then see what a member may do, animated walkthrough (7.12)
Animated walkthrough: Create without Modify lets members add Systems, but not edit or delete them.

  1. Open the Role (Contoso: Order Desk) and its Repository Permissions tab.
  2. Under Global permissions, set Access on the Repository row to Allow.
  3. In the Systems group, set Access to Allow, and Create on the Permissions for all row to Allow. Leave Modify on Inherited.
  4. Click Save.
  5. As a member of the Role: Repository > Systems shows Add System, but the Action menu of a System has no Edit and no Delete, because Modify isn't allowed.

C4 Diagram Sets have their own permission set, see Permission Set for C4 Diagram Sets. How end-users browse the Repository is covered in Getting Started with Repository.

Understanding the Repository Model Permission Set

The global Access right on Repository is the gate: without it, the Repository menu isn't shown at all. Below it, each entity has its own Access, Create, and Modify rights: Access on the entity's Access row, Create and Modify on its Permissions for all row.

flowchart LR G["fa:fa-globe Repository Access
global gate"] -->|"Allow"| E["fa:fa-cubes Entity rights
Integrations, Systems, Services,
Contracts, Message Types, Endpoints,
Articles, Custom Fields, Custom Metadata,
BPMs, Domains"] E --> A["fa:fa-lock Access
read-only"] E --> C["fa:fa-file-plus Create"] E --> M["fa:fa-file-edit Modify"] style G fill:#2678BD,color:#fff style E fill:#E47528,color:#fff style A fill:#3F827B,color:#fff style C fill:#9E59BB,color:#fff style M fill:#9E59BB,color:#fff

Blue = the global Repository gate, orange = the per-entity rows, teal = read access, purple = rights that change the documentation.

Set permissions on Roles. Each value is one of:

  • Inherited – Default. Nothing is stored, so the right is not granted, unless the end-user is a member of another Role that allows it.

    Note

    Inherited is NOT the same as Deny! It grants nothing by itself, but another Role can still allow the right. How rights add up across Roles is explained in What is a Role?.

  • Allow – Access is granted.
  • Deny – The feature is blocked. Use this setting only for special cases.

Note

Regardless of other permission sets, a Deny always wins. Since entities are assigned to Roles, you should rarely need Deny. Instead, consider removing the entity from the Roles.

Access (read-only)

If the permission is set to Allow, the end-user can see the entity's items, read-only, and export them.

Create

If the permission is set to Allow, the end-user can create new items of the entity in the Repository Model. New 7.12 Every action that makes a new item needs Create: Add, Duplicate, Copy as Template, uploading an image or a file, and cloning, duplicating, adding the next layer to, or drafting a C4 Diagram. Modify alone no longer shows Duplicate in the row Action menu, and the Web API refuses it too. Cloning an Article also needs Access on every entity the Article is linked to, because the copy keeps those links; see Clone a Document.

Modify

If the permission is set to Allow, the end-user can change existing items of the entity in the Repository Model: edit and save, delete and restore, and Manage Tags. Modify also covers the bulk actions on Articles, Images, and Files.

Delete, Restore, and Permanently Delete

Modify also lets the end-user delete items, a soft delete, and restore deleted ones. Permanently Delete isn't a separate right; New 7.12 who may use it depends on the kind of item:

Model Items Permanently Delete needs
User content Articles, Snippets, Templates, Document Profiles, Images, Files, C4 Diagram Sets, and C4 Diagrams Modify, on live or deleted items
System entities Everything else The built-in Administrator Role, and only after the item is deleted

A menu shows only the entries the user's Role allows. A screenshot taken as an Administrator therefore shows more entries than most users see. Each entity's steps are in Manage the Repository, and the delete models in Two delete models; see also Show deleted records.

Entities in the Permission Set

The rights are set per entity type. The Role editor has no rights for single items, such as one System.

Entity Rights Notes
Integrations Access, Create, Modify Root object of the Repository Model
Systems Access, Create, Modify
Services Access, Create, Modify
Contracts Access, Create, Modify Only while UseContracts is true
Message Types Access, Create, Modify
Endpoints Access, Create, Modify
Articles Access, Create, Modify Also covers Snippets, Templates, and Document Profiles
Custom Fields Access, Create, Modify Legacy; the menus are hidden while DisableCustomFields is on
Custom Metadata Access, Create, Modify
BPMs Access, Create, Modify See What permissions does a BPM need?
Domains Access, Create, Modify

Access Repository

To use the Nodinite Repository Model, the User must be a member of a Role granted (Allow) access to the Repository.

Role editor Repository Permissions tab of Contoso: Order Desk with Access set to Allow for Repository, Integrations, Systems, and Services, and Create allowed on Systems (7.12)
The Repository Permissions tab in the Role editor. The Repository group's Access row is the global gate; each entity group, such as Integrations, has an Access row and a Permissions for all row with Create and Modify.

If the Role is denied access to the Repository Model, the Repository item isn't shown in the main menu:

Main menu of a member without the Repository item (7.12)
Without Repository access, the menu shows no Repository item.

Integrations

Members of Roles with Access on Integrations can view Integrations in the Web Client; Create and Modify let them add and change them.

Integrations group in the Repository Permissions tab with its Access row and the Permissions for all row with Create and Modify (7.12)
Example: the Integrations permissions on a Role.

Systems

Members of Roles with Access on Systems can view Systems; Create and Modify let them add and change them.

Systems group in the Repository Permissions tab with its Access row and the Permissions for all row with Create and Modify (7.12)
Example: the Systems permissions on a Role.

Services

Members of Roles with Access on Services can view Services; Create and Modify let them add and change them.

Services group in the Repository Permissions tab with its Access row and the Permissions for all row with Create and Modify (7.12)
Example: the Services permissions on a Role.

Contracts

Members of Roles with Access on Contracts can view Contracts; Create and Modify let them add and change them.

Contracts group in the Repository Permissions tab with its Access row and the Permissions for all row with Create and Modify (7.12)
Example: the Contracts permissions on a Role.

Important

The UseContracts System Parameter must be set to true; otherwise, the Contracts feature is disabled.

Message Types

Members of Roles with Access on Message Types can view Message Types; Create and Modify let them add and change them.

Message Types group in the Repository Permissions tab with its Access row and the Permissions for all row with Create and Modify (7.12)
Example: the Message Types permissions on a Role.

Endpoints

Members of Roles with Access on Endpoints can view Endpoints; Create and Modify let them add and change them.

Endpoints group in the Repository Permissions tab with its Access row and the Permissions for all row with Create and Modify (7.12)
Example: the Endpoints permissions on a Role.

Articles

Members of Roles with Access on Articles can read Knowledge Base Articles; Create and Modify let them write and change them.

Snippets, Templates, and Document Profiles follow the same standard and share these Articles permissions: a Role that may create or modify Articles may also create or modify them. Reading Articles from a Monitor View is a separate right, View Articles, in the Permission Set for Monitor Views.

Articles group in the Repository Permissions tab with its Access row and the Permissions for all row with Create and Modify (7.12)
Example: the Articles permissions on a Role.

New 7.12 Modify on Articles opens every Article, but the entities an Article is linked to are still shown by their own access. The cards on the Article edit page (Systems, Services, and the others), the Relationships view, and the Web API list only the links to entities the user may read: a Repository entity by its Access right here, a Resource (with its Application and Category) by a Monitor View with View Articles, and a C4 node by the C4 Diagram Sets permission and access to its set. An administrator sees every link. Saving the Article keeps the links the user couldn't see, and a link to an entity the user may not read can't be added.

Article edit page for a user who may change Articles and read Services but not Systems: the Systems card is empty, the Services card shows ERP-Finance (7.12)
The Article is linked to one System, one Service, and one C4 node. This user's Role allows Services but not Systems, so only the Service shows.

Custom Fields

Members of Roles with Access on Custom Fields can view Custom Fields; Create and Modify let them add and change them. Custom Fields are legacy; prefer Custom Metadata, and see DisableCustomFields.

Custom Fields group in the Repository Permissions tab with its Access row and the Permissions for all row with Create and Modify (7.12)
Example: the Custom Fields permissions on a Role.

Custom Metadata

Members of Roles with Access on Custom Metadata can view Custom Metadata; Create and Modify let them add and change the definitions.

Custom Metadata group in the Repository Permissions tab with its Access row and the Permissions for all row with Create and Modify (7.12)
Example: the Custom Metadata permissions on a Role.

BPMs

Members of Roles with Access on BPMs can view BPMs; Create and Modify let them add and change them. A BPM also needs Log View and Monitor View rights to show live events, see What permissions does a BPM need?

BPMs group in the Repository Permissions tab with its Access row and the Permissions for all row with Create and Modify (7.12)
Example: the BPMs permissions on a Role.

Domains

Members of Roles with Access on Domains can view Domains; Create and Modify let them add and change them.

Domains group in the Repository Permissions tab with its Access row and the Permissions for all row with Create and Modify (7.12)
Example: the Domains permissions on a Role.

Next Steps

Add or manage Role
Permission Set for C4 Diagram Sets
Repository Model
Manage the Repository - add, edit, delete, and restore per entity

Log View permission set
Monitor Views permission set
What is a Role?
Access Management
Getting Started with Repository
Users
UseContracts and DisableCustomFields – Turn Repository entities on or off