Harness

Harness Org Role Assignments API

This contains APIs for Organization-scoped Role Assignments.

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/orgs/{org}/role-assignments List role assignments in an organization · List role assignments #
Ask an LLM
“Who has which roles in my organization?”
“Can I page through org-level role assignments?”
Tell an agent
List role assignments in org {org}.
Show org {org} role assignments, page {page}.
POST /v1/orgs/{org}/role-assignments Assign a role in an organization · Create a role assignment #
Ask an LLM
“How do I grant a user a role in an organization?”
“What resource group does an org role assignment need?”
Tell an agent
Assign role {role} on resource group {resource_group} to principal {principal} in org {org} as assignment {identifier}.
Grant {principal} role {role} over {resource_group} in org {org}, assignment {identifier}, disabled: {disabled}.
GET /v1/orgs/{org}/role-assignments/{role-assignment} Get an organization role assignment · Retrieve a role assignment #
Ask an LLM
“What role and principal does a specific assignment grant?”
“Can I look up one org role assignment by its identifier?”
Tell an agent
Show role assignment {role_assignment} in org {org}.
Get org {org} role assignment {role_assignment}.
DELETE /v1/orgs/{org}/role-assignments/{role-assignment} Delete an organization role assignment · Delete a role assignment #
Ask an LLM
“How do I revoke a role from someone in an organization?”
“Is removing an org role assignment immediate?”
Tell an agent destructive · confirm first
Delete role assignment {role_assignment} in org {org}.
Revoke org {org} role assignment {role_assignment}.

Documentation

📖
Documentation
https://apidocs.harness.io
📖
APIReference
https://apidocs.harness.io
📖
GettingStarted
https://developer.harness.io/docs/platform/automation/api/api-quickstart/
📖
Authentication
https://artifacts.apis.io/harness/authentication/harness-authentication.yml
📖
RateLimits
https://artifacts.apis.io/harness/rate-limits/harness-rate-limits.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/harness/openapi/harness-org-role-assignments-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://artifacts.apis.io/harness/scopes/harness-scopes.yml
🔗
ErrorCatalog
https://artifacts.apis.io/harness/errors/harness-error-codes.yml
🔗
Conventions
https://artifacts.apis.io/harness/conventions/harness-conventions.yml
🔗
Idempotency
https://artifacts.apis.io/harness/conventions/harness-conventions.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/harness:harness-org-role-assignments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

harness-org-role-assignments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Harness Org Role Assignments API
  version: '1.0'
  description: The Harness Software Delivery Platform uses OpenAPI Specification v3.0.
  contact:
    name: API Support
    email: contact@harness.io
    url: https://harness.io/
  x-logo:
    url: https://mma.prnewswire.com/media/779232/Harnes_logo_horizontal.jpg?p=facebook
    altText: Harness
  termsOfService: https://harness.io/terms-of-use/
servers:
- url: https://app.harness.io
  description: Harness host URL
- url: https://{vanity}
  description: Vanity URL
  variables:
    vanity:
      default: app.harness.io
security:
- x-api-key: []
tags:
- name: Org Role Assignments
  description: This contains APIs for Organization-scoped Role Assignments.
  x-displayName: Organization Role Assignments [Beta]
