Settings

View and manage configuration settings for your organization.

Get security settings

SecuritybearerAuth
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

get/api/v1/security/settings
Response samples
application/json
{
  • "autoRedirectSSO": {
    },
  • "browserSessionTimeout": {
    },
  • "logoutRedirectUri": {}
}

Update security setting by key

SecuritybearerAuth
Request
path Parameters
key
required
string (settingsKeyEnum)

The settings key

Enum: "autoRedirectSSO" "browserSessionTimeout" "logoutRedirectUri"
Request Body schema: application/json
required
Any of:
enabled
boolean or null
idpAlias
string or null <= 255 characters ^[a-z0-9_-]*$
Responses
200

Setting successfully updated

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

put/api/v1/security/settings/{key}
Request samples
application/json
{
  • "enabled": false,
  • "idpAlias": "oidc"
}
Response samples
application/json
{
  • "code": 400,
  • "message": "Required parameter is missing"
}

Get security setting by key

SecuritybearerAuth
Request
path Parameters
key
required
string (settingsKeyEnum)

The settings key

Enum: "autoRedirectSSO" "browserSessionTimeout" "logoutRedirectUri"
Responses
200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/security/settings/{key}
Response samples
application/json
{
  • "enabled": false,
  • "idpAlias": "oidc"
}

Get workloads settings

SecuritybearerAuth
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

get/api/v2/workloads/settings
Response samples
application/json
{
  • "yamlSubmission": {
    }
}

Update workloads setting by key

SecuritybearerAuth
Request
path Parameters
key
required
string (WorkloadsSettingsKeyEnum)

The settings key

Value: "yamlSubmission"
Request Body schema: application/json
required
enabled
boolean or null
Responses
200

Setting successfully updated

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

put/api/v2/workloads/settings/{key}
Request samples
application/json
{
  • "enabled": false
}
Response samples
application/json
{
  • "code": 400,
  • "message": "Required parameter is missing"
}

Get workloads setting by key

SecuritybearerAuth
Request
path Parameters
key
required
string (WorkloadsSettingsKeyEnum)

The settings key

Value: "yamlSubmission"
Responses
200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v2/workloads/settings/{key}
Response samples
application/json
{
  • "enabled": false
}