How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Harness

Harness User Group API

This contains APIs related to User Group as defined in Harness

Documentation Provider Profile APIs.io OpenAPI GitHub

Harness User Group API is one of 488 APIs that Harness publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include UserGroup. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 20 operations across 14 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://app.harness.io, https://{vanity}.

20 operations 14 paths 29 schemas 2 DELETE5 GET5 POST8 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.harness.io
Authentication
API Key
Contact
API Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Harness User Group API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (x-api-key). By default, every request must be authenticated.

  • x-api-key — API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Paths & Operations 20

Across 14 paths, the API surfaces 20 operations — 2 DELETE, 5 GET, 5 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

User Group 20

This contains APIs related to User Group as defined in Harness

GET
/ng/api/user-groups/{identifier}/member/{userIdentifier}
Check user membership
getMember 5 params → 400500default
PUT
/ng/api/user-groups/{identifier}/member/{userIdentifier}
Add user to User Group
putMember 5 params → 400500default
DELETE
/ng/api/user-groups/{identifier}/member/{userIdentifier}
Remove user from User Group
deleteMember 5 params → 400500default
PUT
/ng/api/user-groups/copydeprecated
Copy User Group
copyUserGroup 2 params body → 400500default
GET
/ng/api/user-groups
List the User Groups in an account/org/project
getUserGroupList 10 params → 400500default
PUT
/ng/api/user-groups
Update User Group
putUserGroup 3 params body → 400500default
POST
/ng/api/user-groups
Create User Group
postUserGroup 3 params body → 400500default
GET
/ng/api/user-groups/{identifier}
Get User Group
getUserGroup 4 params → 400500default
DELETE
/ng/api/user-groups/{identifier}
Delete a User Group in an account/org/project
deleteUserGroup 4 params → 400500default
GET
/ng/api/user-groups/{identifier}/scopes
Get Inheriting Child Scopes
getInheritingChildScopeList 4 params → 400500default
POST
/ng/api/user-groups/{identifier}/users
List users in User Group
getUserListInUserGroup 8 params body → 400500default
PUT
/ng/api/user-groups/{userGroupId}/link/ldap/{ldapId}
Link LDAP Group to the User Group to an account/org/project
linkUserGroupToLDAP 5 params body → 400500default
PUT
/ng/api/user-groups/{userGroupId}/link/oidc/{providerId}
Link OIDC Group to the User Group in an account/org/project
linkUserGroupToOIDC 5 params body → 400500default
PUT
/ng/api/user-groups/{userGroupId}/link/saml/{samlId}
Link SAML Group to the User Group in an account/org/project
linkUserGroupToSAML 5 params body → 400500default
POST
/ng/api/user-groups/batch
List User Groups by filter
getBatchUsersGroupList 1 param body → 400500default
POST
/ng/api/user-groups/filter
Get filtered User Groups
getFilteredUserGroupsList 5 params body → 400500default
PUT
/ng/api/user-groups/{userGroupId}/unlink
Unlink SSO Group from the User Group in an account/org/project
unlinkUserGroupfromSSO 5 params → 400500default
PUT
/ng/api/v2/user-groups
Update User Group
putUserGroupV2 3 params body → 400500default
POST
/ng/api/v2/user-groups
Create User Group
postUserGroupV2 3 params body → 400500default
GET
/ng/api/v2/user-groups/{identifier}
Get User Group
getUserGroupV2 4 params → 400500default

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are UserGroupRequestV2 (18 properties), UserGroupResponseV2 (18 properties), UserGroup (17 properties), PageResponseUserGroup (8 properties). Each schema is shown below with its type and property counts.

OidcLinkGroupRequest
object
1 property 1 required
UserGroup
object
User Group details defined in Harness.
17 properties 2 required
ResponseDTOUserGroupResponseV2
object
4 properties
SortOrder
object
2 properties
UserBasicInfo
object
List of users emails in the UserGroup.
2 properties
ValidationError
object
2 properties
PageResponseUserGroup
object
8 properties
UserGroupRequestV2
object
User Group details defined in Harness.
18 properties 2 required
PageResponseUserMetadata
object
8 properties
Error1
object
This is Error entity as defined in Harness
7 properties
ResponseDTOUserGroup
object
4 properties
LdapLinkGroupRequest
object
2 properties 2 required
ResponseDTOPageResponseUserGroup
object
4 properties
ResponseDTOListScopeName
object
4 properties
SamlLinkGroupRequest
object
1 property 1 required
ResponseDTOListUserGroup
object
4 properties
UserFilter
object
4 properties
NotificationSettingConfigDTO1
object
List of notification settings.
1 property
ResponseDTOBoolean
object
4 properties
ResponseDTOPageResponseUserMetadata
object
4 properties
UserMetadata
object
This is the view of the UserMetadata entity defined in Harness
7 properties 5 required
Failure
object
This is Failure entity as defied in Harness
5 properties
UserGroupResponseV2
object
User Group details defined in Harness.
18 properties 2 required
ErrorMetadata2
object
This implements different error meta data objects
1 property
ResponseMessage
object
7 properties
UserGroupFilter
object
This is the view of the UserGroupFilter entity defined in Harness
8 properties 1 required
Scope1
object
3 properties
RestResponseUserGroup
object
3 properties
ScopeName
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-user-group-api-openapi.yml Raw ↑

Other APIs Harness publishes across the network.

Harness Continuous Integration API
AE Profile APIs.io
Harness Continuous Delivery and GitOps API
AE Profile APIs.io
Harness Feature Management and Experimentation API
AE Profile APIs.io
Harness Cloud Cost Management API
AE Profile APIs.io
Harness Chaos Engineering API
AE Profile APIs.io
Harness Security Testing Orchestration API
AE Profile APIs.io
Harness Internal Developer Portal API
AE Profile APIs.io
Harness Code Repository API
AE Profile APIs.io
Harness Service Reliability Management API
AE Profile APIs.io
Harness Infrastructure as Code Management API
AE Profile APIs.io
Harness Supply Chain Security API
AE Profile APIs.io
Harness Software Engineering Insights API
AE Profile APIs.io
#UserGroup
← Back to H APIs
API Details
ID
harness:harness-user-group-api
Base URL
https://app.harness.io
Docs
https://apidocs.harness.io
Provider
Harness
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=harness-user-group-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/harness-user-group-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Harness User Group API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.