paths:
  /v1/orgs/{org}/role-assignments:
    parameters:
    - $ref: '#/components/parameters/OrgParam'
    get:
      summary: List role assignments
      tags:
      - Org Role Assignments
      responses:
        '200':
          $ref: '#/components/responses/RoleAssignmentListResponse'
      operationId: get-org-scoped-role-assignments
      description: Retrieves the information of the role assignments
      parameters:
      - $ref: '#/components/parameters/AccountHeader'
      - $ref: '#/components/parameters/PageIndex'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Order'
      security:
      - x-api-key: []
    post:
      summary: Create a role assignment
      operationId: create-org-scoped-role-assignments
      responses:
        '201':
          $ref: '#/components/responses/RoleAssignmentResponse'
      parameters:
      - $ref: '#/components/parameters/AccountHeader'
      tags:
      - Org Role Assignments
      requestBody:
        $ref: '#/components/requestBodies/RoleAssignmentRequest'
      security:
      - x-api-key: []
  /v1/orgs/{org}/role-assignments/{role-assignment}:
    parameters:
    - schema:
        type: string
      name: role-assignment
      in: path
      required: true
      description: Role assignment identifier
    - $ref: '#/components/parameters/OrgParam'
    get:
      summary: Retrieve a role assignment
      tags:
      - Org Role Assignments
      responses:
        '200':
          $ref: '#/components/responses/RoleAssignmentResponse'
      operationId: get-org-scoped-role-assignment
      description: Retrieves the information of the role assignment with the matching role assignment identifier.
      parameters:
      - $ref: '#/components/parameters/AccountHeader'
      security:
      - x-api-key: []
    delete:
      summary: Delete a role assignment
      operationId: delete-org-scoped-role-assignment
      responses:
        '200':
          $ref: '#/components/responses/RoleAssignmentResponse'
      description: Deletes the information of the role assignment with the matching role assignment identifier.
      parameters:
      - $ref: '#/components/parameters/AccountHeader'
      tags:
      - Org Role Assignments
      security:
      - x-api-key: []
