AuthenticationSettings

This contains APIs related to Authentication settings as defined in Harness

Updates the SAML metadata by accountId

Request
Security:
ApiKey (readwrite)
query Parameters
accountId
required
string

Account Identifier for the Entity

Request Body schema: multipart/form-data
Inputfile
object
object (FormDataContentDisposition)
displayName
string
groupMembershipAttr
string
authorizationEnabled
boolean
logoutUrl
string
entityIdentifier
string
Responses
400

Bad Request

500

Internal server error

default

Returns SSO config of the account

put/ng/api/authentication-settings/saml-metadata-upload
Request samples
curl -i -X PUT \
  'https://app.harness.io/gateway/ng/api/authentication-settings/saml-metadata-upload?accountId=string' \
  -H 'Content-Type: multipart/form-data' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -F 'Inputfile=[object Object]' \
  -F 'fileMetadata=[object Object]' \
  -F displayName=string \
  -F groupMembershipAttr=string \
  -F authorizationEnabled=true \
  -F logoutUrl=string \
  -F entityIdentifier=string
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Uploads the SAML metadata by accountId

Request
Security:
ApiKey (readwrite)
query Parameters
accountId
required
string

Account Identifier for the Entity

Request Body schema: multipart/form-data
Inputfile
object
object (FormDataContentDisposition)
displayName
string
groupMembershipAttr
string
authorizationEnabled
boolean
logoutUrl
string
entityIdentifier
string
Responses
400

Bad Request

500

Internal server error

default

Returns SSO config of the account

post/ng/api/authentication-settings/saml-metadata-upload
Request samples
curl -i -X POST \
  'https://app.harness.io/gateway/ng/api/authentication-settings/saml-metadata-upload?accountId=string' \
  -H 'Content-Type: multipart/form-data' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -F 'Inputfile=[object Object]' \
  -F 'fileMetadata=[object Object]' \
  -F displayName=string \
  -F groupMembershipAttr=string \
  -F authorizationEnabled=true \
  -F logoutUrl=string \
  -F entityIdentifier=string
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Deletes SAML meta data by accountIdentifier

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

Responses
400

Bad Request

500

Internal server error

default

Returns the enabled SSO OAuth Providers for the account

delete/ng/api/authentication-settings/delete-saml-metadata
Request samples
curl -i -X DELETE \
  'https://app.harness.io/gateway/ng/api/authentication-settings/delete-saml-metadata?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get the SAML login test by accountId

Request
Security:
ApiKey (readwrite)
query Parameters
accountId
required
string

Account Identifier for the Entity

Responses
400

Bad Request

500

Internal server error

default

Returns the login type enabled for the account

get/ng/api/authentication-settings/saml-login-test
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/authentication-settings/saml-login-test?accountId=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Set two factor auth at account lever by accountIdentifier

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

Request Body schema: */*

Boolean that specify whether or not to override two factor enabled setting

adminOverrideTwoFactorEnabled
boolean
Responses
400

Bad Request

500

Internal server error

default

Returns the boolean status

put/ng/api/authentication-settings/two-factor-admin-override-settings
Request samples
curl -i -X PUT \
  'https://app.harness.io/gateway/ng/api/authentication-settings/two-factor-admin-override-settings?accountIdentifier=string' \
  -H 'Content-Type: */*' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '[object Object]'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Updates the Oauth providers by accountIdentifier

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

Request Body schema: */*

This is the updated OAuthSettings. Please provide values for all fields, not just the fields you are updating

filter
string
allowedProviders
Array of strings unique
Items Enum: "AZURE" "BITBUCKET" "GITHUB" "GITLAB" "GOOGLE" "LINKEDIN"
settingsType
string
Enum: "USER_PASSWORD" "SAML" "LDAP" "OAUTH"
Responses
400

Bad Request

500

Internal server error

default

Returns success response

put/ng/api/authentication-settings/oauth/update-providers
Request samples
curl -i -X PUT \
  'https://app.harness.io/gateway/ng/api/authentication-settings/oauth/update-providers?accountIdentifier=string' \
  -H 'Content-Type: */*' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '[object Object]'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Deletes OAuth mechanism by accountIdentifier

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

Responses
400

Bad Request

500

Internal server error

default

Returns success response

delete/ng/api/authentication-settings/oauth/remove-mechanism
Request samples
curl -i -X DELETE \
  'https://app.harness.io/gateway/ng/api/authentication-settings/oauth/remove-mechanism?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Updates the Auth mechanism by accountIdentifier

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

authenticationMechanism
string

Type of Authentication Mechanism SSO or NON_SSO

Enum: "USER_PASSWORD" "SAML" "LDAP" "OAUTH"
Responses
400

Bad Request

500

Internal server error

default

Returns success response

put/ng/api/authentication-settings/update-auth-mechanism
Request samples
curl -i -X PUT \
  'https://app.harness.io/gateway/ng/api/authentication-settings/update-auth-mechanism?accountIdentifier=string&authenticationMechanism=USER_PASSWORD' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Updates the Whitelisted domains by accountIdentifier

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

Request Body schema: */*

Set of whitelisted domains and IPs for the account

Array
string
Responses
400

Bad Request

500

Internal server error

default

Returns success response

put/ng/api/authentication-settings/whitelisted-domains
Request samples
curl -i -X PUT \
  'https://app.harness.io/gateway/ng/api/authentication-settings/whitelisted-domains?accountIdentifier=string' \
  -H 'Content-Type: */*' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d string
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get the authentication settings by accountIdentifier

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

Responses
400

Bad Request

500

Internal server error

default

Returns Authentication settings of the Account

get/ng/api/authentication-settings
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/authentication-settings?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get the password strength settings by accountIdentifier

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

Responses
400

Bad Request

500

Internal server error

default

Returns Authentication settings of the Account

get/ng/api/authentication-settings/login-settings/password-strength
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/authentication-settings/login-settings/password-strength?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}