Portainer resource_controls API

openapi: 3.2.0
info:
  contact:
    email: info@portainer.io
  description: 'Portainer API is an HTTP API served by Portainer. It is used by the Portainer UI and everything you can do with the UI can be done using the HTTP API.

    Examples are available at https://documentation.portainer.io/api/api-examples/

    You can find out more about Portainer at [http://portainer.io](http://portainer.io) and get some support on [Slack](http://portainer.io/slack/).


    # Authentication


    Most of the API environments(endpoints) require to be authenticated as well as some level of authorization to be used.

    Portainer API uses JSON Web Token to manage authentication and thus requires you to provide a token in the **Authorization** header of each request

    with the **Bearer** authentication mechanism.


    Example:


    ```

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGUiOjEsImV4cCI6MTQ5OTM3NjE1NH0.NJ6vE8FY1WG6jsRQzfMqeatJ4vh2TWAeeYfDhP71YEE

    ```


    # Security


    Each API environment(endpoint) has an associated access policy, it is documented in the description of each environment(endpoint).


    Different access policies are available:


    - Public access

    - Authenticated access

    - Restricted access

    - Administrator access


    ### Public access


    No authentication is required to access the environments(endpoints) with this access policy.


    ### Authenticated access


    Authentication is required to access the environments(endpoints) with this access policy.


    ### Restricted access


    Authentication is required to access the environments(endpoints) with this access policy.

    Extra-checks might be added to ensure access to the resource is granted. Returned data might also be filtered.


    ### Administrator access


    Authentication as well as an administrator role are required to access the environments(endpoints) with this access policy.


    # Execute Docker requests


    Portainer **DO NOT** expose specific environments(endpoints) to manage your Docker resources (create a container, remove a volume, etc...).


    Instead, it acts as a reverse-proxy to the Docker HTTP API. This means that you can execute Docker requests **via** the Portainer HTTP API.


    To do so, you can use the `/endpoints/{id}/docker` Portainer API environment(endpoint) (which is not documented below due to Swagger limitations). This environment(endpoint) has a restricted access policy so you still need to be authenticated to be able to query this environment(endpoint). Any query on this environment(endpoint) will be proxied to the Docker API of the associated environment(endpoint) (requests and responses objects are the same as documented in the Docker API).


    # Private Registry


    Using private registry, you will need to pass a based64 encoded JSON string ‘{"registryId":\<registryID value\>}’ inside the Request Header. The parameter name is "X-Registry-Auth".

    \<registryID value\> - The registry ID where the repository was created.


    Example:


    ```

    eyJyZWdpc3RyeUlkIjoxfQ==

    ```


    **NOTE**: You can find more information on how to query the Docker API in the [Docker official documentation](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://documentation.portainer.io/api/api-examples/).

    '
  license:
    name: zlib
    url: https://github.com/portainer/portainer/blob/develop/LICENSE
  title: PortainerCE auth Resource Controls API
  version: 2.39.1
servers:
- url: /api
tags:
- description: Manage access control on Docker resources
  name: resource_controls
paths:
  /resource_controls:
    post:
      description: 'Create a new resource control to restrict access to a Docker resource.

        **Access policy**: administrator'
      operationId: ResourceControlCreate
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portainer.ResourceControl'
        '400':
          description: Invalid request
        '409':
          description: A resource control is already associated to this resource
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Create a new resource control
      tags:
      - resource_controls
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/resourcecontrols.resourceControlCreatePayload'
        description: Resource control details
        required: true
  /resource_controls/{id}:
    delete:
      description: 'Remove a resource control.

        **Access policy**: administrator'
      operationId: ResourceControlDelete
      parameters:
      - description: Resource control identifier
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request
        '404':
          description: Resource control not found
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Remove a resource control
      tags:
      - resource_controls
    put:
      description: 'Update a resource control

        **Access policy**: authenticated'
      operationId: ResourceControlUpdate
      parameters:
      - description: Resource control identifier
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portainer.ResourceControl'
        '400':
          description: Invalid request
        '403':
          description: Unauthorized
        '404':
          description: Resource control not found
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Update a resource control
      tags:
      - resource_controls
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/resourcecontrols.resourceControlUpdatePayload'
        description: Resource control details
        required: true
components:
  schemas:
    portainer.UserResourceAccess:
      properties:
        AccessLevel:
          $ref: '#/components/schemas/portainer.ResourceAccessLevel'
        UserId:
          type: integer
      type: object
    portainer.TeamResourceAccess:
      properties:
        AccessLevel:
          $ref: '#/components/schemas/portainer.ResourceAccessLevel'
        TeamId:
          type: integer
      type: object
    resourcecontrols.resourceControlCreatePayload:
      properties:
        AdministratorsOnly:
          description: Permit access to resource only to admins
          example: true
          type: boolean
        Public:
          description: Permit access to the associated resource to any user
          example: true
          type: boolean
        ResourceID:
          example: 617c5f22bb9b023d6daab7cba43a57576f83492867bc767d1c59416b065e5f08
          type: string
        SubResourceIDs:
          description: List of Docker resources that will inherit this access control
          example:
          - 617c5f22bb9b023d6daab7cba43a57576f83492867bc767d1c59416b065e5f08
          items:
            type: string
          type: array
        Teams:
          description: List of team identifiers with access to the associated resource
          example:
          - 56
          - 7
          items:
            type: integer
          type: array
        Type:
          allOf:
          - $ref: '#/components/schemas/portainer.ResourceControlType'
          description: 'Type of Resource. Valid values are: 1 - container, 2 - service

            3 - volume, 4 - network, 5 - secret, 6 - stack, 7 - config, 8 - custom template, 9 - azure-container-group'
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          - 8
          - 9
          example: 1
        Users:
          description: List of user identifiers with access to the associated resource
          example:
          - 1
          - 4
          items:
            type: integer
          type: array
      required:
      - ResourceID
      - Type
      type: object
    resourcecontrols.resourceControlUpdatePayload:
      properties:
        AdministratorsOnly:
          description: Permit access to resource only to admins
          example: true
          type: boolean
        Public:
          description: Permit access to the associated resource to any user
          example: true
          type: boolean
        Teams:
          description: List of team identifiers with access to the associated resource
          example:
          - 7
          items:
            type: integer
          type: array
        Users:
          description: List of user identifiers with access to the associated resource
          example:
          - 4
          items:
            type: integer
          type: array
      type: object
    portainer.ResourceControlType:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      type: integer
      x-enum-varnames:
      - _
      - ContainerResourceControl
      - ServiceResourceControl
      - VolumeResourceControl
      - NetworkResourceControl
      - SecretResourceControl
      - StackResourceControl
      - ConfigResourceControl
      - CustomTemplateResourceControl
      - ContainerGroupResourceControl
    portainer.ResourceAccessLevel:
      enum:
      - 0
      - 1
      type: integer
      x-enum-varnames:
      - _
      - ReadWriteAccessLevel
    portainer.ResourceControl:
      properties:
        AccessLevel:
          $ref: '#/components/schemas/portainer.ResourceAccessLevel'
        AdministratorsOnly:
          description: Permit access to resource only to admins
          example: true
          type: boolean
        Id:
          description: ResourceControl Identifier
          example: 1
          type: integer
        OwnerId:
          description: 'Deprecated fields

            Deprecated in DBVersion == 2'
          type: integer
        Public:
          description: Permit access to the associated resource to any user
          example: true
          type: boolean
        ResourceId:
          description: 'Docker resource identifier on which access control will be applied.\

            In the case of a resource control applied to a stack, use the stack name as identifier'
          example: 617c5f22bb9b023d6daab7cba43a57576f83492867bc767d1c59416b065e5f08
          type: string
        SubResourceIds:
          description: List of Docker resources that will inherit this access control
          example:
          - 617c5f22bb9b023d6daab7cba43a57576f83492867bc767d1c59416b065e5f08
          items:
            type: string
          type: array
        System:
          type: boolean
        TeamAccesses:
          items:
            $ref: '#/components/schemas/portainer.TeamResourceAccess'
          type: array
        Type:
          allOf:
          - $ref: '#/components/schemas/portainer.ResourceControlType'
          description: 'Type of Docker resource. Valid values are: 1- container, 2 -service

            3 - volume, 4 - secret, 5 - stack, 6 - config or 7 - custom template'
          example: 1
        UserAccesses:
          items:
            $ref: '#/components/schemas/portainer.UserResourceAccess'
          type: array
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-KEY
      type: apiKey
    jwt:
      in: header
      name: Authorization
      type: apiKey