components:
  responses:
    RoleAssignmentResponse:
      description: Role assignment response body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RoleAssignmentResponse'
          examples:
            role-assignment-response-json:
              value:
                role-assignment:
                  identifier: example_role_assignment
                  resource_group: example_resource_group_identifier
                  role: example_role_identifier
                  principal:
                    scope: ACCOUNT
                    identifier: example_principal_identifier
                    type: USER
                  disabled: false
                  managed: false
                created: 1234567890
                updated: 1234567890
                harness_managaed: false
        application/yaml:
          schema:
            $ref: '#/components/schemas/RoleAssignmentResponse'
          examples:
            role-assignment-response-yaml:
              value: "role-assignment:\n  identifier: example_role_assignment\n  resource_group: example_resource_group_identifier\n  role: example_role_identifier\n  principal:\n    scope: ACCOUNT\n    identifier: example_principal_identifier\n    type: USER\n  disabled: false\n  managed: false\ncreated: 1234567890\nupdated: 1234567890\nharness_managaed: false\n"
    RoleAssignmentListResponse:
      description: Role Assignment List Response body
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/RoleAssignmentResponse'
          examples:
            role-assignment-response-json:
              value:
              - role-assignment:
                  identifier: example_role_assignment
                  resource_group: example_resource_group_identifier
                  role: example_role_identifier
                  principal:
                    scope: ACCOUNT
                    identifier: example_principal_identifier
                    type: USER
                  disabled: false
                  managed: false
                created: 1234567890
                updated: 1234567890
                harness_managaed: false
        application/yaml:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/RoleAssignmentResponse'
          examples:
            role-assignment-response-json:
              value: "- role-assignment:\n    identifier: example_role_assignment\n    resource_group: example_resource_group_identifier\n    role: example_role_identifier\n    principal:\n      scope: ACCOUNT\n      identifier: example_principal_identifier\n      type: USER\n    disabled: false\n    managed: false\n  created: 1234567890\n  updated: 1234567890\n  harness_managaed: false\n"
      headers:
        X-Total-Elements:
          schema:
            type: integer
          description: Total number of elements returned in Paginated response.
        X-Page-Number:
          schema:
            type: integer
          description: Page number in Paginated response.
        X-Page-Size:
          schema:
            type: integer
          description: Maximum page size in Paginated response.
  parameters:
    Sort:
      name: sort
      in: query
      required: false
      schema:
        type: string
        enum:
        - identifier
        - name
        - created
        - updated
      description: Parameter on the basis of which sorting is done.
    Limit:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        default: 30
        maximum: 100
      description: 'Pagination: Number of items to return.'
    OrgParam:
      description: Organization identifier
      in: path
      name: org
      required: true
      schema:
        type: string
    PageIndex:
      name: page
      in: query
      required: false
      schema:
        type: integer
        default: 0
      description: 'Pagination page number strategy: Specify the page number within the paginated collection related to the number of items on each page.'
    Order:
      name: order
      in: query
      required: false
      schema:
        type: string
        enum:
        - ASC
        - DESC
      description: Order on the basis of which sorting is done.
    AccountHeader:
      name: Harness-Account
      in: header
      required: false
      schema:
        type: string
      description: Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.
  schemas:
    RoleAssignment:
      title: RoleAssignment
      type: object
      description: Role assignment request model
      properties:
        identifier:
          type: string
          description: Role assignment identifier
        resource_group:
          type: string
          description: Resource group name
        role:
          type: string
          description: Role identifier
        roleReference:
          $ref: '#/components/schemas/RoleReference'
        principal:
          $ref: '#/components/schemas/Principal'
        disabled:
          type: boolean
          description: Role assignment is disabled or not
        managed:
          type: boolean
          description: Role assignment is managed or not
      required:
      - identifier
      - resource_group
      - role
      - principal
    Principal:
      title: Principal
      type: object
      description: Role assignment principal
      properties:
        scope_level:
          type: string
          description: Principal scope level
        identifier:
          type: string
          description: Principal identifier
        type:
          type: string
          enum:
          - USER
          - USER_GROUP
          - SERVICE_ACCOUNT
          description: Principal type
      required:
      - identifier
      - type
    RoleReference:
      title: RoleReference
      type: object
      description: Role referenced in role assignment
      properties:
        scope_level:
          type: string
          description: Role scope level
        identifier:
          type: string
          description: Role identifier
      required:
      - scope_level
      - identifier
    RoleAssignmentResponse:
      title: RoleAssignmentResponse
      type: object
      description: Role assignment response model
      properties:
        role-assignment:
          $ref: '#/components/schemas/RoleAssignment'
        created:
          type: integer
          description: Creation timestamp for Role.
          format: int64
        updated:
          type: integer
          description: Last modification timestamp for Role.
          format: int64
        harness_managed:
          type: boolean
          description: Is harness managed
  requestBodies:
    RoleAssignmentRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RoleAssignment'
          examples:
            role-assignment-request-json:
              value:
                identifier: example_role_assignment
                resource_group: example_resource_group_identifier
                role: example_role_identifier
                principal:
                  scope: ACCOUNT
                  identifier: example_principal_identifier
                  type: USER
                disabled: false
                managed: false
        application/yaml:
          schema:
            $ref: '#/components/schemas/RoleAssignment'
          examples:
            role-assignment-request-yaml:
              value: "identifier: example_role_assignment\nresource_group: example_resource_group_identifier\nrole: example_role_identifier\nprincipal:\n  scope: ACCOUNT\n  identifier: example_principal_identifier\n  type: USER\ndisabled: false\nmanaged: false\n"
      description: Role Request body
      required: true
  securitySchemes:
    x-api-key:
      name: x-api-key
      type: apiKey
      in: header
      description: API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.
externalDocs:
  description: Find out more about Swagger
  url: http://swagger.io
x-stoplight:
  id: oc91t4vrfnjyi
x-tagGroups:
- name: Organizations
  tags:
  - Organization
- name: Projects
  tags:
  - Org Project
  - Project
- name: Secrets
  tags:
  - Account Secret
  - Org Secret
  - Project Secret
  - Secrets
- name: Connectors
  tags:
  - Account Connector
  - Org Connector
  - Project Connector
  - Connectors
  - GoogleSecretManagerConnector
- name: Roles
  tags:
  - Account Roles
  - Organization Roles
  - Project Roles
  - Roles
