Skip to main content

UpdateIdentityProvider

Updates an identity provider.

Examples​

Works for all provider types. Fetches the existing provider, preserves type-specific properties, and applies the changes:

octo-cli -c UpdateIdentityProvider `
-id "provider-id" `
-n "Updated Name" `
-e "true" `
-asr "false" `
-dgid "<default-group-rtid>"

For OAuth-based providers, you can also update client credentials (the new secret is piped in on standard input):

octo-cli -c UpdateIdentityProvider `
-id "provider-id" `
-n "Updated Name" `
-e "true" `
-cid "new-client-id" `
-css

Options​

ShortLongRequiredDescription
-id--identifieryesID of identity provider, must be unique
-n--nameyesName of identity provider, must be unique
-e--enabledyesTrue if identity provider should be enabled, otherwise false
-cid--clientIdnoServiceClient ID, provided by provider
-cs--clientSecretnoDeprecated: new client secret, provided by the provider; omit every secret source to keep the stored secret. A value on the command line ends up in the shell history and the process list.
Use --client-secret-stdin or the environment variable OCTO_CLI_IDP_CLIENT_SECRET instead.
-css--client-secret-stdinnoRead the client secret from standard input (one value; a trailing line break is removed)
-asr--allowSelfRegistrationnoAllow self registration (default: true)
-dgid--defaultGroupRtIdnoDefault group RtId for new users

Notes​

The client secret is write-only: GetIdentityProviders shows clientSecretIsSet, never the value.

A new client secret rotates the stored one; it is read from standard input (--client-secret-stdin) or from the environment variable OCTO_CLI_IDP_CLIENT_SECRET. Without either the stored secret is kept (there is no prompt). It cannot be cleared. -cs still works in this release but logs a deprecation warning, because a value on the command line ends up in the shell history and the process list.