---
title: "Role"
url: "https://dev.developer-internal.sanofi.com/apis/plta-permissions-api-cbz/versions/88cdfef8-3b56-44ca-883d-5b15378e5a3a/schemas/Role"
---

> Full API specification: https://dev.developer-internal.sanofi.com/apis/plta-permissions-api-cbz/versions/88cdfef8-3b56-44ca-883d-5b15378e5a3a.md

# Role

A named bundle of access and admin grants, scoped to an action and a resource. All of a role's grants are always contained within this scope.

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Permission Administration API
  version: 1.5.0
servers:
  - url: https://dev.api.sanofi.com/permissions
components:
  schemas:
    Role:
      description: A named bundle of access and admin grants, scoped to an action and
        a resource. All of a role's grants are always contained within this
        scope.
      properties:
        description:
          description: A human-readable description of the role's purpose.
          type: string
        roleName:
          description: The business identifier of the role.
          examples:
            - clintrials:study-reader
          type: string
        scopeAction:
          description: The action (with its hierarchy) that bounds this role's access and
            admin grants. Immutable once the role is created.
          examples:
            - read
          type: string
        scopeResource:
          description: The resource (with its hierarchy) that bounds this role's access
            and admin grants. Immutable once the role is created.
          examples:
            - clintrials
          type: string
      required:
        - roleName
        - scopeAction
        - scopeResource
      type: object
```