- name: Resource Groups
  tags:
  - Account Resource Groups
  - Organization Resource Groups
  - Project Resource Groups
  - Filter Resource Groups
  - Harness Resource Group
  - Zendesk
- name: Role Assignments
  tags:
  - Account Role Assignments
  - Org Role Assignments
  - Project Role Assignments
  - Role Assignments
- name: Platform
  tags:
  - Access Control List
  - Account Banner
  - Account Banner
  - Account Licensed Modules
  - Account License Type
  - Account Webhooks
  - AccountSetting
  - Accounts
  - Analyze Account Access Policy
  - Analyze Organization Access Policy
  - Analyze Project Access Policy
  - ApiKey
  - Audit
  - AuditFilters
  - Authentication Settings
  - Canny
  - Devops Essentials License Data By Account
  - EULA
  - Filter
  - Harness Resource Type
  - Invite
  - IP Allowlist
  - Nextgen Ldap
  - Notification Channels
  - Notification Rules
  - OIDC
  - Oidc-Access-Token
  - Oidc-ID-Token
  - Org Webhooks
  - Permissions
  - Project Webhooks
  - Secret Managers
  - Service Account
  - Setting
  - SMTP
  - Source Code Manager
  - Token
  - User
  - User Group
  - Variables
- name: Delegate
  tags:
  - Agent mTLS Endpoint Management
  - Delegate Download Resource
  - Delegate Group Tags Resource
  - Delegate Setup Resource
  - Delegate Token Resource
- name: Pipelines
  tags:
  - Pipelines
  - Input Sets
  - Approvals
  - Pipeline Execution
  - Pipeline Dashboard
  - Pipeline Input Set
  - Pipeline
  - Pipeline Execution Details
  - Pipeline Execute
  - Pipeline Refresh
  - Pipeline data retention
  - Triggers
  - TriggersEvents
  - Webhook Triggers
  - Webhook Event Handler
  - DryRunPipeline
- name: Artifact Registry
  tags:
  - Registries
  - Artifacts
  - Docker Artifacts
  - Helm Artifacts
  - quarantine
  - Webhooks
  - Spaces
  - Replication
  - Registry V3 - Registries
  - Registry V3 - Packages
  - Registry V3 - Versions
  - Registry V3 - Files
  - Registry V3 - Metadata
  - Registry V3 - Firewall
  - Registry V3 - Transfer
- name: Database DevOps
  tags:
  - Database Schema
  - Database Instance
  - Deployed State
  - Execution Config
  - Migration State
- name: CD
  tags:
  - K8s Release Service Mapping
  - CustomDeployment
  - Environments
  - EnvironmentGroup
  - Infrastructures
  - Usage
  - File Store
  - Service Dashboard
  - ServiceOverrides
  - Rollback
  - tas
- name: Deployment Freeze
  tags:
  - Freeze CRUD
  - Freeze Evaluation
  - Freeze Schema
- name: Services
  tags:
  - Account Services
  - Org Services
  - Project Services
  - Services
- name: Rancher Infrastructures
  tags:
  - Account Rancher Infrastructure
  - Org Rancher Infrastructure
  - Project Rancher Infrastructure
- name: Templates
  tags:
  - Account Template
  - Org Template
  - Project Template
  - Templates
  - Global Templates
- name: GitOps
  tags:
  - Agents
  - Application
  - Applications
  - Certificates
  - Clusters
  - Dashboard Aggregates
  - Dashboards
  - GnuPGP Keys
  - GPG Keys
  - Hosts
  - Project mappings
  - Projects
  - Reconciler
  - Repositories
  - Repository Certificates
  - Repository credentials
  - ValidateHost
- name: GitX
  tags:
  - GitX Webhooks
  - Org Gitx Webhooks
  - Project Gitx Webhooks
