Harness

Harness User Group API

This contains APIs related to User Group as defined in Harness

GitHub OpenAPI

Operations 20

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 /ng/api/user-groups/{identifier}/member/{userIdentifier} Check if a user belongs to a user group · Check user membership #
Ask an LLM
“Is a specific user a member of this user group?”
“Can I verify a person's membership in a Harness user group?”
Tell an agent
Check whether user {userIdentifier} is in user group {identifier}.
Tell me if {userIdentifier} belongs to group {identifier}.
PUT /ng/api/user-groups/{identifier}/member/{userIdentifier} Add a user to a user group · Add user to User Group #
Ask an LLM
“How do I add one person to a user group?”
“Can I add a user to a group scoped to a project?”
Tell an agent
Add user {userIdentifier} to user group {identifier}.
Put {userIdentifier} into group {identifier} in project {projectIdentifier}.
DELETE /ng/api/user-groups/{identifier}/member/{userIdentifier} Remove a user from a user group · Remove user from User Group #
Ask an LLM
“How do I take someone out of a user group?”
“Can I remove a single member from a group without deleting it?”
Tell an agent destructive · confirm first
Remove user {userIdentifier} from user group {identifier}.
Drop {userIdentifier} from group {identifier}.
PUT /ng/api/user-groups/copy Copy a user group · Copy User Group #
Ask an LLM
“Can I copy an existing user group?”
“What's the way to duplicate a user group's setup?”
Tell an agent
Copy user group {groupIdentifier}.
Make a copy of group {groupIdentifier}.
GET /ng/api/user-groups List user groups in a scope · List the User Groups in an account/org/project #
Ask an LLM
“What user groups exist in my account, org or project?”
“Can I find user groups linked to a particular SSO group?”
Tell an agent
List the user groups in project {projectIdentifier}.
Search user groups by name for {searchTerm}.
PUT /ng/api/user-groups Update a user group by user IDs · Update User Group #
Ask an LLM
“How do I rename a user group or change its member user IDs?”
“Can I update a user group's notification settings?”
Tell an agent
Update user group {identifier} to be named {name} with user IDs {users}.
Change the description of user group {identifier} named {name} to {description}.
POST /ng/api/user-groups Create a user group from user IDs · Create User Group #
Ask an LLM
“How do I create a new user group with members given by user ID?”
“Can a new user group be marked as externally managed?”
Tell an agent
Create user group {identifier} named {name} with user IDs {users}.
Create an empty user group {identifier} called {name} in project {projectIdentifier}.
GET /ng/api/user-groups/{identifier} Get a user group · Get User Group #
Ask an LLM
“What members and settings does a particular user group have?”
“How can I retrieve one user group by its identifier?”
Tell an agent
Show user group {identifier}.
Get user group {identifier} in org {orgIdentifier}.
DELETE /ng/api/user-groups/{identifier} Delete a user group · Delete a User Group in an account/org/project #
Ask an LLM
“How do I delete a user group entirely?”
“Can I remove a user group from a project scope?”
Tell an agent destructive · confirm first
Delete user group {identifier}.
Remove group {identifier} from project {projectIdentifier}.
GET /ng/api/user-groups/{identifier}/scopes List child scopes inheriting a user group · Get Inheriting Child Scopes #
Ask an LLM
“Which orgs or projects inherit this user group?”
“Where is an account-level user group being used downstream?”
Tell an agent
List the child scopes that inherit user group {identifier}.
Show which scopes inherit group {identifier}.
POST /ng/api/user-groups/{identifier}/users List the users in a user group · List users in User Group #
Ask an LLM
“Who are the members of a given user group?”
“Can I filter a group's members by email?”
Tell an agent
List the users in user group {identifier}.
Find members of group {identifier} with emails {emails}.
PUT /ng/api/user-groups/{userGroupId}/link/ldap/{ldapId} Link an LDAP group to a user group · Link LDAP Group to the User Group to an account/org/project #
Ask an LLM
“How do I sync a user group with an LDAP group?”
“Can a user group be tied to an LDAP group's DN?”
Tell an agent
Link user group {userGroupId} to LDAP group {ldapGroupName} ({ldapGroupDN}) on LDAP {ldapId}.
Sync group {userGroupId} from LDAP {ldapId} using DN {ldapGroupDN} and name {ldapGroupName}.
PUT /ng/api/user-groups/{userGroupId}/link/oidc/{providerId} Link an OIDC group to a user group · Link OIDC Group to the User Group in an account/org/project #
Ask an LLM
“Can I map a user group to a group from my OIDC provider?”
“How do I link an OIDC group name to a Harness user group?”
Tell an agent
Link user group {userGroupId} to OIDC group {oidcGroupName} from provider {providerId}.
Tie group {userGroupId} to OIDC provider {providerId} group {oidcGroupName}.
PUT /ng/api/user-groups/{userGroupId}/link/saml/{samlId} Link a SAML group to a user group · Link SAML Group to the User Group in an account/org/project #
Ask an LLM
“How do I connect a user group to a SAML group?”
“Can user group membership come from a SAML assertion group?”
Tell an agent
Link user group {userGroupId} to SAML group {samlGroupName} on SAML config {samlId}.
Map group {userGroupId} to SAML {samlId} group {samlGroupName}.
POST /ng/api/user-groups/batch Batch fetch up to 10K user groups by filter · List User Groups by filter #
Ask an LLM
“Can I pull every user group that contains a given user without paging?”
“What's the maximum number of user groups the batch filter returns?”
Tell an agent
Batch fetch all user groups containing users {userIdentifierFilter}.
Get the user groups with identifiers {identifierFilter} in one unpaged batch.
POST /ng/api/user-groups/filter Filter user groups with pagination · Get filtered User Groups #
Ask an LLM
“Which user groups include a particular user, page by page?”
“Can I filter user groups by identifier and page through the results?”
Tell an agent
Filter user groups containing users {userIdentifierFilter}, page {pageIndex}.
Return a paged list of user groups matching {searchTerm}.
PUT /ng/api/user-groups/{userGroupId}/unlink Unlink a user group from its SSO group · Unlink SSO Group from the User Group in an account/org/project #
Ask an LLM
“How do I disconnect a user group from SSO syncing?”
“When I unlink SSO, can I keep the members that were already synced?”
Tell an agent
Unlink user group {userGroupId} from SSO.
Unlink group {userGroupId} from SSO and set retain members to {retainMembers}.
PUT /ng/api/v2/user-groups Update a user group by member emails (v2) · Update User Group #
Ask an LLM
“Can I update a user group's members using their email addresses?”
“Is there a v2 user group update that takes emails instead of user IDs?”
Tell an agent
Update user group {identifier} named {name} so its members are emails {users} via the v2 endpoint.
Use v2 to rename user group {identifier} to {name}.
POST /ng/api/v2/user-groups Create a user group from member emails (v2) · Create User Group #
Ask an LLM
“Can I create a user group by listing members' email addresses?”
“What's the v2 way to create a user group with emails?”
Tell an agent
Create user group {identifier} named {name} with member emails {users} using v2.
Use the v2 create endpoint for group {identifier} called {name}.
GET /ng/api/v2/user-groups/{identifier} Get a user group via the v2 endpoint · Get User Group #
Ask an LLM
“Is there a v2 endpoint to fetch a user group with member emails?”
“Can I read a user group through the v2 user groups API?”
Tell an agent
Get user group {identifier} from the v2 endpoint.
Fetch group {identifier} with the v2 user groups API.

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-user-group-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-user-group-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-user-group-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Harness User Group 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:


# --- truncated at 32 KB (112 KB total) ---
# Full source: https://artifacts.apis.io/harness/openapi/harness-user-group-api-openapi.yml