Sign in

v1

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

Creates a new API key credential provider.

post/identities/CreateApiKeyCredentialProvider

Request body

namestring required

The name of the API key credential provider. The name must be unique within your account.

apiKeystring password

The API key to use for authentication. This value 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.

tagsobject

A map of tag keys and values to assign to the API key credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

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 created API key credential provider.

credentialProviderArnstring required

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