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 Authentication Settings API

This contains APIs related to Authentication settings as defined in Harness

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

Tagged areas include Authentication Settings. 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 23 operations across 19 paths, and defines 28 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}.

23 operations 19 paths 28 schemas 4 DELETE6 GET3 POST10 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 Authentication Settings 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 23

Across 19 paths, the API surfaces 23 operations — 4 DELETE, 6 GET, 3 POST, 10 PUT. Each is listed below with its method, path, parameters, and response codes.

Authentication Settings 23

This contains APIs related to Authentication settings as defined in Harness

GET
/ng/api/authentication-settings/ldap/settings
Return configured Ldap settings for the account
getLdapSettings 1 param → 400500default
PUT
/ng/api/authentication-settings/ldap/settings
Updates Ldap setting
updateLdapSettings 1 param body → 400500default
POST
/ng/api/authentication-settings/ldap/settings
Create Ldap setting
createLdapSettings 1 param body → 400500default
DELETE
/ng/api/authentication-settings/ldap/settings
Delete Ldap settings
deleteLdapSettings 1 param → 400500default
DELETE
/ng/api/authentication-settings/delete-saml-metadata
Delete SAML meta data
deleteSamlMetaData 1 param → 400500default
DELETE
/ng/api/authentication-settings/saml-metadata/{samlSSOId}/delete
Delete SAML meta data for given SAML sso id
deleteSamlMetaDataForSamlSSOId 2 params → 400500default
PUT
/ng/api/authentication-settings/saml-metadata-upload/{samlSSOId}/authentication
Update authentication enabled or not for given SAML setting
enableDisableAuthenticationForSAMLSetting 3 params → 400500default
GET
/ng/api/authentication-settings
Gets authentication settings for the given Account ID
getAuthenticationSettings 1 param → 400500default
GET
/ng/api/authentication-settings/v2
Gets authentication settings version 2 for the given Account ID
getAuthenticationSettingsV2 1 param → 400500default
GET
/ng/api/authentication-settings/login-settings/password-strength
Get password strength
getPasswordStrengthSettings 1 param → 400500default
GET
/ng/api/authentication-settings/saml-login-test
Test SAML connectivity
getSamlLoginTest 1 param → 400500default
GET
/ng/api/authentication-settings/saml-login-test/{samlSSOId}
Test SAML connectivity
getSamlLoginTestV2 2 params → 400500default
DELETE
/ng/api/authentication-settings/oauth/remove-mechanism
Delete OAuth Setting
removeOauthMechanism 1 param → 400500default
PUT
/ng/api/authentication-settings/public-access
Enable/disable public access at account level
setPublicAccess 1 param body → 400500default
PUT
/ng/api/authentication-settings/session-timeout-account-level
Set session timeout at account level
setSessionTimeoutAtAccountLevel 1 param body → 400500default
PUT
/ng/api/authentication-settings/two-factor-admin-override-settings
Set two factor authorization
setTwoFactorAuthAtAccountLevel 1 param body → 400500default
PUT
/ng/api/authentication-settings/update-auth-mechanism
Update Auth mechanism
updateAuthMechanism 2 params → 400500default
PUT
/ng/api/authentication-settings/oauth/update-providers
Update Oauth providers
updateOauthProviders 1 param body → 400500default
PUT
/ng/api/authentication-settings/saml-metadata-upload
Update SAML metadata
updateSamlMetaData 1 param body → 400500default
POST
/ng/api/authentication-settings/saml-metadata-upload
Upload SAML metadata
uploadSamlMetaData 1 param body → 400500default
PUT
/ng/api/authentication-settings/saml-metadata-upload/{samlSSOId}
Update SAML metadata for a given SAML SSO Id
updateSamlMetaDataForSamlSSOId 2 params body → 400500default
PUT
/ng/api/authentication-settings/whitelisted-domains
Updates the whitelisted domains
updateWhitelistedDomains 1 param body → 400500default
POST
/ng/api/authentication-settings/saml-metadata
Upload SAML metadata
uploadSamlMetaDataDs 1 param body → 400500default

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are SamlSettingsDTO (23 properties), LdapConnectionSettings (18 properties), LDAPSettings (9 properties), AuthenticationSettingsResponse (8 properties). Each schema is shown below with its type and property counts.

LoginTypeResponse
object
5 properties
RestResponseSSOConfig
object
3 properties
SamlSettingsDTO
object
23 properties 5 required
SSOSettingsDTO
object
6 properties 3 required
LDAPSettings
object
This has the details of LDAP Settings supported in NG.
9 properties 3 required
ValidationError
object
2 properties
NGAuthSettings
object
This has the details of Authentication Settings supported in NG.
1 property
TwoFactorAdminOverrideSettings
object
This contains the information about the Two Factor Admin Override in Harness.
1 property
AuthenticationSettingsResponse
object
This contains information on the Authentication Settings defined in Harness.
8 properties
Error1
object
This is Error entity as defined in Harness
7 properties
PasswordStrengthPolicy
object
This has information about the password strength policy in Harness.
6 properties
RestResponseLDAPSettings
object
3 properties
OAuthSettings
object
This contains the information about OAuth settings defined in Harness.
3 properties
LdapUserSettings
object
This is the user settings list in LDAP setting.
7 properties 7 required
RestResponseAuthenticationSettingsResponse
object
3 properties
SSORequest
object
6 properties
Failure
object
This is Failure entity as defied in Harness
5 properties
SSOConfig
object
3 properties
LdapGroupSettings
object
This is the group settings list in LDAP setting.
6 properties 6 required
ErrorMetadata2
object
This implements different error meta data objects
1 property
ResponseMessage
object
7 properties
RestResponseLoginTypeResponse
object
3 properties
RestResponsePasswordStrengthPolicy
object
3 properties
RestResponseBoolean
object
3 properties
FormDataContentDisposition
object
8 properties
LdapConnectionSettings
object
This is the LDAP connection setting.
18 properties 1 required
SessionTimeoutSettings
object
This contains the information about the session timeout for this account in Harness.
2 properties 1 required
RestResponseSamlSettingsDTO
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-authentication-settings-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 Authentication Settings 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.