authentication-settings

Update Whitelisted domains for an account

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
string
Request Body schema: */*
Array
string
Responses
200

successful operation

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
application/json
{
  • "metaData": {
    },
  • "resource": true,
  • "responseMessages": [
    ]
}

Edit SAML Config

Request
Security:
ApiKey (readwrite)
query Parameters
accountId
string
Request Body schema: multipart/form-data
file
string <binary>
displayName
string
groupMembershipAttr
string
authorizationEnabled
boolean
logoutUrl
string
Responses
200

successful operation

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 file=string \
  -F displayName=string \
  -F groupMembershipAttr=string \
  -F authorizationEnabled=true \
  -F logoutUrl=string
Response samples
application/json
{
  • "metaData": {
    },
  • "resource": {
    },
  • "responseMessages": [
    ]
}

Create SAML Config

Request
Security:
ApiKey (readwrite)
query Parameters
accountId
string
Request Body schema: multipart/form-data
file
string <binary>
displayName
string
groupMembershipAttr
string
authorizationEnabled
boolean
logoutUrl
string
Responses
200

successful operation

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 file=string \
  -F displayName=string \
  -F groupMembershipAttr=string \
  -F authorizationEnabled=true \
  -F logoutUrl=string
Response samples
application/json
{
  • "metaData": {
    },
  • "resource": {
    },
  • "responseMessages": [
    ]
}

Delete SAML Config

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
string
Responses
200

successful operation

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
application/json
{
  • "metaData": {
    },
  • "resource": {
    },
  • "responseMessages": [
    ]
}

Get SAML Login Test

Request
Security:
ApiKey (readwrite)
query Parameters
accountId
string
Responses
200

successful operation

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
application/json
{
  • "metaData": {
    },
  • "resource": {
    },
  • "responseMessages": [
    ]
}

Set account level two factor auth setting

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
string
Request Body schema: */*
adminOverrideTwoFactorEnabled
boolean
Responses
200

successful operation

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
application/json
{
  • "metaData": {
    },
  • "resource": true,
  • "responseMessages": [
    ]
}

Get Password strength settings

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
string
Responses
200

successful operation

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
application/json
{
  • "metaData": {
    },
  • "resource": {
    },
  • "responseMessages": [
    ]
}

Get authentication settings for an account

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
string
Responses
200

successful operation

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
application/json
{
  • "metaData": {
    },
  • "resource": {
    },
  • "responseMessages": [
    ]
}

Update Oauth providers for an account

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
string
Request Body schema: */*
filter
string
allowedProviders
Array of strings unique
Items Enum: "AZURE" "BITBUCKET" "GITHUB" "GITLAB" "GOOGLE" "LINKEDIN"
Responses
200

successful operation

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
application/json
{
  • "metaData": {
    },
  • "resource": true,
  • "responseMessages": [
    ]
}

Update Auth mechanism for an account

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
string
authenticationMechanism
string
Enum: "USER_PASSWORD" "SAML" "LDAP" "OAUTH"
Responses
200

successful operation

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
application/json
{
  • "metaData": {
    },
  • "resource": true,
  • "responseMessages": [
    ]
}

Remove Oauth mechanism for an account

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
string
Responses
200

successful operation

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
application/json
{
  • "metaData": {
    },
  • "resource": true,
  • "responseMessages": [
    ]
}

Update login settings - lockout, expiration, strength

Request
Security:
ApiKey (readwrite)
path Parameters
loginSettingsId
required
string
query Parameters
accountIdentifier
string
Request Body schema: */*
uuid
required
string
accountId
required
string
object (EmbeddedUser)
lastUpdatedAt
integer <int64>
required
object (UserLockoutPolicy)
required
object (PasswordExpirationPolicy)
required
object (PasswordStrengthPolicy)
Responses
200

successful operation

put/ng/api/authentication-settings/login-settings/{loginSettingsId}
Request samples
curl -i -X PUT \
  'https://app.harness.io/gateway/ng/api/authentication-settings/login-settings/:loginSettingsId?accountIdentifier=string' \
  -H 'Content-Type: */*' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '[object Object]'
Response samples
application/json
{
  • "metaData": {
    },
  • "resource": {
    },
  • "responseMessages": [
    ]
}