Harness

Harness Authentication Settings API

This contains APIs related to Authentication settings as defined in Harness

GitHub OpenAPI

Operations 23

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/authentication-settings/ldap/settings View the account's LDAP settings · Return configured Ldap settings for the account #
Ask an LLM
“What LDAP connection and sync settings are configured on my Harness account?”
“Can I see the user and group queries our current LDAP setup uses?”
Tell an agent
Show the LDAP settings configured for account {account}.
Pull up our current LDAP configuration and its sync details.
PUT /ng/api/authentication-settings/ldap/settings Change the account's existing LDAP settings · Updates Ldap setting #
Ask an LLM
“Can I change the cron schedule of an LDAP sync that's already set up?”
“How do I edit the group query in my existing LDAP configuration?”
Tell an agent
Update existing LDAP setting {identifier} on account {account} to sync on cron {cron}.
Rename our existing LDAP setting {identifier} to {display_name}.
POST /ng/api/authentication-settings/ldap/settings Set up LDAP authentication for the account · Create Ldap setting #
Ask an LLM
“What do I need to connect my account to an LDAP directory for the first time?”
“Can a brand-new LDAP configuration include both user and group queries?”
Tell an agent
Create a new LDAP setting named {display_name} with identifier {identifier} on account {account}.
Set up LDAP for our account using connection settings {connection}.
DELETE /ng/api/authentication-settings/ldap/settings Remove the account's LDAP settings · Delete Ldap settings #
Ask an LLM
“Can I remove the LDAP configuration from my account entirely?”
“Is there a way to tear down the LDAP integration on an account?”
Tell an agent destructive · confirm first
Delete the LDAP settings on account {account}.
Remove our LDAP configuration completely.
DELETE /ng/api/authentication-settings/delete-saml-metadata Delete the account-level SAML metadata · Delete SAML meta data #
Ask an LLM
“How do I wipe the SAML metadata for my whole account?”
“Can I clear the account-level SAML configuration without naming a specific SSO id?”
Tell an agent destructive · confirm first
Delete the account-level SAML metadata for account {account}.
Clear all SAML metadata on our account.
DELETE /ng/api/authentication-settings/saml-metadata/{samlSSOId}/delete Delete one SAML SSO configuration's metadata · Delete SAML meta data for given SAML sso id #
Ask an LLM
“Can I remove the metadata for just one of several SAML identity providers?”
“Which call deletes a single SAML SSO setting by its id?”
Tell an agent destructive · confirm first
Delete the SAML metadata for SAML SSO id {saml_sso_id}.
Remove SAML SSO configuration {saml_sso_id} from account {account}.
PUT /ng/api/authentication-settings/saml-metadata-upload/{samlSSOId}/authentication Turn login on or off for one SAML setting · Update authentication enabled or not for given SAML setting #
Ask an LLM
“Can I temporarily disable sign-in through one SAML provider without deleting it?”
“How do I switch a specific SAML SSO setting back on for authentication?”
Tell an agent
Set authentication enabled to {enable} for SAML setting {saml_sso_id}.
Disable SAML login for SSO setting {saml_sso_id} on account {account}.
GET /ng/api/authentication-settings Get the account's authentication settings · Gets authentication settings for the given Account ID #
Ask an LLM
“Which login mechanisms and authentication settings does my account use?”
“Can I check which auth mechanism is currently active using the original settings endpoint?”
Tell an agent
Show the authentication settings for account {account}.
Fetch our account's current login configuration from the original endpoint.
GET /ng/api/authentication-settings/v2 Get version 2 of the account's auth settings · Gets authentication settings version 2 for the given Account ID #
Ask an LLM
“Is there a newer v2 response for account authentication settings?”
“Where do I read the version 2 authentication settings for an account?”
Tell an agent
Get the v2 authentication settings for account {account}.
Fetch the version 2 authentication settings view for our account.
GET /ng/api/authentication-settings/login-settings/password-strength Check the account's password strength policy · Get password strength #
Ask an LLM
“What password strength rules are enforced for users on my account?”
“Does our account require a minimum password complexity?”
Tell an agent
Show the password strength policy for account {account}.
Tell me our password complexity requirements.
GET /ng/api/authentication-settings/saml-login-test Test SAML connectivity for the whole account · Test SAML connectivity #
Ask an LLM
“Can I verify the account's SAML sign-in is reachable before rolling it out?”
“Is there a way to run a SAML login test at the account level?”
Tell an agent
Run a SAML connectivity test for account {account_id}.
Test whether our account-wide SAML login works.
GET /ng/api/authentication-settings/saml-login-test/{samlSSOId} Test connectivity for one SAML SSO setting · Test SAML connectivity #
Ask an LLM
“When I have several SAML providers, can I test sign-in for just one of them?”
“Which call tests a specific SAML SSO configuration by its id?”
Tell an agent
Test SAML connectivity for SSO setting {saml_sso_id}.
Run a login test against SAML configuration {saml_sso_id} on account {account}.
DELETE /ng/api/authentication-settings/oauth/remove-mechanism Remove OAuth sign-in from the account · Delete OAuth Setting #
Ask an LLM
“Can I turn off OAuth sign-in for my whole account?”
“How do I delete the OAuth settings configured for our account?”
Tell an agent destructive · confirm first
Remove the OAuth login mechanism from account {account}.
Delete our OAuth sign-in settings.
PUT /ng/api/authentication-settings/public-access Enable or disable account-level public access · Enable/disable public access at account level #
Ask an LLM
“Can I allow public access to resources at the account level?”
“Where do I switch off public access for my account?”
Tell an agent
Toggle public access for account {account}.
Turn off account-level public access.
PUT /ng/api/authentication-settings/session-timeout-account-level Set the user session timeout for the account · Set session timeout at account level #
Ask an LLM
“Can I log users out automatically after a period of inactivity?”
“Is there an absolute session limit I can set in addition to the idle timeout?”
Tell an agent
Set the session timeout for account {account} to {minutes} minutes.
Set idle session timeout to {minutes} minutes and absolute timeout to {absolute_minutes} minutes.
PUT /ng/api/authentication-settings/two-factor-admin-override-settings Enforce two-factor authentication account-wide · Set two factor authorization #
Ask an LLM
“Can an admin require two-factor authentication for every user on the account?”
“How do I override users' 2FA choices at the account level?”
Tell an agent
Set the admin two-factor override on account {account} to {enabled}.
Turn on enforced two-factor authentication for all our users.
PUT /ng/api/authentication-settings/update-auth-mechanism Switch the account's active login mechanism · Update Auth mechanism #
Ask an LLM
“Can I change which authentication mechanism users sign in with?”
“Which setting makes SAML or LDAP the active login method for the account?”
Tell an agent
Change the authentication mechanism for account {account} to {mechanism}.
Make {mechanism} our active login method.
PUT /ng/api/authentication-settings/oauth/update-providers Choose which OAuth providers users can sign in with · Update Oauth providers #
Ask an LLM
“Can I limit which OAuth identity providers are allowed for login?”
“What's the way to update the list of allowed OAuth sign-in providers?”
Tell an agent
Set the allowed OAuth providers for account {account} to {providers}.
Update our OAuth provider allowlist to {providers}.
PUT /ng/api/authentication-settings/saml-metadata-upload Update the account's existing SAML metadata · Update SAML metadata #
Ask an LLM
“How do I replace the metadata file on our existing account-level SAML configuration?”
“Can I change the group membership attribute on the current SAML setup?”
Tell an agent
Replace the SAML metadata on account {account_id} with file {file}.
Update the logout URL of our existing SAML configuration to {logout_url}.
POST /ng/api/authentication-settings/saml-metadata-upload Upload SAML metadata to add a SAML provider · Upload SAML metadata #
Ask an LLM
“What do I need to upload to set up a new SAML identity provider?”
“Can I enable just-in-time user provisioning when adding a SAML provider?”
Tell an agent
Upload SAML metadata file {file} for account {account_id} with display name {display_name}.
Add a new SAML provider named {friendly_name} with JIT provisioning set to {jit}.
PUT /ng/api/authentication-settings/saml-metadata-upload/{samlSSOId} Update one SAML SSO configuration's metadata · Update SAML metadata for a given SAML SSO Id #
Ask an LLM
“How can I update the metadata for one specific SAML SSO id when several exist?”
“Can I rotate the client secret on a particular SAML configuration?”
Tell an agent
Update SAML configuration {saml_sso_id} with metadata file {file}.
Change the display name of SAML setting {saml_sso_id} to {display_name}.
PUT /ng/api/authentication-settings/whitelisted-domains Update the account's allowed login domains · Updates the whitelisted domains #
Ask an LLM
“Can I restrict sign-in to users from specific email domains?”
“Where do I change the whitelisted domains for my account?”
Tell an agent
Update the whitelisted domains for account {account}.
Replace our allowed sign-in domain list.
POST /ng/api/authentication-settings/saml-metadata Upload SAML metadata via the alternate endpoint · Upload SAML metadata #
Ask an LLM
“Is there a second endpoint for uploading SAML metadata besides saml-metadata-upload?”
“Can I post SAML metadata through the /saml-metadata path instead?”
Tell an agent
Upload SAML metadata file {file} for account {account_id} through the alternate saml-metadata endpoint.
Use the /saml-metadata endpoint to add SAML provider type {provider_type}.

Documentation

📖
Documentation
https://apidocs.harness.io
📖
APIReference
https://apidocs.harness.io
📖
GettingStarted
https://developer.harness.io/docs/platform/automation/api/api-quickstart/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/authentication/harness-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/rate-limits/harness-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/openapi/harness-authentication-settings-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/json-schema/harness-ldapsettings-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/json-schema/harness-oauth-settings-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/json-schema/harness-session-timeout-settings-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/json-schema/harness-form-data-content-disposition-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/json-schema/harness-two-factor-admin-override-settings-schema.json

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/scopes/harness-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/errors/harness-error-codes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/conventions/harness-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/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-authentication-settings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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-authentication-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Harness Authentication Settings 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 (113 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/openapi/harness-authentication-settings-api-openapi.yml