Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

modifySamlIdentityProvider

Back to index

Summary

Modifies an existing SAML identity provider.
samlIdentityProviderName
Stringrequired
The name of the SAML Identity Provider.
colorCode
Stringoptionaldeprecated
The argument is no longer used.
Color code to be associated with the IDP.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
enabled
Booleanoptional
If true, enables SAML Identity Provider.
label
Stringoptionaldeprecated
The argument is no longer used.
Label used by the UI to display the text. For example, a label for a UI button.
metadata
Stringoptional
The metadata of the SAML identity provider.
newName
Stringoptional
The new name for an existing object that is being renamed.
ssoProvider
Stringoptional
Used to identify the SSO provider for displaying the branded SSO button on the login page.
Possible values: "GOOGLE", "KEYCLOAK", "OKTA", "OTHER"

Usage

Perl

$cmdr->modifySamlIdentityProvider(
  "test-samlIdentityProviderName" # samlIdentityProviderName
  # optionals
);
▼

ectool

ectool modifySamlIdentityProvider \
  "test-samlIdentityProviderName" `# samlIdentityProviderName` \
  # optionals
▼

Examples

Perl

$cmdr->modifySamlIdentityProvider("Okta", {colorCode => "red", label => "Test identity provider", description => "identity provider for authentication testing"});
▼

ectool

ectool modifySamlIdentityProvider "OneLogin" --colorCode "red" --label "Test identity provider" --description "identity provider for authentication testing"
▼