Bryce Kalow
bd8cc5464e
* migrates nav data format and updates docs pages * removes sidebar_title from content files * updates api docs to work with new format
46 lines
1.1 KiB
Plaintext
46 lines
1.1 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Domain Model - Roles
|
|
description: |-
|
|
The anatomy of a Boundary role
|
|
---
|
|
|
|
# Roles
|
|
|
|
A role is a resource
|
|
that contains a collection of [permissions][]
|
|
which are granted to any principal assigned to the role.
|
|
[Users][] and [groups][] are principals
|
|
which allows either to be assigned to a role.
|
|
A role can be defined within any [scope][].
|
|
A role can be assigned to principals from any scope.
|
|
|
|
## Attributes
|
|
|
|
A role has the following configurable attributes:
|
|
|
|
- `name` - (optional)
|
|
If set, the `name` must be unique within the role's [project][].
|
|
|
|
- `description` - (optional)
|
|
|
|
## Referenced By
|
|
|
|
- [Group][]
|
|
- [Project][]
|
|
- [User][]
|
|
|
|
[group]: /docs/concepts/domain-model/groups
|
|
[groups]: /docs/concepts/domain-model/groups
|
|
[permissions]: /docs/concepts/security/permissions
|
|
[project]: /docs/concepts/domain-model/scopes#projects
|
|
[scope]: /docs/concepts/domain-model/scopes
|
|
[user]: /docs/concepts/domain-model/users
|
|
[users]: /docs/concepts/domain-model/users
|
|
|
|
## Service API Docs
|
|
|
|
The following services are relevant to this resource:
|
|
|
|
- [Role Service](/api-docs/role-service)
|