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

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

# AdminRight

the combination of a user and an administrative operation (such as creating a new action or resource).

## 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:
    AdminRight:
      description: the combination of a user and an administrative operation (such as
        creating a new action or resource).
      properties:
        actionRestriction:
          description: Name of the action that will restrict the action usable in an
            operation to a specific hierarchy. If defined, an administrator
            performing an operation related to an action will need to have this
            action name either as a direct parent or as an ancestor of the
            parent of the action he is using. If not defined, the administrator
            will be able to use any action.
          examples:
            - write_narrative
            - read_compound
          type: string
        adminRightId:
          description: the unique identifier of the admin right, mostly for deletion
            purpose.
          format: uuid
          readOnly: true
          type: string
        operationName:
          description: Name of the operation.
          examples:
            - manageAdminRights
            - manageActions
            - manageResources
          type: string
        operationRestrictions:
          items:
            description: >
              Name of an allowed operation. Values are operation names,
              typically using the same naming convention as operationName (for
              example: manageAdminRights, manageActions, manageResources). If
              this array is defined, a user having a manageAdminRights will only
              be able to create a new admin right with the operations listed
              here. If not defined, the user will be able to create a new admin
              right with any operation. The OpenAPI schema does not formally
              restrict these values; any applicable validation is enforced by
              the server.
            type: string
          type: array
        resourceRestriction:
          description: Name of the resource that will restrict the resource usable in an
            operation to a specific hierarchy. If defined, an administrator
            performing an operation related to a resource will need to have this
            resource name either as a direct parent or as an ancestor of the
            parent of the resource he is using. If not defined, the
            administrator will be able to use any resource.
          examples:
            - compound_1245
            - study_1245
          type: string
        scope:
          description: Scope of the admin right. If defined, the name of the action or
            resource will need to start by this scope as prefix (exemple->
            "clinshow:write_narrative", "dpt:read_compound",
            "platform:manage_admin_rights"). If not defined, the admin right
            will be usable in any scope.
          examples:
            - clinshow
            - dpt
            - platform
          type: string
        userId:
          description: The id of the user, as stored in IDP. For Sanofi internal user, it
            would be the oid (Unique identifier of the user in Azure AD)
          type: string
      required:
        - userId
        - operationName
      type: object
```