- name: CACM
  tags:
  - Anomalies Ignorelist Rule
  - Anomalies
  - BI Dashboards
  - Budgets
  - Budget Groups
  - Cost Categories
  - Cloud Accounts
  - K8S Connectors Metadata
  - Notification Settings v2
  - Overview
  - Data Job Status
  - Recommendation cost settings
  - Unit Metric
  - Anomaly Comments
  - Cloud and AI cost anomaly details
  - Cloud and AI cost anomalies v2
  - Cost Details
  - Currency Preferences
  - External Data Provider
  - AiEngine
  - CACM governance cost settings
  - Governance Enforcement Recommendation APIs
  - Governance Alert
  - Governance Overview
  - Governance Recommendation APIs
  - RuleEnforcement
  - Rule Executions
  - Rule
  - Rule Sets
  - Perspectives Folders
  - Perspective Reports
  - Perspectives
  - Cost Category Jira Project Mapping
  - Recommendations Details
  - Recommendations
  - Recommendation Jira
  - Recommendation Preferences
  - Recommendation Presets
  - Recommendation Servicenow
  - Recommendation Tags
  - Recommendation Ignore List
  - AutoStopping Rules
  - AutoStopping Rules V2
  - AutoStopping Load Balancers
  - AutoStopping Fixed Schedules
  - AutoStopping Alerts
  - Commitment Orchestrator Events APIs
- name: Feature Flags
  tags:
  - API Keys
  - Feature Flags
  - Targets
  - Target Groups
  - Environment Perspectives
  - Anomalies
  - Proxy
  - Tags
- name: SRM
  tags:
  - Monitored Services
  - SLOs dashboard
  - NG SLOs
  - SLOs
  - Downtime
  - Srm Notification
- name: Internal Developer Portal - IDP
  tags:
  - Entities
  - Teams
  - CatalogCustomProperties
  - Scores
  - DataSource
  - KubernetesDataPoints
  - AggregationRules
  - AppConfig
  - PluginInfo
  - LayoutProxy
  - Kinds
  - LayoutsV3
  - LayoutsV4
- name: Environment Management - IDP
  tags:
  - Environment
  - Infrastructure
  - Instance
- name: Custom Dashboards
  tags:
  - aida
  - dashboards
  - downloads
  - embed
  - folders
- name: Policy Management
  tags:
  - dashboard
  - examples
  - policies
  - evaluate
  - evaluations
  - policysets
  - system
- name: Code
  tags:
  - repository
  - status_checks
  - pullreq
  - upload
  - webhook
  - resource
  - rules
  - labels
- name: IaCM
  tags:
  - usage
  - approvals
  - costs
  - executions
  - module-registry
  - workspaces
  - settings
  - tf-standard-backend
  - variables
- name: STO
  tags:
  - Exemptions
  - Issues
  - Scans
  - Products
  - Test Targets
  - Target Variants
- name: SEI
  tags:
  - Collection categories
  - Collections
  - Contributors
  - DORA
- name: Git Sync (deprecated)
  tags:
  - Git Branches
  - Git Full Sync
  - Git Sync Settings
  - Git Sync
  - Git Sync Errors
- name: Error Models
  tags:
  - Error Response
  - Governance Metadata
- name: Supply Chain Security
  tags:
  - integration
  - PipelineInfraConfig
  - SBOM
  - Integration Step Config
  - Delete Step Config
  - Delete Repositories
  - Pipeline Store Config
  - Evidence Vault [Beta]
- name: Release Management
  tags:
  - Release Groups
  - Releases
  - Orchestration Processes
  - Orchestration Activities
  - Orchestration Executions
  - Conflicts
  - Freeze
  - Reports
  - Uploads
- name: Resilience Testing
  tags:
  - Actions
  - Action Templates
  - Chaos Components
  - Chaos Hubs
  - ChaosGuard Conditions
  - ChaosGuard Rules
  - DR Tests
  - Experiments
  - Experiment Templates
  - Faults
  - Fault Templates
  - Chaos Infrastructure
  - Health
  - Network Maps
  - Onboarding
  - Probes
  - Probe Templates
  - Chaos Recommendations
  - Risks