> ## Documentation Index
> Fetch the complete documentation index at: https://docs.effectiveai.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Replace who holds the program’s roles

> Binds each role the latest release declares to the holders named, on this program alone, and leaves a declared role the body leaves out with none bound here. A role the release does not declare is refused. Other programs and the bindings on every program do not change. Workspace admins only.



## OpenAPI

````yaml /openapi.json put /rsl/{id}/roles
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://api.effectiveai.app/api/v2
    description: Production
security:
  - bearerAuth: []
paths:
  /rsl/{id}/roles:
    put:
      tags:
        - Your programs
      summary: Replace who holds the program’s roles
      description: >-
        Binds each role the latest release declares to the holders named, on
        this program alone, and leaves a declared role the body leaves out with
        none bound here. A role the release does not declare is refused. Other
        programs and the bindings on every program do not change. Workspace
        admins only.
      operationId: replaceProgramRoles
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 128
            pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
            description: >-
              Your organization’s ID for the program, chosen at its first
              upload: lowercase letters, digits, dots, underscores and hyphens.
              A rater’s program ID is its rater ID.
          required: true
          description: >-
            Your organization’s ID for the program, chosen at its first upload:
            lowercase letters, digits, dots, underscores and hyphens. A rater’s
            program ID is its rater ID.
          name: id
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProgramRolesRequest'
      responses:
        '200':
          description: The program’s roles, as now held.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProgramRoles'
        '400':
          description: Invalid body, or a role the latest release does not declare.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: Workspace admin access is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: No such program, or it has no release.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: >-
            wrong_component: the program’s entry is a rater, which declares no
            roles.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    ProgramRolesRequest:
      type: object
      properties:
        roles:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                pattern: ^[a-z_][a-z0-9_]{0,63}$/u
                description: >-
                  A role the guideline declares in its Roles, such as uw or
                  manager.
              holders:
                type: array
                items:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - user
                        - group
                    id:
                      type: string
                      minLength: 1
                      maxLength: 200
                  required:
                    - type
                    - id
                  additionalProperties: false
                maxItems: 1000
            required:
              - name
              - holders
            additionalProperties: false
          maxItems: 1000
      required:
        - roles
      additionalProperties: false
      description: >-
        Each role of the program and its holders on this program. A role the
        program declares and the body leaves out has none bound on this program
        after.
    ProgramRoles:
      type: object
      properties:
        release:
          type: integer
          description: 'The release whose contract declares the roles: the latest.'
        roles:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: A role the release’s contract declares, such as uw.
              actsFor:
                type: array
                items:
                  type: string
                description: The roles it may act for.
              holders:
                type: array
                items:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - user
                        - group
                    id:
                      type: string
                      minLength: 1
                      maxLength: 200
                  required:
                    - type
                    - id
                  additionalProperties: false
                description: >-
                  The users and groups bound to it on this program, as PUT sets
                  them.
              everyProgramHolders:
                type: array
                items:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - user
                        - group
                    id:
                      type: string
                      minLength: 1
                      maxLength: 200
                  required:
                    - type
                    - id
                  additionalProperties: false
                description: >-
                  The users and groups bound to it on every program, by the
                  workspace’s role bindings. They hold it here too; PUT here
                  does not change them.
            required:
              - name
              - actsFor
              - holders
              - everyProgramHolders
          description: Each role the release declares, in the contract’s order.
      required:
        - release
        - roles
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
            dataset:
              type: string
              enum:
                - naic
                - osha
              description: Dataset needed for dataset_not_enabled.
            businessCode:
              type: string
              description: The rater’s own refusal code, for business_rejection.
            violations:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    description: Authored or built-in constraint code
                  message:
                    type: string
                    description: Authored message for the failed constraint
                  path:
                    type: string
                    description: Input path of the offending value; empty for the request
                  value:
                    nullable: true
                    description: Offending input value, size-bounded by the runtime
                  constraint:
                    type: string
                    description: The constraint the value failed, as text
                  cite:
                    type: string
                    nullable: true
                    description: >-
                      Filing citation of the constraint, when the source cites
                      one
                required:
                  - code
                  - message
                  - path
                  - value
                  - constraint
                  - cite
                additionalProperties: false
              maxItems: 256
              description: >-
                Each input constraint the submission failed, for invalid_inputs
                and business_rejection.
            violationsTruncated:
              type: boolean
              description: >-
                True when the rater reported more violations than violations
                holds.
            executionId:
              type: string
              description: >-
                The recorded execution of a failed rating, for rater rating
                failures.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: Not currently returned.
          required:
            - code
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.