Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141531,219979.8 KB

Updates an existing API key credential provider.

post/identities/UpdateApiKeyCredentialProvider

Request body

namestring required

The name of the API key credential provider to update.

apiKeystring password

The new API key to use for authentication. This value replaces the existing API key and is encrypted and stored securely.

apiKeySecretSource'MANAGED' | 'EXTERNAL'

The source type of the API key secret. Use <code>MANAGED</code> if the secret is managed by the service, or <code>EXTERNAL</code> if you manage the secret yourself in Amazon Web Services Secrets Manager.

Response

Success

apiKeySecretJsonKeystring

The JSON key used to extract the API key value from the Amazon Web Services Secrets Manager secret.

apiKeySecretSource'MANAGED' | 'EXTERNAL'

The source type of the API key secret. Either <code>MANAGED</code> if the secret is managed by the service, or <code>EXTERNAL</code> if managed by the user in Amazon Web Services Secrets Manager.

namestring required

The name of the API key credential provider.

credentialProviderArnstring required

The Amazon Resource Name (ARN) of the API key credential provider.

createdTimestring date-time required

The timestamp when the API key credential provider was created.

lastUpdatedTimestring date-time required

The timestamp when the API key credential provider was last updated.