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

Harness User API

This contains APIs related to User as defined in Harness

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

Tagged areas include User. 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 19 paths, and defines 37 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 19 paths 37 schemas 2 DELETE5 GET6 POST7 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
Terms of Service
Resource Areas
1

Authentication & Security 1

Harness User 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 19 paths, the API surfaces 20 operations — 2 DELETE, 5 GET, 6 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

User 20

This contains APIs related to User as defined in Harness

PUT
/ng/api/user/add-user-to-groups/{userId}
Add user to user groups
addUserToUserGroups 4 params body → 400500default
POST
/ng/api/user/users
Add user(s) to scope
addUsers 3 params body → 400500default
PUT
/ng/api/user/password
Change user password
changeUserPassword 1 param body → 400500default
GET
/ng/api/user/last-admin
Check if user is last admin
checkIfLastAdmin 4 params → 400500default
PUT
/ng/api/user/disable-two-factor-auth
Disable two factor authentication
disableTTwoFactorAuth 1 param → 400500default
POST
/ng/api/user/endImpersonation/{userId}
end impersonation session for user
endImpersonation 2 params → 400500default
GET
/ng/api/user/aggregate/{userId}
Get detailed user information
getAggregatedUser 4 params → 400500default
POST
/ng/api/user/aggregate
Get list of users
getAggregatedUsers 8 params body → 400500default
GET
/ng/api/user/two-factor-auth/{authMechanism}
Gets Two Factor Auth Settings
getTwoFactorAuthSettings 2 params → 400500default
GET
/ng/api/user/currentUser
Get Current User Info
getCurrentUserInfo 1 param → 400500default
POST
/ng/api/user/batch
Get users list
getUsers 7 params body → 400500default
POST
/ng/api/user/impersonate/{userId}
impersonate User
impersonateUser 2 params body → 400500default
PUT
/ng/api/user/{userId}
Update User
updateUserInfo_1 2 params body → 400500default
DELETE
/ng/api/user/{userId}
Remove user from scope
removeUser 4 params → 400500default
GET
/ng/api/user/reset-two-factor-auth/{userId}
Reset two factor authorization
reset2fa 2 params → 400500default
PUT
/ng/api/user/unlock-user/{userId}
Unlock user
unlockUser 4 params → 400500default
PUT
/ng/api/user/enable-two-factor-auth
Enable two factor authentication
enableTwoFactorAuth 1 param body → 400500default
PUT
/ng/api/user
Update User
updateUserInfo 1 param body → 400500default
POST
/code/api/v1/user/favorite
Create favorite
createFavorite 3 params body → 201401403500
DELETE
/code/api/v1/user/favorite/{resource_id}
Delete favorite
deleteFavorite 5 params → 204401403404500

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are UserInfo (25 properties), PageResponseUserMetadata (8 properties), RoleAssignmentMetadata (8 properties), PageResponseUserAggregate (8 properties). Each schema is shown below with its type and property counts.

ResponseDTOPageResponseUserAggregate
object
4 properties
ResponseDTOAddUsersResponse
object
4 properties
TwoFactorAuthSettingsInfo
object
6 properties
SortOrder
object
2 properties
UserSettingFromInvite
object
2 properties
PageResponseUserAggregate
object
8 properties
ValidationError
object
2 properties
RoleBinding
object
6 properties
PageResponseUserMetadata
object
8 properties
Error1
object
This is Error entity as defined in Harness
7 properties
AddUsersResponse
object
1 property
RoleAssignmentMetadata
object
This has information of Role like name, id, resource group name, etc.
8 properties
UserAddToUserGroupDTO
object
1 property 1 required
ResponseDTOTwoFactorAuthSettingsInfo
object
4 properties
AddUsersDTO
object
4 properties 1 required
ImpersonateDTO
object
1 property 1 required
UserFilter
object
4 properties
GatewayAccountRequest
object
Returns Gateway account request details like uuid, account name, company name, default experience, whether or not created from NextGen and whether NextGen is e…
7 properties
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
UserAggregate
object
Returns User's metadata and Role Assignments metadata
2 properties
UserInfoUpdateDTO
object
4 properties
ResponseDTOUserAggregate
object
4 properties
UserInfo
object
25 properties
ACLAggregateFilter
object
2 properties
ErrorMetadata2
object
This implements different error meta data objects
1 property
PasswordChange
object
This is the view of the PasswordChange entity defined in Harness
2 properties
ResponseMessage
object
7 properties
RestResponseBoolean
object
3 properties
ResponseDTOPasswordChangeResponse
object
4 properties
ResponseDTOUserInfo
object
4 properties
UtmInfo
object
5 properties
TypesFavoriteResource
object
2 properties
UsererrorError
object
2 properties
EnumResourceType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-user-api-openapi.yml Raw ↑

Other APIs Harness publishes across the network.

Harness Continuous Integration API
Harness Continuous Delivery and GitOps API
Harness Feature Management and Experimentation API
Harness Cloud Cost Management API
Harness Chaos Engineering API
Harness Security Testing Orchestration API
Harness Internal Developer Portal API
Harness Code Repository API
Harness Service Reliability Management API
Harness Infrastructure as Code Management API
Harness Supply Chain Security API
Harness Software Engineering Insights API
Where this information came from

This is an independent, third-party profile of Harness User 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.